Welcome to the Monde API! This documentation provides details of available endpoints for integrating your system with us.
https://web.monde.com.br/api/v3. string, integer, float, boolean, etc. .) as the decimal separator, with only two decimal places. Example: 99999.99. required. "") is a text value: on a text field it is saved as sent, and on a required text field it is refused (422). On a field of any other type (object, list, number, boolean, date, option or reference by id), "" is refused (422). PATCH), an omitted field stays as it is, and a field sent as null has its value removed. A field the record cannot be without refuses null (422). Each endpoint has a badge indicating whether you can already use it:
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
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.
550e8400-e29b-41d4-a716-446655440000).X-Idempotent-Replay: true header.409 Conflict.422 Unprocessable Content), the key becomes available again: sending the same request with the same key is processed again.422 Unprocessable Content.To keep the service stable for everyone, this API limits how many requests each client can make in a short time window.
/64 network: every address in the same /64 network adds up to the same limit.429 Too Many Requests and an error message.429, wait before retrying and use an increasing wait time between attempts (exponential backoff). 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.
cursor.has_next_page is true, repeat the request sending cursor with the next_cursor value from the previous response.has_next_page is false, next_cursor comes back null and the walk is over.size sets how many records come per page: from 1 to 50. Without the parameter, it is 20.400.Operations for uploading, downloading and deleting attachments associated with resources.
429.
Idempotency-Key and apply exponential backoff.
422 as not found when the credential may add attachments but cannot read it, and 403 when it can read it or may not add attachments.
403 with the Monde message.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "multipart/form-data" Example: multipart/form-data Request content type. Must be multipart/form-data. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| resource_type required | string Enum: "sale" "person" "bill" "travel" "task" Resource that will receive the attachment: "sale" for a sale, "person" for a person, "bill" for an account payable or receivable, "travel" for a travel, "task" for a task. |
| resource_id required | string <uuid> ID of the resource that will receive the attachment. |
| file required | string <binary> Binary file to attach.
|
| description | string <= 255 characters Attachment description. When omitted, the file name without the extension is used. The characters that Windows does not accept in a file name (\ / : * ? " < > |) are replaced by a hyphen (-). |
{ "resource_type": "sale", "resource_id": "c52a1c51-80e2-4a28-925e-2102a7b5d4e1", "file": "@voucher.pdf", "description": "voucher" }
{- "id": "0685f968-4afb-4574-be1b-3a1e5fc10d94",
- "description": "voucher",
- "extension": "pdf",
- "content_type": "application/pdf",
}Changes the name of the attachment, like Monde's Renomear. Only the name changes: the file and the owner record stay as they are. A blank name is refused with 422. Requires the same permissions as attaching on the owner record: its "Add attachments" and "Edit", with the reach to records of other origins the credential has. An attachment of a record the credential does not reach answers 404.
| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Attachment identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description required | string New name of the attachment. It cannot be blank. |
{- "description": "Comprovante de pagamento"
}{- "id": "0685f968-4afb-4574-be1b-3a1e5fc10d94",
- "description": "voucher",
- "extension": "pdf",
- "content_type": "application/pdf",
}Sends the attachment to the trash of the record, as in Monde, where it can be restored. The deleted attachment leaves the read of the record and can no longer be downloaded.
As in Monde, deleting only asks the "Delete attachments" permission of the resource that owns the attachment, in the company of the record (a person, which belongs to no company, counts in any company that writes), and the same reach as attaching:
404.| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Attachment identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}Redirects (302) to a temporary link to the file, which expires in a few minutes. A new request generates a new link. The content is gzip-compressed and comes without the Content-Encoding header: decompress it before use.
The download requires the read permission of the record that owns the attachment, granted in its company when it has one:
| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Attachment identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}A sale is an object that represents the commercialization of one or more products between a travel agency and its clients. To sell the product to the client, the agency may acquire it directly from a supplier or through a representative.
The sale the credential created is always its own; the ones of other sellers require the Consult, Open and Edit sales of other sellers permissions, as in Monde (see the FAQ).
Returns a paginated list of sales. By default, returns only opened and closed sales; to include canceled sales, use the status parameter.
| date_field | string Enum: "sale_date" "departure_date" "return_date" Example: date_field=sale_date 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. |
| date_from | string <date> Example: date_from=2024-01-01 Filter sales whose field chosen in date_field is on or after this date, in ISO 8601 format (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2024-12-31 Filter sales whose field chosen in date_field is on or before this date, in ISO 8601 format (YYYY-MM-DD). |
| status | Array of strings Items Enum: "opened" "closed" "canceled" Examples:
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. |
| people_id | Array of strings <uuid> [ items <uuid > ] Examples:
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. |
| number | integer Example: number=1024 Filter sales by the number shown in the app (e.g., 1024). One number per request. |
| updated_since | string <date-time> Example: updated_since=2026-08-01T14:30:00 Filter sales updated at or after this instant, in ISO 8601 format. Accepts a date (YYYY-MM-DD, taken as the start of the day) or a date-time (YYYY-MM-DDTHH:MM:SS). When the value carries no time zone, the Brasília time zone is assumed. Useful to reprocess only what changed since the last query, even within the same day. A sale comes back when its header changes or when one of these parts of it, shown in Get sale by ID, changes: products, passengers, segments and seats, commissions, attachments, payments and the linked bills (addition, cancellation and deletion). Settling a bill only brings the sale back when it changes the agency card fee of the products (a settlement or reversal with a card fee) or when it is partial and creates the balance bill. A change to a record the sale only references (person, catalog product, supplier, commissioned role) does not bring the sale back: that data is read from each record's own endpoint. The list brings the sale summary, and the detail comes from Get sale by ID. To also follow deleted sales, send |
| kind | Array of strings Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others" Example: kind=airline_ticket Filter sales by product kind, with the same |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}local_id. Give each product and each payment a local_id, a name of yours, unique in the request. In the response, each one comes back with the generated id next to that local_id. Keep the pair: to update the sale later, you point to each product and payment by its id. The local_id is not stored and does not come back in the sale get. Example: you send "insurances": [{ "local_id": "insurance-1", ... }] and get "insurances": [{ "id": "5d7e2a91-…", "local_id": "insurance-1", ... }]; in the update, you point to that insurance by { "id": "5d7e2a91-…" }. The same goes for each payment.
status: closed to create the sale already closed, honoring the closing rules. Without this field the sale is created open.
commissions with any commission also requires the "View commissions tab" and "Add commissions" permissions on sales, in the company of the sale, as in Monde; without them, the answer is 403 with the Monde message, and the sale is not created.
company_identifier, the creation is rejected with 422, as in Monde, which does not allow registering a sale outside a trip in that company. The API cannot yet create a sale within a trip.
payer registration must have, after the request, the fields Monde requires to save the sale: always name and an address with street, number, neighborhood and city; postal code for Brazilians; birthdate, mobile number and CPF (Brazilian) or passport (foreigner) for individuals; legal name, phone number, and CNPJ and IE (Brazilian) or foreign tax document (tax_identification_number) for companies. The registration counts as it stands after the request, including what the request creates or completes. If any is missing, the response is 422 with one error per field, and nothing is saved.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string (company_identifier) = 14 characters ^[0-9]{14}$ National Registry of Legal Entities (CNPJ) of the travel agency issuing the sale. Must contain digits only. |
| sale_date required | string <date> (sale_date) Sale date in ISO 8601 format (YYYY-MM-DD). |
| status | string Default: "opened" Enum: "opened" "closed" Sale status on creation. Defaults to |
| observations | string or null General remarks about the sale, as free text with no length limit. |
| operation_id | string (operation_id) Operation ID associated with this sale. The operation must be active. Travel agencies only; on a tour operator (consolidator), the field is rejected with 422. |
Array of objects (custom_field) Custom fields of the sale, defined by the agency. On creation, send each field by | |
required | object (seller_create) Data to register a seller. |
required | object (individual_or_company) 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. |
individual_or_company (object) or null | |
individual_person (object) or null Individual who requested the sale. | |
individual_or_company (object) or null Person who approved the sale. Travel agencies only. A tour operator (consolidator) sale has no approver, and the field sent with a value is rejected with 422. | |
Array of objects (insurance) Travel insurance. | |
Array of objects (cruise) Cruise. | |
Array of objects (hotel) Hotel room nights. | |
Array of objects (airline_ticket) Airline ticket. | |
Array of objects (train_ticket) Train ticket. | |
Array of objects (ground_transportation) Ground transportation. | |
Array of objects (car_rental) Car rental. | |
Array of objects (travel_package) Travel packages. | |
Array of objects (excursion) Excursions of the sale. The excursion is a system product: there is no need to inform which product is being sold. | |
Array of objects (visa) Consular visas of the sale, one per visa application. The visa is a system product: there is no need to inform which product is being sold. Each passenger is a visa applicant. | |
object or null Own operation product of the sale. At most one per sale, and the product must be the same as | |
Array of objects (others) Other sale products, which may or may not have passengers. | |
Array of objects or objects (payment) List of payments made for the sale. Each payment has a single method and can be distributed across one or more products, pointed to by | |
Array of objects (commission_create) Commissions to record on the sale. Only accepted when |
{- "company_identifier": "46598887000162",
- "sale_date": "2026-11-15",
- "seller": {
- "external_id": "a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46",
- "name": "João da Silva",
- "cpf": "83115137168"
}, - "payer": {
- "person_kind": "individual",
- "external_id": "cce45f2c-30e3-43a6-bbf1-af340188a04c",
- "name": "Márcio da Veiga",
- "legal_name": null,
- "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": null,
- "email": "contato@marcio.com",
- "phone_number": "11999990001",
- "mobile_number": "11999990002",
- "address": {
- "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": {
- "person_kind": "individual",
- "external_id": "8a9de5ce-dac6-4721-851b-7366bf9ff5b0",
- "name": "Isabel Ribas",
- "legal_name": null,
- "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": null,
- "email": "contato@isabel.com",
- "phone_number": "11999990003",
- "mobile_number": "11999990004",
- "address": {
- "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": {
- "person_kind": "individual",
- "external_id": "b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91",
- "name": "Renata Furtado",
- "legal_name": null,
- "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": null,
- "email": "contato@renata.com",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "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": {
- "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": null,
- "email": "contato@beatriz.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "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": [
- {
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "intermediary_commission_amount": 25.04,
- "agency_service_fee": 100,
- "discount_amount": 10,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "document": "9921508090000",
- "amount": 625.95,
- "fees": 31.3,
- "rav_fee": 15,
- "rav_fee_discount": 5,
- "agency_fee": 10,
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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": [
- {
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "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\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "intermediary_commission_amount": 417.94,
- "agency_service_fee": 100,
- "discount_amount": 100,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "document": "CRZ-90412",
- "amount": 8358.77,
- "fees": 209,
- "tip": 50,
- "rav_fee": 40,
- "rav_fee_discount": 10,
- "agency_fee": 20,
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "hotels": [
- {
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "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\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "intermediary_commission_amount": 281.54,
- "agency_service_fee": 100,
- "discount_amount": 50,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "document": "HTL-55821",
- "amount": 5630.73,
- "fees": 281.54,
- "other_fees": 30,
- "rav_fee": 60,
- "rav_fee_discount": 15,
- "agency_fee": 563.07,
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "airline_tickets": [
- {
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "intermediary_commission_amount": 68.04,
- "agency_service_fee": 100,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "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": {
- "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": {
- "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": {
- "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"
}
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07",
- "seats": [
- {
- "seat_number": "A27",
- "ticket_number": "99526874895"
}
]
}
], - "passengers": [
- {
- "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": {
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "train_tickets": [
- {
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "intermediary_commission_amount": 7.5,
- "agency_service_fee": 100,
- "discount_amount": 5,
- "segments": [
- {
- "railway_operator": "SNCF",
- "origin": "Paris Gare de Lyon",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "Nice-Ville",
- "arrival_date": "2026-11-20T21:35:07"
}
], - "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": {
- "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": {
- "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": {
- "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": [
- {
- "amount": 240.5,
- "fees": 24.05,
- "rav_fee": 10,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "document": "RE9988777",
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "ground_transportations": [
- {
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "intermediary_commission_amount": 4.28,
- "agency_service_fee": 100,
- "discount_amount": 5,
- "segments": [
- {
- "coach_company": "Viação UTIL",
- "service_class": "LE",
- "origin": "Terminal Rodoviário Novo Rio",
- "departure_date": "2026-11-18T15:35:07",
- "destination": "Terminal Rodoviário de Santos",
- "arrival_date": "2026-11-18T21:35:07",
- "seats": [
- {
- "seat_number": "27",
- "ticket_number": "0001234567"
}
]
}
], - "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": {
- "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": {
- "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": {
- "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": [
- {
- "amount": 121.95,
- "fees": 12.19,
- "rav_fee": 5,
- "rav_fee_discount": 1,
- "agency_fee": 3,
- "document": "0001234567",
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "car_rentals": [
- {
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "intermediary_commission_amount": 17.5,
- "agency_service_fee": 100,
- "discount_amount": 10,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "document": "LOC-77310",
- "amount": 350,
- "fees": 17.5,
- "other_fees": 8,
- "rav_fee": 7,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "travel_packages": [
- {
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "intermediary_commission_amount": 125,
- "agency_service_fee": 100,
- "discount_amount": 25,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "amount": 2500,
- "fees": 125,
- "other_fees": 25,
- "rav_fee": 50,
- "rav_fee_discount": 10,
- "agency_fee": 30,
- "document": "PCT2024050001",
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "excursions": [
- {
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T08:00:00",
- "arrival_date": "2026-11-20T18:00:00",
- "observations": "Saída do hotel às 8h.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "intermediary_commission_amount": 17.5,
- "agency_service_fee": 20,
- "discount_amount": 5,
- "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": {
- "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": {
- "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": {
- "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": [
- {
- "amount": 350,
- "fees": 17.5,
- "rav_fee": 10,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "document": "EXC2024060034",
- "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": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "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"
}
}
}
]
}
], - "payments": [
- {
- "local_id": "pagamento-1",
- "agency": {
- "credit_card": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "card_brand": "mastercard",
- "card_last_digits": "5678",
- "authorization": "ABC123",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "amount": 264.55
}
]
}
}
}, - {
- "local_id": "pagamento-2",
- "agency": {
- "bank_slip": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "amount": 350
}
]
}
}
}, - {
- "local_id": "pagamento-3",
- "agency": {
- "bank_deposit": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "observations": "TED",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "amount": 6475.34
}, - {
- "sale_product_local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "amount": 625.95
}
]
}
}
}, - {
- "local_id": "pagamento-4",
- "vendor": {
- "credit_card": {
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "products": [
- {
- "sale_product_local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "amount": 8358.77
}
]
}
}
}, - {
- "local_id": "pagamento-5",
- "vendor": {
- "others": {
- "details": "Fatura",
- "payer": {
- "person_kind": "individual",
- "external_id": "cce45f2c-30e3-43a6-bbf1-af340188a04c",
- "name": "Márcio da Veiga"
}, - "products": [
- {
- "sale_product_local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "amount": 2500
}
]
}
}
}, - {
- "local_id": "pagamento-6",
- "vendor": {
- "credit": {
- "products": [
- {
- "sale_product_local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "amount": 134.14
}
]
}
}
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Returns complete data for a specific sale, including all associated products and information. As the columns and tabs Monde hides, commission, over and revenue (on the products and in totals.revenue) only come with the "View commission, over and revenue" permission; payments and financial, with "View financial tab"; and commissions, with "View commissions tab". Without the permission, the field is left out of the response. It also applies to the response of Create and Update sale: without "View financial tab", payments brings only the id and the local_id of the payments sent.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique sale identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Deletes the sale the way Monde does: it is not removed, its status becomes canceled. The deleted sale no longer shows in List sales, unless the status parameter asks for canceled sales, and is still available when queried by ID. The agency can restore it in Monde.
The status changes before the response. Right after, Monde undoes what the sale generated in the finances: payments are removed and their receivables are deleted, a payment included in a client invoice leaves it, supplier items not yet invoiced are removed and commissions paid by a payment's financial entry are unlinked from it. What is still owed for each product becomes a balance again, owed by the payer (by the intermediary, on tour operators). This part finishes a few moments after the response.
The sale is not deleted, and the response is 409 with the reason, when it:
A sale with a printed receipt also requires the "Change sales with a printed receipt" permission, as in Monde; without it, the answer is 403.
Does not require Idempotency-Key: repeating the request after the sale is deleted returns 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique sale identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}null is removed (intermediary, approver, requester, operation_id and operation). seller and payer cannot be removed. The custom fields sent overwrite the current ones, and the others stay. Empty text is saved as sent (an empty custom field value clears the field); on a required field, and on a field that is not text, it is refused (422).insurances, hotels etc.), in segments, payments and commissions: an item with id stays or is changed, an item without id is added (with a local_id), and what is not sent is removed. An omitted list stays as it is. The sale cannot be left without products, nor a product without passengers.id from the get, and only the fields sent change. A product with payments, with a canceled passenger or whose supplier amount is already invoiced is not removed; a canceled product is not changed. In ground transportation and train tickets, resend included_services with the segments.person.id (as the get returns it) or by the external_id, and the same person appears only once in the product: repeated in the list, the response is 422. A person who is already an active passenger has that same passenger changed; a new person is added; an active passenger not sent is removed. A canceled passenger stays, sent or not: resent as read, nothing changes, and with any different value the response is 422, because a canceled passenger only changes through the reactivation. A list with only canceled passengers also answers 422.id, the one from the response that created it or from the get. The payer only changes if the sale is left without payments.status: closed to close the sale at the end of the update, with the closing rules of Monde. On a closed sale, status: opened reopens the sale before applying the rest of the request: the update applies as a whole, and if any part is refused nothing changes and the sale stays closed. Reopening only changes the sale status; commissions and financial entries stay as they are. Closing requires the "Close sale" permission; reopening requires its own "Reopen sale" permission, checked in the company of the sale, and "Close sale" alone does not reopen.company_identifier. It is refused when the sale has a payment with a bill, an invoiced supplier amount or is linked to a travel.commissions (even empty or null), plus "Add commissions" for a list with any commission and "Delete commissions" when the sale already has manual commissions, and "Change sales with a printed receipt" for any change to a sale with a printed receipt, plus "Swap passenger in closed sales or sales with a printed receipt" to swap the person of one of its passengers. The person, the seller, the ship and the cabin the sale creates along require "Edit" on People, Sellers, Ships and Cabins, as in the creation. Without it, the answer is 403 with the name of the permission, and nothing is changed. A field resent equal to the stored one asks no permission; commissions is the exception, because the list sent always replaces the manual commissions.local_id next to the id of each product and payment sent. When the credential cannot get the sale, only the sale id and the id and local_id of what you sent come back, in the same format. Getting the sale requires the "View" permission on sales in the sale's company, also for a sale the credential itself created, and, for a sale of another seller, also the permission to open the sales of other sellers: an update without any field does not serve as a get.| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique sale identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string CNPJ of the sale company. With another CNPJ, the sale moves to that company, if the change rules allow it. |
| sale_date | string <date> (sale_date) Sale date in ISO 8601 format (YYYY-MM-DD). |
| status | string Enum: "opened" "closed" Send closed to close the sale at the end of the update, following the closing rules. On an open sale, opened keeps it open; on a closed sale, opened reopens it before applying the rest of the update and closed keeps it closed. |
| operation_id | string (operation_id) Operation ID associated with this sale. The operation must be active. Travel agencies only; on a tour operator (consolidator), the field is rejected with 422. |
| observations | string or null General remarks about the sale. Replaces the current text; send null to clear it. Also changes on a closed sale, as in Monde, and the change goes to the sale log. |
Array of objects (custom_field) Custom fields of the sale. Not replaced: each field sent is written over the current value and the others stay. Sent blank or as null, the field is cleared, unless it is required. | |
object (seller_create) Data to register a seller. | |
object (individual_or_company) Payer of the sale. Only changes when, after the request, no payment is left on the sale products. Cannot be sent as null. | |
object (intermediary) Sale intermediary. A person or company that connects the parties involved in the sale of the product, facilitating the negotiation and generally receiving a commission for the intermediation. Required for tour operators, where the intermediary owes the customer invoice. | |
object (individual_person) Individual who requested the sale. | |
object (individual_or_company) Person who approved the sale. Travel agencies only. A tour operator (consolidator) sale has no approver, and the field sent with a value is rejected with 422. | |
Array of objects List that replaces the products of this kind (insurances). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (cruises). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (hotels). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (airline_tickets). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (train_tickets). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (ground_transportations). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (car_rentals). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (travel_packages). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (excursions). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (others). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
Array of objects List that replaces the products of this kind (visas). A product with id is changed, one without id is added and one left out is removed from the sale. Left out, keeps the products of this kind; empty or null, removes them all, as long as the sale keeps at least one product and none of them is blocked from removal. | |
object Own operation of the sale. With id, changes the one the sale has; without id, adds it. Sent as null, the own operation product is removed from the sale, which must keep at least one product. | |
Array of objects or objects or objects (payment_update) Final list of payments of the sale products. With id (the one from the response that created it or from the sale reading), the payment stays as it is and does not take a payment method along; without id, it is added; one left out is removed. To change a payment, remove it and add another. Empty or null, removes them all; if any cannot be removed, the update is refused. In the product of a new payment, use sale_product_local_id for a product sent in this request or sale_product_id for a product the sale keeps. | |
Array of objects (commission_create) List that replaces the manually informed commissions, in the same format as on creation. Applies to a sale the request closes or that is already closed. Empty or null, removes them all; with a paid commission, the list cannot be replaced. Sending it, even empty or null, requires the "View commissions tab" permission on sales, plus "Add commissions" for a list with any commission and "Delete commissions" when the sale already has manual commissions. |
Only the fields sent change: products, passengers and payments stay as they are. The approver is for travel agencies only: on a tour operator (consolidator), send only the custom field.
{- "approver": {
- "person_kind": "individual",
- "external_id": "b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91",
- "name": "Renata Furtado",
- "legal_name": null,
- "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": null,
- "email": "contato@renata.com",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "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"
}
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião anual"
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}The product is only canceled when every passenger of it is canceled. Canceling only some of the passengers leaves the product
active, with those passengers marked incanceled_at. A product without passengers is canceled right away. The optionscalculate_commission,delete_supplier_balanceandsupplier_fineonly apply when the request leaves every passenger canceled, that is, when the list cancels the ones still missing.delete_customer_balancealso applies when only some of the passengers are canceled.
Cancels a sale product, or some of its passengers, when the customer gives up what was sold. Canceling is not deleting: a deleted product (left out of the product list in PATCH /sales/{id}) was registered by mistake and had no movement; a canceled one is a sale that happened and was undone. To undo the cancellation, use Reactivate a sale product.
What changes and what does not
PATCH.Passengers and dates
The cancellation is always made through the passengers list: there is no default date and no canceling every passenger without listing them. No date can be earlier than the sale date.
passengers is refused (422). To cancel the whole product, list every active passenger.passengers, only the people in the list are canceled, each with its own canceled_at, required in the item. The person is referenced by person.id, the person id in passengers[].person when reading the sale.canceled when every passenger is canceled; until then it stays active, with the canceled passengers marked in canceled_at.passengers (body {} or only the options): its cancellation date is the current date, as in Monde.canceled_at at the root is not accepted (422): the date goes in each passenger of the list.Options
delete_customer_balance: the pending customer balance of this product is deleted and becomes deleted balance, which reduces the sale revenue. Only the balance that has not become a payment yet is deleted: if the customer will not pay a payment method already registered, delete it through the sale PATCH first. Requires a pending balance in the product.delete_supplier_balance: the items still open for the supplier (without a financial entry or, with the automatic invoice, in an invoice neither settled nor closed), Lei Kandir included, are deleted. What was already settled or paid directly to the supplier stays. Only applies when the request leaves every passenger canceled, and requires an open item. Not available for own operation products.supplier_fine: the fine charged by the supplier, as a positive amount in the currency the supplier is paid in. It becomes a fine item to settle with the supplier and reduces the revenue. Requires delete_supplier_balance. In an agency, the supplier is paid in the final currency of the sale, and the fine comes back in supplier_fine when reading. In an operator, the supplier is paid in the origin currency of the product: the fine sent comes back in supplier_fine_origin_currency, and supplier_fine brings the amount converted to the final currency by the exchange rate of the product. Example in an operator, product in USD with exchange rate 5: supplier_fine: 30 in the cancellation comes back as supplier_fine_origin_currency: 30 and supplier_fine: 150.calculate_commission: the canceled product stays in the commission plan goal calculation, as the calculate_commission field when reading the product. Default false: the product leaves the goal. Only applies when the request leaves every passenger canceled.delete_supplier_balance and supplier_fine are refused.Closed sale
409).Response
canceled_at, calculate_commission, deleted_balance, delete_supplier_balance, supplier_fine and supplier_fine_origin_currency show what the cancellation recorded; the fine sent in the currency the supplier is paid in comes back in supplier_fine in an agency and in supplier_fine_origin_currency in an operator. A credential without permission to read sales receives only the sale id.Requires, in the company of the sale, the permission to edit sales and the "Cancel product" permission, as in Monde; without it, the response is 403 with the Monde message. On a sale of another seller, it also requires "Edit sales of other sellers". The automatic connection credential, which only edits the sales it created, only cancels products of those sales, and only when the partner received "Cancel product" in the approval. The cancellation is recorded in the sale history, with the credential name.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| product_id required | string <uuid> Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 Sale product identifier (UUID), the product |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
Array of objects The passengers to cancel, each with its own date. Required for a product with passengers: to cancel the whole product, list every active passenger. Do not send it for a product without passengers. Each person goes only once: repeated, it answers 422. | |
| calculate_commission | boolean Default: false Keeps the canceled product in the commission plan goal calculation (the same |
| delete_customer_balance | boolean Default: false Deletes the pending customer balance of this product, which becomes deleted balance. |
| delete_supplier_balance | boolean Default: false Deletes the items still open for the supplier (invoice and Lei Kandir). Only applies when the request leaves every passenger canceled. |
| supplier_fine | number <double> >= 0 Default: 0 Fine charged by the supplier, as a positive amount, in the currency the supplier is paid in: the final currency of the sale in an agency and the origin currency of the product in an operator. When reading, it comes back in |
Cancels both passengers of the product, each with its own date, and with them the whole product, and deletes the balance the customer still owes in the product.
{- "passengers": [
- {
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "canceled_at": "2026-10-14"
}, - {
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}, - "canceled_at": "2026-10-15"
}
], - "delete_customer_balance": true
}Excerpt of the response when canceling one of the two passengers with delete_customer_balance: the product stays active, and the canceled passenger carries canceled_at. The other sale fields are those of the read by ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "opened",
- "insurances": [
- {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "status": "active",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 120.5,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "passengers": [
- {
- "canceled_at": "2026-10-14",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - {
- "canceled_at": null,
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}
]
}Undoes the product cancellation, for the whole product or only some of its passengers, as the uncancellation in Monde does. The product goes back to the active status and returns to the commission plan goal calculation.
Passengers
passengers list, with the person of each canceled passenger that comes back. To reactivate the whole product, list every canceled passenger. A product with passengers without the list is refused (422).{}).person.id as in the cancellation, must be a canceled passenger of the product.canceled_at nor the cancellation options (422): the reactivation undoes the cancellation as it was recorded.Financial records
409). On that product, some of the passengers can still be reactivated, keeping the deleted balance; to bring the last ones back, reopen the sale first.409: repeat the request in a few seconds. A fine that did not reach the invoice within 10 minutes no longer blocks the reactivation.Requires the same permissions as the cancellation: editing sales and "Cancel product", in the company of the sale, as the uncancellation in Monde. The response is the whole sale, or only its id to whoever cannot read sales. The reactivation is recorded in the sale history, with the credential name.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| product_id required | string <uuid> Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 Sale product identifier (UUID), the product |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
Array of objects The canceled passengers to reactivate. Required for a product with passengers: to reactivate the whole product, list every canceled passenger. Do not send it for a product without passengers. Each person goes only once: repeated, it answers 422. |
Reactivates only one canceled passenger, referenced by the person id. The fine and the deleted balance stay while there is a canceled passenger.
{- "passengers": [
- {
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}Excerpt of the response when reactivating the last canceled passenger: the product goes back to active, the passengers have no canceled_at, and the fine and the deleted balance go back to zero. The other sale fields are those of the read by ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "opened",
- "insurances": [
- {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "status": "active",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "passengers": [
- {
- "canceled_at": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - {
- "canceled_at": null,
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}
]
}Updates the due date and the description of a vendor item of the sale, as the Edit of the item in the Financial tab of Monde. The items and their id come in financial.vendor_items, in Get sale by ID. An omitted field stays as it is, and an unknown field is ignored.
What is edited here
bill and payment null). With the automatic vendor invoice, an item still to be invoiced is also edited, as in Monde.409: the due date and description that apply are those of the entry, which is changed in Update account payable or receivable.409: the due date is the one of the payment, which is changed in the payments of the sale, in Update sale.generated_credit) answers 409: it is handled in the credit of the person.409. An item that is not a vendor item of this sale, including a customer item and one awaiting deletion, answers 404.Response
financial.vendor_items. A credential without permission to read sales receives only the sale id.It requires, in the company of the sale, the permission to edit sales and "Ver aba financeiro" (view the financial tab), as in Monde; without "Ver aba financeiro", the response is 403 with the Monde message. On a sale of another seller, it also requires "Editar vendas de outros vendedores" (edit sales of other sellers).
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| id required | string <uuid> Example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 Vendor item identifier (UUID), the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| due_date | string <date> New due date of the item, in ISO 8601 format (YYYY-MM-DD). The due date is required: |
| description | string or null <= 100 characters New description of the item, up to 100 characters. |
Changes the due date and the description of an item still to be invoiced.
{- "due_date": "2026-12-15",
- "description": "Faturar em dezembro"
}Excerpt of the response: the updated item comes back in financial.vendor_items, next to the item already in an entry. The other sale fields are those of the read by ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "closed",
- "financial": {
- "observations": null,
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [ ],
- "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "invoice",
- "description": "Faturar em dezembro",
- "due_date": "2026-12-15",
- "amount": -650.95,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Generates the invoice of the standalone payment or of the deposit to the vendor or representative, with the open vendor items of the sale, as the Generate Standalone Payment or Deposit of the Financial tab and the Vendor Deposit of the product menu, in Monde. The items and their id come in financial.vendor_items, when reading the sale by ID. Unknown fields are ignored.
How the invoice is generated
409; try again later.Refusals
409, as does a closed or settled invoice the item is in.product_id answers 422, pointing to the item.Response
Location header. A credential that cannot read the invoice receives only its id.Requires, in the company of the sale, the permission to edit sales, and on the sale of another seller also "Editar vendas de outros vendedores" (edit sales of other sellers). It also requires "Ver aba financeiro" (view the financial tab), as the advance payment or deposit action of the Financial tab in Monde; only deposit with product_id, the vendor deposit of the product, does not. The invoice made by the sale, without the automatic invoice, also requires "Gerar Fatura" (generate invoice), of the accounts payable and receivable.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| kind required | string Enum: "advance" "deposit" What to generate, as in Monde:
|
| product_id | string <uuid> Product of the sale (UUID, the |
required | Array of objects non-empty The vendor items that go into the invoice, at least one. All of them must be of this sale, be open, and be of the same vendor or representative and the same currency, as the Monde grid filtered by the chosen vendor. |
Generates the standalone payment with the whole balance of the item.
{- "kind": "advance",
- "items": [
- {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "amount": 650.95
}
]
}Example detail of a vendor invoice, with the items in items and credit_card_items empty.
{- "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
- "number": "291",
- "transaction_kind": "debit",
- "kind": "vendor_invoice",
- "description": "Fatura Fornecedor Avulsa",
- "document": null,
- "invoice_number": null,
- "amount": 4,
- "final_amount": 4,
- "issue_date": "2026-07-13",
- "due_date": "2026-07-13",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": null,
- "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "d1e2f3a4-b5c6-4788-e9f0-a1b2c3d4e5f6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": null,
- "payment_method": null,
- "operation": null,
- "invoice_rule": null,
- "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": null,
- "checked": false,
- "amount": -4,
- "sale": {
- "id": "8b9c0d1e-2f3a-4b5c-8d6e-7f8a9b0c1d2e"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}
], - "credit_card_items": [ ]
}Adds the to-invoice payment to the sale, as the Faturar of the Financial tab of the sale in Monde: the payer pays the customer balance through the customer invoice. Unknown fields are ignored; so is the description, which the to-invoice payment does not have.
How it is recorded
202.payments.agency.to_invoice when reading the sale, in one line per customer invoice and cost center. Until then, it does not show in the sale.payments list neither keeps nor removes it. It leaves through the to-invoice removal.Refusals
409: the to-invoice payment is only added to an open sale.422, as Monde only offers the to-invoice payment when there is a balance.422, pointing to the product, as do a zero sum and a cost center the payer does not have.Response
id.Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt).
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| payer_id | string <uuid> (sale_to_invoice_payer_id) Payer (person UUID, the |
| cost_center | string <= 50 characters Cost center of the payer, up to 50 characters. With a legal-entity payer, it must be one of the cost centers registered on it, and it is stored with the registered name. With an individual payer it is refused, unless the agency uses free-text cost centers. When omitted, the payment has no cost center. |
required | Array of objects (sale_to_invoice_products) non-empty The products of the sale and the amount of each one, at least one. Each product appears once, has a customer balance and has the same sale currency as the others: a payment has a single currency. The sum of the amounts, with their signs, cannot be zero. |
Invoices to the payer of the sale the customer balance of a product, without a cost center.
{- "products": [
- {
- "sale_product_id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "amount": 650.95
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Adds the to-invoice return to the sale, as the Devolução › Faturar of the Financial tab of the sale in Monde: the amount the agency returns to the customer through the customer invoice. The body is the one of the to-invoice payment, with the description (description) instead of the cost center, which is ignored. Unknown fields are ignored.
How it is recorded
202.payments.agency.to_invoice when reading the sale, in the line of the customer invoice, summed with its sign: the negative amount is the return. It leaves through the to-invoice removal, together with the line.Refusals
409.422.422).Response
id.Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt).
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| payer_id | string <uuid> (sale_to_invoice_payer_id) Payer (person UUID, the |
| description | string <= 100 characters Description of the to-invoice return, up to 100 characters. |
required | Array of objects (sale_to_invoice_products) non-empty The products of the sale and the amount of each one, at least one. Each product appears once, has a customer balance and has the same sale currency as the others: a payment has a single currency. The sum of the amounts, with their signs, cannot be zero. |
Returns to the customer, through the customer invoice, the negative balance of a product.
{- "description": "Reembolso do seguro",
- "products": [
- {
- "sale_product_id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "amount": -150
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Removes a to-invoice line of the sale, as the Excluir (delete) of the payments grid of the Financial tab in Monde. The line is the one in payments.agency.to_invoice when reading the sale, pointed by the customer invoice (bill_id) and the cost center (cost_center).
What is removed
Refusals
409.409, unless reopen_sale comes as true: then the sale is reopened, and the credential also needs the permission "Reabrir venda" (reopen sale), 403 without it.409: reopen the invoice first, through Reopen a client invoice.409, unless remove_settlement comes as true: then the settlement of the invoice is undone.422, as does a confirmation that is neither true nor false.Response
id.Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt).
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Sale identifier (UUID), the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| bill_id required | string <uuid> Customer invoice of the line (UUID, the |
| cost_center | string or null Cost center of the line, its |
| reopen_sale | boolean Default: false Confirms reopening the closed sale, as Monde asks before deleting. With |
| remove_settlement | boolean Default: false Confirms undoing the settlement of a settled customer invoice, as Monde asks before deleting. Without the confirmation, a settled invoice answers |
Removes the to-invoice line of the customer invoice that has no cost center.
{- "bill_id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819",
- "cost_center": null
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "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": {
- "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",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "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,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:35:07",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:35:07"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-23T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "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": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "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,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:35:07",
- "arrival_date": "2026-11-20T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "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": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:35:07",
- "arrival_date": "2026-12-07T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "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,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:35:07",
- "arrival_date": "2026-11-22T15:35:07",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "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": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Returns the three additional fields of the sale product (external_number, additional1 and additional2) with the title the agency gave each one in Monde, such as "Nº Pedido". On the sale, send and read the field by its key: the title only tells which field is which, and renaming it in Monde does not change the key. A field without a title (active false) does not appear in Monde, and the API ignores the value sent to it. Requires the permission to read sales.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "key": "external_number",
- "label": "Ferrovia",
- "active": true
}, - {
- "key": "additional1",
- "label": "Nº Pedido",
- "active": true
}, - {
- "key": "additional2",
- "label": null,
- "active": false
}
]
}Query and maintain the catalog of travel products (insurance, cruises, hotels, airline tickets, own operations, and others) used in sales, with the suppliers of each product and the representatives of each supplier. Suppliers and representatives are parts of the product: they are read with the permission to read products, and each has its own permissions to write and to delete, as in Monde.
Returns the list of available products in the system, with the ability to filter by product kind.
| kind | Array of strings Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others" Examples:
Filters products by kind. For multiple kinds, separate values with commas (e.g., insurance,cruise,hotel). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing products of different kinds.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Seguro Viagem",
- "kind": "insurance",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "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": null,
- "included_services": null
}, - {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92",
- "name": "Diárias de Hospedagem",
- "kind": "hotel",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "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": null,
- "included_services": null
}, - {
- "id": "20febcb5-85ef-427d-9a4e-da407062432d",
- "name": "Operação Própria",
- "kind": "operation",
- "passengers": true,
- "system": false,
- "active": true,
- "nbs_code": null,
- "included_services": "Turismo de aventura"
}, - {
- "id": "3b857f74-8c82-4391-bc95-2245fc4ba341",
- "name": "Outros",
- "kind": "others",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}, - {
- "id": "bdaaf1b2-ee48-4b20-810a-10ccc27875b0",
- "name": "Aluguel de Carro",
- "kind": "car_rental",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "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": null,
- "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": null,
- "included_services": "Produto exclusivo CVC"
}, - {
- "id": "4f1c9a27-58aa-4d3e-9f0b-1c7d6e2b8a94",
- "name": "Excursão",
- "kind": "excursion",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Passeio com guia acompanhante"
}, - {
- "id": "d9d27b79-649e-4ef9-b198-f32baaa9f9d2",
- "name": "Visto",
- "kind": "visa",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Adds a product to the catalog. As on the Monde Products screen, only products of the others and operation (own operation) kinds can be created: the other kinds are system products. Own operation is an agency feature and is refused in an operator (consolidator) base. The kind and passengers are chosen on creation and do not change afterwards. Suppliers are added afterwards, at /products/{id}/supplies. Requires the permission to create and edit products in a company whose license allows writing.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name required | string <= 50 characters Product name |
| included_services | string or null Services included in the product |
| active | boolean Default: true Indicates whether the product is active |
| nbs_code | string or null Product NBS code (Brazilian Nomenclature of Services) |
| kind | string Default: "others" Enum: "others" "operation" Product kind. On creation only these are accepted:
|
| passengers | boolean Default: true Whether the product has passengers. Defaults to |
Example creating an Others product, with passengers and NBS code.
{- "name": "Passeio de Barco",
- "included_services": "Passeio de escuna com almoço",
- "kind": "others",
- "passengers": true,
- "active": true,
- "nbs_code": "1.2501.11.00"
}Example response with a product and its supplies, suppliers and representatives.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Seguro Viagem",
- "included_services": "Cobertura completa para viagens internacionais",
- "kind": "insurance",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": "115022000",
- "supplies": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Returns the complete data for a specific product, including its supplies with the supplier, the commission data and the representatives.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with a product and its supplies, suppliers and representatives.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Seguro Viagem",
- "included_services": "Cobertura completa para viagens internacionais",
- "kind": "insurance",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": "115022000",
- "supplies": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Changes an existing product, system products included. Send only the fields that should change: a field omitted stays as it is, and a field sent as null is removed. The included services (included_services) and the NBS code (nbs_code) sent as null are cleared; name, kind, passengers and active cannot be removed, and sending them as null is refused (422). The kind and passengers do not change after creation: sending the value the product already has is accepted, and another value is refused. CVC products are maintained by the CVC integration and cannot be changed (409). The response carries the updated product in the same format as the get by ID when the credential also has the "View" permission on products; without it, the change is saved anyway and the response carries only the id. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string <= 50 characters Product name |
| included_services | string or null Services included in the product |
| active | boolean Default: true Indicates whether the product is active |
| nbs_code | string or null Product NBS code (Brazilian Nomenclature of Services) |
| kind | string Default: "others" Enum: "others" "operation" Product kind. On creation only these are accepted:
|
| passengers | boolean Default: true Whether the product has passengers. Defaults to |
Example update that only deactivates the product, keeping the other fields.
{- "active": false
}Example response with a product and its supplies, suppliers and representatives.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Seguro Viagem",
- "included_services": "Cobertura completa para viagens internacionais",
- "kind": "insurance",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": "115022000",
- "supplies": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Deletes the product for good. System products cannot be deleted, and neither can a product with related records (suppliers, sales, billing or invoice rules, commission plans, integrations): to take it out of the catalog, deactivate it through PATCH (active: false) or merge it into another product on the Monde Products screen. Both cases answer 409. Requires the permission to delete products.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the suppliers (supplies) of the product, each with its commercial terms and representatives. Requires the permission to read products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example list of supplies, with the representatives of each one.
{- "data": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Adds a supplier to the product. The supplier person (supplier) is required and is referenced by its UUID. The same supplier may be added more than once, as long as the descriptions differ. The commission is either a percentage or an amount: the field of the other type is zeroed and, if sent, must be zero. Omitted fields take the Monde defaults: percentage commission, zero values and over on 100%. restitutes_kandir_law applies only to products with Kandir Law retention (airline ticket, travel insurance and ground transportation), and is refused on the others. Own operation products and CVC products have no suppliers (409). Requires the "Add supplier" permission on products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
required | object Supply supplier.
|
| description | string or null <= 50 characters Supply description (optional field). |
| restitutes_kandir_law | boolean Indicates whether the supply restitutes Lei Kandir. |
| commission_type | string Enum: "percentage" "amount" Commission type — percentage or amount. |
| commission_percentage | number <double> Commission percentage. |
| commission_amount | number <double> Commission amount. |
| over_percentage | number <double> Over percentage. |
| over_value | number <double> Percentage applied over the over. |
| du_percentage | number <double> DU card fee percentage. |
| rav_percentage | number <double> RAV card fee percentage. |
Example supplier with percentage commission and over.
{- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "over_percentage": 2.5,
- "over_value": 100
}Example response of a product supply.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Returns a supply of the product, with its commercial terms and representatives. The ID of a supply of another product answers 404.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a product supply.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Changes a supply of the product. Send only the fields that should change: a field omitted stays as it is, and a field sent as null is removed. The description sent as null is cleared; the supplier (supplier), restitutes_kandir_law and the commission fields cannot be removed, and sending them as null is refused (422). When commission_type changes, the commission field of the other type is zeroed. Representatives are maintained through their own path. Requires the "Edit supplier" permission on products. The response carries the updated supply when the credential also has the "View" permission on products; without it, only the id. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
object Supply supplier.
| |
| description | string or null <= 50 characters Supply description (optional field). |
| restitutes_kandir_law | boolean Indicates whether the supply restitutes Lei Kandir. |
| commission_type | string Enum: "percentage" "amount" Commission type — percentage or amount. |
| commission_percentage | number <double> Commission percentage. |
| commission_amount | number <double> Commission amount. |
| over_percentage | number <double> Over percentage. |
| over_value | number <double> Percentage applied over the over. |
| du_percentage | number <double> DU card fee percentage. |
| rav_percentage | number <double> RAV card fee percentage. |
Example update that switches the commission to an amount; the commission percentage is zeroed.
{- "commission_type": "amount",
- "commission_amount": 35
}Example response of a product supply.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Removes the supply from the product, together with its representatives. A supply used in sales cannot be removed (merge it into another supplier on the Monde Products screen), and neither can a supplier that has a billing rule for the product: both cases answer 409. Requires the "Delete supplier" permission on products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the representatives of a supply of the product, each with its own commercial terms. Requires the permission to read products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example list of representatives.
{- "data": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Adds a representative to the supply of the product. The representative person (representative) is required, referenced by its UUID, and cannot repeat in the same supply. The commission follows the same rules as the supply: percentage or amount, with the field of the other type zeroed, and the omitted fields with the Monde defaults. Requires the "Add representative" permission on products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
required | object Supply representative.
|
| commission_type | string Enum: "percentage" "amount" Commission type — percentage or amount. |
| commission_percentage | number <double> Commission percentage. |
| commission_amount | number <double> Commission amount. |
| over_percentage | number <double> Over percentage. |
| over_value | number <double> Percentage applied over the over. |
| du_percentage | number <double> DU card fee percentage. |
| rav_percentage | number <double> RAV card fee percentage. |
Example representative with an amount commission.
{- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}, - "commission_type": "amount",
- "commission_amount": 50
}Example response of a supply representative.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Returns a representative of the supply. The ID of a representative of another supply answers 404.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Unique identifier of the supply representative (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a supply representative.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Changes a representative of the supply. Send only the fields that should change: a field omitted stays as it is. The representative (representative) and the commission fields cannot be removed, and sending them as null is refused (422). Requires the "Edit representative" permission on products. The response carries the updated representative when the credential also has the "View" permission on products; without it, only the id. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Unique identifier of the supply representative (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
object Supply representative.
| |
| commission_type | string Enum: "percentage" "amount" Commission type — percentage or amount. |
| commission_percentage | number <double> Commission percentage. |
| commission_amount | number <double> Commission amount. |
| over_percentage | number <double> Over percentage. |
| over_value | number <double> Percentage applied over the over. |
| du_percentage | number <double> DU card fee percentage. |
| rav_percentage | number <double> RAV card fee percentage. |
Example update of the over percentage only.
{- "over_percentage": 1.5
}Example response of a supply representative.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Removes the representative from the supply. A representative used in sales cannot be removed (409). Requires the "Delete representative" permission on products.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique product identifier (UUID format). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Unique identifier of the product supply (UUID format). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Unique identifier of the supply representative (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the list of cabin types registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing all registered cabins.
{- "data": [
- {
- "name": "Externa"
}, - {
- "name": "Interna"
}, - {
- "name": "Suíte"
}, - {
- "name": "Varanda"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a cabin. The name is the cabin key: the cabin is read, updated and deleted by it, and it is what the sale's cruise product sends in cabin_kind.
Requires the "Edit" permission on cabins in a company that is not read-only. The response brings the created cabin.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 30 ] characters Cabin name, up to 30 characters and not repeating another cabin. Line breaks are removed. Required on creation; on update, a new name renames the cabin. |
Example of a cabin creation.
{- "name": "Varanda"
}Example response of a cabin.
{- "name": "Varanda"
}Returns the cabin by its name, sent in the path URL-encoded (space as %20, slash as %2F).
| name required | string <= 30 characters Example: Varanda Current cabin name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a cabin.
{- "name": "Varanda"
}Updates the cabin by its current name, sent in the path URL-encoded. An omitted field stays as it is. A new name renames the cabin, and the sale products that use it show the new name, as in Monde.
Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.
Requires the "Edit" permission on cabins in a company that is not read-only. The response brings the cabin to whoever can also read cabins; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| name required | string <= 30 characters Example: Varanda Current cabin name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 30 ] characters Cabin name, up to 30 characters and not repeating another cabin. Line breaks are removed. Required on creation; on update, a new name renames the cabin. |
Example of an update that renames the cabin.
{- "name": "Varanda Premium"
}Example response of a cabin.
{- "name": "Varanda"
}Deletes the cabin by its current name, sent in the path URL-encoded. A cabin used in any sale product cannot be deleted: the response is 409, as in Monde.
Requires the "Delete" permission on cabins in a company that is not read-only.
| name required | string <= 30 characters Example: Varanda Current cabin name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the list of ships registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing all registered ships.
{- "data": [
- {
- "name": "Costa Diadema"
}, - {
- "name": "MSC Preziosa"
}, - {
- "name": "MSC Seaview"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a ship. The name is the ship key: the ship is read, updated and deleted by it, and it is what the sale's cruise product sends in ship_name.
Requires the "Edit" permission on ships in a company that is not read-only. The response brings the created ship.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 30 ] characters Ship name, up to 30 characters and not repeating another ship. Line breaks are removed. Required on creation; on update, a new name renames the ship. |
Example of a ship creation.
{- "name": "MSC Preziosa"
}Example response of a ship.
{- "name": "MSC Preziosa"
}Returns the ship by its name, sent in the path URL-encoded (space as %20, slash as %2F).
| name required | string <= 30 characters Example: MSC Preziosa Current ship name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a ship.
{- "name": "MSC Preziosa"
}Updates the ship by its current name, sent in the path URL-encoded. An omitted field stays as it is. A new name renames the ship, and the sale products that use it show the new name, as in Monde.
Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.
Requires the "Edit" permission on ships in a company that is not read-only. The response brings the ship to whoever can also read ships; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| name required | string <= 30 characters Example: MSC Preziosa Current ship name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 30 ] characters Ship name, up to 30 characters and not repeating another ship. Line breaks are removed. Required on creation; on update, a new name renames the ship. |
Example of an update that renames the ship.
{- "name": "MSC Preziosa II"
}Example response of a ship.
{- "name": "MSC Preziosa"
}Deletes the ship by its current name, sent in the path URL-encoded. A ship used in any sale product cannot be deleted: the response is 409, as in Monde.
Requires the "Delete" permission on ships in a company that is not read-only.
| name required | string <= 30 characters Example: MSC Preziosa Current ship name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the list of packages registered in the system, ordered by name.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing all registered packages.
{- "data": [
- {
- "name": "Bariloche 5 noites",
- "services_included": null
}, - {
- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a package. The name is the package key: the package is read, updated and deleted by it, and it is what the sale's tour package product sends in package_name.
Requires the "Edit" permission on packages in a company that is not read-only. The response brings the created package.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 50 ] characters Package name, up to 50 characters and not repeating another package. Line breaks are removed. Required on creation; on update, a new name renames the package. |
| services_included | string or null Services included in the package. On update, null clears the field. |
Example of a package creation.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Example response of a package.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Returns the package by its name, sent in the path URL-encoded (space as %20, slash as %2F).
| name required | string <= 50 characters Example: Disney 7 noites Current package name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a package.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Updates the package by its current name, sent in the path URL-encoded. An omitted field stays as it is. Included services sent null are cleared. A new name renames the package, and the sale products that use it show the new name, as in Monde.
Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.
Requires the "Edit" permission on packages in a company that is not read-only. The response brings the package to whoever can also read packages; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
| name required | string <= 50 characters Example: Disney 7 noites Current package name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string [ 1 .. 50 ] characters Package name, up to 50 characters and not repeating another package. Line breaks are removed. Required on creation; on update, a new name renames the package. |
| services_included | string or null Services included in the package. On update, null clears the field. |
Example of an update that renames the package.
{- "name": "Disney 8 noites"
}Example response of a package.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Deletes the package by its current name, sent in the path URL-encoded. A package used in any sale product cannot be deleted: the response is 409, as in Monde.
Requires the "Delete" permission on packages in a company that is not read-only.
| name required | string <= 50 characters Example: Disney 7 noites Current package name, URL-encoded |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query and maintain the cost centers registered in the system to use in financial transactions.
Returns the list of cost centers registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing all registered cost centers.
{- "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": null
}
}Registers a cost center. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description required | string <= 50 characters Cost center description, up to 50 characters. Required on creation. |
Marketing cost center.
{- "description": "Marketing"
}Example response for a specific cost center.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Returns a specific cost center by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique cost center identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific cost center.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Changes the description of the cost center. An omitted field stays as it is; description cannot be removed, and sent as null it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the id. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique cost center identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description | string <= 50 characters Cost center description, up to 50 characters. Required on creation. |
Changes the description.
{- "description": "Marketing digital"
}Example response for a specific cost center.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Deletes the cost center. A cost center used in the apportionment of any financial entry responds 409. Does not require Idempotency-Key.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique cost center identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query and maintain the currencies registered in the system and their exchange rates, to use in sale products and financial transactions.
Returns the list of currencies registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing all registered currencies.
{- "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": null
}
}Returns a specific currency by its ISO 4217 code.
| code required | string Example: BRL Currency code in ISO 4217 format |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific currency.
{- "code": "BRL",
- "description": "Real",
- "symbol": "R$",
- "active": true
}Activates or deactivates the currency by its code. The currency list is internal and fixed: code, description and symbol do not change, and sending a value different from the current one in those fields is rejected with 422. An omitted field stays as it is.
Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only. The response brings the currency to whoever can also read currencies; to the others, only the code.
| code required | string Example: USD Currency code in ISO 4217 format |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| code | string = 3 characters Currency code. It is fixed: a value different from the current one is rejected (422) |
| description | string <= 100 characters Currency description. It is fixed: a value different from the current one is rejected (422) |
| symbol | string or null <= 5 characters Currency symbol. It is fixed: a value different from the current one is rejected (422) |
| active | boolean Whether the currency is active |
Example of an update that deactivates the currency.
{- "active": false
}Example response for a specific currency.
{- "code": "BRL",
- "description": "Real",
- "symbol": "R$",
- "active": true
}No currency is deleted: the currency list is internal and fixed, and the response is always 409. To stop using a currency, deactivate it with Update currency.
Requires the "Delete" permission on currencies in a company that is not read-only.
| code required | string Example: USD Currency code in ISO 4217 format |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the currency's exchange rate history, latest first. The exchange rate is how many reais one unit of the currency is worth; the current one is the latest. Requires the "View" permission on currencies.
| code required | string Example: USD Currency code in ISO 4217 format |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with the currency's exchange rate history.
{- "data": [
- {
- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}, - {
- "id": "2b7e4c1a-0f3d-4e8b-a6c2-91d5e7f30b44",
- "currency": {
- "code": "USD"
}, - "value": 5.38,
- "quoted_at": "2026-10-13T09:15:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Records the currency's new exchange rate, dated at the moment of recording, as Monde's Update Exchange Rates tool. The value is how many reais one unit of the currency is worth, greater than zero, and is recorded with 4 decimal places.
Only active currencies, except the real (BRL), take exchange rates. When the value equals the current exchange rate, nothing is recorded and the response brings the current one, with 200.
Recording exchange rates is exclusive to tour operators: for travel agencies the response is 403. Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only.
| code required | string Example: USD Currency code in ISO 4217 format |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| value required | number ( 0 .. 99999999999.9999 ] How many reais one unit of the currency is worth, greater than zero. It is recorded with 4 decimal places |
Example of recording the currency's new exchange rate.
{- "value": 5.4321
}Example response of an exchange rate.
{- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}Returns an exchange rate of the currency by its ID.
| code required | string Example: USD Currency code in ISO 4217 format |
| id required | string <uuid> Example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 Exchange rate ID |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of an exchange rate.
{- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}Records at once the new exchange rate of several currencies, as Monde's Update Exchange Rates tool. Each item carries the currency code and the value, how many reais one unit of it is worth; only active currencies, except the real (BRL), take exchange rates, and the same currency cannot repeat in the list.
Recording is all or nothing: an invalid item rejects the whole request with 422, and the error carries its position in the list, counted from 0. A currency whose value equals the current exchange rate is left out, and the response brings only the recorded exchange rates: 201 when at least one was recorded, and 200 with an empty list when every value equals the current exchange rate.
Exclusive to tour operators: for travel agencies the response is 403. Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
required | Array of objects non-empty The new exchange rates, one per currency |
Example of updating the dollar and euro exchange rates.
{- "exchange_rates": [
- {
- "currency_code": "USD",
- "value": 5.4321
}, - {
- "currency_code": "EUR",
- "value": 6.1234
}
]
}Example response in which only the dollar changed value and was recorded.
{- "exchange_rates": [
- {
- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}
]
}Query and maintain the financial categories registered in the system, grouped by kind (revenue or expense) and group.
Returns the list of financial categories registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing expense and revenue categories.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Aluguel",
- "kind": "expense",
- "pass_through": false
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "description": "Comissões a Repassar",
- "kind": "expense",
- "pass_through": true
}, - {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
- "description": "Venda de Pacotes",
- "kind": "revenue",
- "pass_through": false
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Registers a financial category in a group. The kind (expense or revenue) is the one of the group given in group_id. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description required | string <= 50 characters Category description, up to 50 characters. Required on creation. |
| group_id required | string <uuid> ID of the category group (see |
| pass_through | boolean Whether the category is a pass through: amounts that only go through the agency and stay out of the result. On creation, the default is |
Expense category in the Administrative Expenses group.
{- "description": "Aluguel",
- "group_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "pass_through": false
}Example response for a revenue category, with its group.
{- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
- "description": "Venda de Pacotes",
- "kind": "revenue",
- "pass_through": false,
- "group": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Returns a specific financial category by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the category |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a revenue category, with its group.
{- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
- "description": "Venda de Pacotes",
- "kind": "revenue",
- "pass_through": false,
- "group": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Changes the description, the pass through flag or the group of the category. The category only moves to another group of the same kind: changing the kind of a category is not allowed, as in Monde, and a group of another kind is refused with 422. An omitted field stays as it is; description, group_id and pass_through cannot be removed, and sent as null they are refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the id. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the category |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description | string <= 50 characters Category description, up to 50 characters. Required on creation. |
| group_id | string <uuid> ID of the category group (see |
| pass_through | boolean Whether the category is a pass through: amounts that only go through the agency and stay out of the result. On creation, the default is |
Changes only the description; the other fields stay as they are.
{- "description": "Aluguel da loja"
}Example response for a revenue category, with its group.
{- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
- "description": "Venda de Pacotes",
- "kind": "revenue",
- "pass_through": false,
- "group": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Deletes the category. A category used in any financial entry, or chosen as the default in a Monde setting, responds 409. As in Monde, a group left without categories is deleted along with it. Does not require Idempotency-Key.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the category |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query and maintain the groups that organize the financial categories. Each group is an expense or a revenue group, and its categories inherit that kind. Uses the Categories permissions. Monde deletes on its own a group left without categories when a category is saved through it: register the group together with its first category. Through the API, deleting the last category of a group also deletes the group.
Returns the category groups, expense groups before revenue groups, by name.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Expense and revenue groups.
{- "data": [
- {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Despesas Administrativas",
- "kind": "expense"
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "name": "Receitas de Vendas",
- "kind": "revenue"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Registers an expense or revenue category group. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name required | string <= 50 characters Group name, up to 50 characters. Required on creation. |
| kind required | string Enum: "expense" "revenue" Group kind: |
Expense group.
{- "name": "Impostos",
- "kind": "expense"
}Example of an expense category group.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Returns a category group by its identifier.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Unique group identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of an expense category group.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Changes the group name. The kind does not change after creation: the group's categories were already posted with that sign, and a different kind is refused with 422. An omitted field stays as it is; name and kind cannot be removed, and sent as null they are refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the id. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Unique group identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string <= 50 characters Group name, up to 50 characters. Required on creation. |
| kind | string Enum: "expense" "revenue" Accepted only with the current kind of the group: another kind is refused with 422. |
Changes only the name.
{- "name": "Tributos"
}Example of an expense category group.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Deletes the group without confirmation: the DELETE has no body, and a body sent is ignored. An empty group is deleted. As in Monde, deleting a group with categories also deletes its categories and asks for a confirmation, so here a group with categories responds 409. In that case, to delete the group with its categories, use Delete category group with confirmation. Requires the Excluir (delete) permission of Categories in an active company that is not read only. Does not require Idempotency-Key: repeating responds 404.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Unique group identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Deletes the group with the confirmation Monde asks for before deleting its categories. It is the same deletion as Delete category group, with the same rules, permissions and responses. The difference is that the confirmation goes in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way. As in Monde, deleting a group with categories also deletes its categories, so it asks for the confirmation in delete_categories: without it, it responds 409. If any category is used in a financial entry or in a Monde setting, nothing is deleted and the response is 409. An empty group is deleted without the confirmation. A value other than true or false responds 422. Requires the Excluir (delete) permission of Categories in an active company that is not read only. Requires Idempotency-Key: without it, the response is 400. As the deleted group no longer exists, a resend after the deletion responds 404.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Unique group identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| delete_categories | boolean Confirms that deleting the group also deletes its categories. Without it, a group with categories responds 409. Accepts only |
{- "delete_categories": true,
- "name": "Despesas Administrativas",
- "kind": "expense"
}{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Query the cities the agency can use, with state, country, and official codes (IBGE and SIAFI). They are the ones registered in the agency and the ones in Monde's city list, which has the IBGE municipalities and the cities abroad. A city of the list enters the agency's registry, with the same id, when a person or invoice starts using it.
Returns the cities the agency can use, the ones registered in it and the ones in Monde's city list. No permission is required: every credential can read them.
| name | string Example: name=sao paulo Filters by name, case- and accent-insensitive, like Monde's City field: matches the start of the words of the name (e.g. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing Brazilian and foreign cities.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Miami, FL",
- "ibge": null,
- "siafi": null
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "name": "Rio de Janeiro",
- "ibge": "3304557",
- "siafi": "6001"
}, - {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "São Paulo",
- "ibge": "3550308",
- "siafi": "7107"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific city by its identifier. No permission is required: every credential can read it.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique city identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a Brazilian city, with its state and country.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "São Paulo",
- "ibge": "3550308",
- "siafi": "7107",
- "state": {
- "id": "f6e0bbfe-44cc-478a-c4a3-c56f6de89fc5",
- "acronym": "SP",
- "name": "São Paulo"
}, - "country": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "name": "Brasil",
- "code": "BR",
- "code_3": "BRA",
- "sisbacen": 1058
}
}Query, register, update, and delete the person roles of the commissions module, as in the Monde Roles screen: the role name, the companies or sellers over whose sales it is commissioned, and the people linked to it, with the commission plan, start date and goals of each one. The Seller and Intermediary roles belong to the system: they are not renamed, are not commissioned over companies or sellers, and are not deleted, but they take people. Goals are written here, as in the "Plan and Goals" of the person in Monde: the goals list of each person in people, with the "Edit" permission on roles; the Goals resource only reads them. The resource exists only in agencies: in an operator installation, every call responds 403. Reading requires the "View" permission on roles; writing, the "Edit" permission on roles in a company that is not read only; deleting, the "Delete" permission on roles.
Returns the list of registered roles, by name, with the own fields of the role.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with an agency role and the two system roles.
{- "data": [
- {
- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false
}, - {
- "id": "32c878b4-291d-4b4a-9854-47212d172761",
- "description": "Intermediário",
- "seller": false,
- "intermediary": true,
- "system": true
}, - {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e",
- "description": "Vendedor",
- "seller": true,
- "intermediary": false,
- "system": true
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Registers a role. A role registered here is not a seller or intermediary role, so it needs at least one company or active seller in commissioned_over. Each person appears once in the role, and a commissioned person needs the start date. Each person can already come with their goals, in goals. Requires the "Edit" permission on roles.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description required | string <= 30 characters Role name, up to 30 characters. |
Array of objects (entity_reference) Companies and active sellers over whose sales the role is commissioned, by the | |
Array of objects (person_role_person_write) People linked to the role. On update, the list sent is final. |
Example registration of a role commissioned over a company, already with a linked person.
{- "description": "Gerente",
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01"
}
]
}Example response for a role commissioned over a company, with one linked person.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Returns a specific role by its identifier, with the companies or sellers over whose sales it is commissioned and the linked people, each one with their goals in the role, per year.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Unique role identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a role commissioned over a company, with one linked person.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Updates a registered role. Send only what should change: an omitted field stays as it is, and a field sent as null is removed. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). What the role cannot be without is refused (422): description, and in each people item the person and not_commissioned. The commission_plan and start_date of an item sent as null are removed. A list sent as null counts as the empty list. The lists sent are final: in commissioned_over, a company or seller left out leaves the role; in people, an item with id keeps and updates that link (only the fields sent in it), an item without id links a new person, and a link left out is undone, along with the goals of the person in the role. In the goals of an item, the list sent is also final: a goal with id stays and changes only the fields sent in it, a goal without id comes in, and a goal left out is deleted; an omitted goals keeps the goals, and a null goals deletes them all. Swapping the years of two goals in the same update is refused (422): make the swap in two updates, going through a free year first. In a system role (Seller, Intermediary) only people changes. Requires the "Edit" permission on roles. The response brings the updated role in the same format as the get by ID when the credential can also read roles; otherwise, the update is saved and the response brings only the id.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Unique role identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description | string <= 30 characters Role name, up to 30 characters. |
Array of objects (entity_reference) Companies and active sellers over whose sales the role is commissioned, by the | |
Array of objects (person_role_person_write) People linked to the role. On update, the list sent is final. |
Example update in which a link loses its plan and becomes not commissioned, a new person comes in, and the links not in the list are undone.
{- "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "commission_plan": null,
- "not_commissioned": true,
- "start_date": null
}, - {
- "person": {
- "id": "9a8b7c6d-5e4f-4321-8a9b-0c1d2e3f4a5b"
}, - "start_date": "2026-03-01"
}
]
}Example response for a role commissioned over a company, with one linked person.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Deletes the role for good, with its person links and their goals. A system role and a role that already has a commission calculated in a sale are not deleted: the response is 409. Requires the "Delete" permission on roles.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Unique role identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query, register, change and delete the sellers used in sales. A seller is an individual person already registered, and its identifier is the person identifier. There is a single seller registry for the whole system, with no company: the permissions apply in any active company where they are granted, and writing requires a company that is not read only.
Returns the list of sellers registered in the system (active and inactive).
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing active and inactive sellers.
{- "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": null
}
}Turns an individual person already registered, given in person_id (the id of the People read), into a seller. The seller gets the same identifier as the person. As in Monde, only an individual becomes a seller, and each person only once. The seller is born active, unless active is sent as false. To register the person and the seller in a single call, along with the sale, use the seller of Create a sale. Requires the "Edit" permission on sellers.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| external_id required | string <= 50 characters 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. |
| name required | string <= 100 characters Name. |
| cpf | string = 11 characters Brazilian Individual Taxpayer Registry (CPF), without dots, dashes, or spaces. |
| person_id required | string <uuid> Identifier of the individual person that becomes a seller |
| active | boolean Default: true Indicates whether the seller is born active. When omitted, the seller is born active |
Turns the given individual person into a seller, already active.
{- "person_id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}Example response for a specific seller.
{- "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"
}
}Returns a specific seller by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique seller identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific seller.
{- "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"
}
}Activates or deactivates a seller. An inactive seller stays in the sales where it already is, but is no longer offered in new sales in Monde. The person of the seller does not change: sending another person in person_id is rejected with 422. A field omitted stays as it is; person_id and active cannot be removed, and sending them as null is rejected (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). Requires the "Edit" permission on sellers. The response brings the changed seller when the credential also has the "View" permission on sellers; without it, the change is saved all the same and the response brings only the seller id.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique seller identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| person_id | string <uuid> Identifier of the person of the seller. Optional; if sent, it must be the seller's own person, which does not change |
| active | boolean Indicates whether the seller stays active. An inactive seller is no longer offered in new sales |
Deactivates the seller, which is no longer offered in new sales.
{- "active": false
}Example response for a specific seller.
{- "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"
}
}Deletes the seller. The person stays registered; it just stops being a seller. A seller that is already in a sale cannot be deleted and answers 409: deactivate it with active: false. Requires the "Delete" permission on sellers.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique seller identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query and maintain the payment methods registered in the system to use in financial transactions.
Returns the list of payment methods registered in the system. Internal system payment methods are not returned.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing system and user-registered payment methods.
{- "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": null
}
}Registers an agency payment method. It is created outside the system (system equal to false) and shows in the list. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name required | string <= 30 characters Payment method name, up to 30 characters. Required on creation. |
Agency payment method.
{- "name": "Vale-viagem"
}Example response for a specific payment method.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Returns a specific payment method by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the payment method |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific payment method.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Changes the name of the payment method. A system payment method (system equal to true) cannot be changed and responds 409, as in Monde; an internal one, which does not show in the list, responds 404. An omitted field stays as it is; name cannot be removed, and sent as null it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the id. Requires the Idempotency-Key header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.
| id required | string <uuid> Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 Unique identifier of the payment method |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string <= 30 characters Payment method name, up to 30 characters. Required on creation. |
Changes the name.
{- "name": "Voucher"
}Example response for a specific payment method.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Deletes an agency payment method. A system payment method responds 409, as does one used in entries, account movements or rate rules; an internal one responds 404. Does not require Idempotency-Key.
| id required | string <uuid> Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 Unique identifier of the payment method |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query, create, update and delete accounts and cards: cash account, checking account and credit card, with bank and card data, the companies where each account is available, the user groups with access and the bank slip billing of the checking account.
Returns the list of accounts and cards available in the companies where the credential has permission. Active and inactive accounts are returned.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing a checking account and a credit card.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Banco do Brasil - Matriz",
- "kind": "checking_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 1500,
- "bank_operation": null,
- "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "bill_expiration": null,
- "bill_closing": null
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Cartão Corporativo",
- "kind": "card_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 0,
- "bank_operation": null,
- "agency": null,
- "agency_digit": null,
- "number": null,
- "digit": null,
- "pix_key": null,
- "bill_expiration": 10,
- "bill_closing": 1
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Registers a cash account (cashier_account), checking account (checking_account) or credit card (card_account), with the same rules as the Monde form. Each kind saves only its own fields: a field of another kind (such as agency or initial_balance on a card, or billing_accounts outside a checking account) is ignored, like a field that does not exist, and is not saved. The account becomes available in the companies of companies, and the credential needs the permission to create and edit accounts and cards in each of them. For a credit card, the invoice is generated in invoice_company, which must be one of the account companies; with a single company, it is that one. Billing (billing_accounts) only exists on checking accounts.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description required | string <= 50 characters Account description |
| currency required | string Currency code (ISO 4217), one of the registered currencies. It cannot change after the account has movements. |
| active | boolean Whether the account is active. The default receipt account cannot be deactivated. |
| initial_balance | number <double> Initial balance, with up to 2 decimal places. Does not exist on credit cards, where it is ignored. Changing it reopens the closed cash of the account and requires the Reopen Cash permission. |
object (entity_reference) Reference to a related record. | |
object Bank of the checking account, by the | |
| agency | string Branch of the checking account: 4 digits, numbers only. |
| agency_digit | string <= 1 characters Bank branch digit |
| bank_operation | string Account operation, only at Caixa Econômica Federal (bank 104), with 3 or 4 digits. |
| number | string <= 10 characters Bank account number |
| digit | string <= 1 characters Bank account digit |
| pix_key | string <= 100 characters Account Pix key |
object Credit card operator (person), required on credit cards. | |
| bill_expiration | integer [ 1 .. 31 ] Card invoice due day (1 to 31), required on credit cards. |
| bill_closing | integer [ 1 .. 31 ] Card invoice closing day (1 to 31), required on credit cards. |
object Company where the card invoice is generated, one of the | |
required | Array of objects (entity_reference) non-empty Companies where the account is available, by |
Array of objects (entity_reference) User groups with access to the account. Without groups, the account has no restriction. A total access group cannot be linked. On update, it is the final list. | |
Array of objects (billing_account_write) Bank slip billing setups, only on checking accounts; on other accounts, the list is ignored. On update, it is the final list: a billing setup that already issued bank slips cannot be left out. | |
| kind required | string Enum: "cashier_account" "checking_account" "card_account" Account kind: |
Registers a checking account available in one company, released to a user group and with Monde Bancos billing.
{- "kind": "checking_account",
- "description": "Banco do Brasil - Matriz",
- "currency": "BRL",
- "initial_balance": 1500,
- "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "bank": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "billing_accounts": [
- {
- "kind": "monde_bancos",
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "bank_fee": 2.5
}
]
}Example response for a single account.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Banco do Brasil - Matriz",
- "kind": "checking_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 1500,
- "bank_operation": null,
- "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "bill_expiration": null,
- "bill_closing": null,
- "bank": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}Returns a specific account or card by its identifier, as long as it is available in a company where the credential has permission.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique account identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a single account.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Banco do Brasil - Matriz",
- "kind": "checking_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 1500,
- "bank_operation": null,
- "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "bill_expiration": null,
- "bill_closing": null,
- "bank": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}Updates the account or card. An omitted field stays as it is, a field sent as null is removed, and the kind does not change. description, currency, active and initial_balance sent as null answer 422. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A field of another account kind is ignored, as on creation: sending back what the get returned is not refused. Each list sent becomes the final list of the account: in companies and user_groups, an item left out is unlinked; in billing_accounts, a billing setup with id is updated (only in the fields sent), one without id is created and one left out is deleted. Linking or unlinking a company requires the permission to edit accounts in it. A company with open entries on the account, or the one that generates the card invoice, cannot be unlinked. Changing the initial balance reopens the closed cash of the account and, as in Monde, also requires the Reopen Cash permission of Accounts and Cards in one of the account companies; without it, the response is 403 and nothing is saved. Sending back the saved balance does not require the permission. Changing the card invoice company or due day moves the open invoices along, and changing the company requires the permission to edit accounts in both companies. The response brings the account only to credentials that can also read it; to the others, only the id.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique account identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| description | string <= 50 characters Account description |
| currency | string Currency code (ISO 4217), one of the registered currencies. It cannot change after the account has movements. |
| active | boolean Whether the account is active. The default receipt account cannot be deactivated. |
| initial_balance | number <double> Initial balance, with up to 2 decimal places. Does not exist on credit cards, where it is ignored. Changing it reopens the closed cash of the account and requires the Reopen Cash permission. |
object (entity_reference) Reference to a related record. | |
object Bank of the checking account, by the | |
| agency | string Branch of the checking account: 4 digits, numbers only. |
| agency_digit | string <= 1 characters Bank branch digit |
| bank_operation | string Account operation, only at Caixa Econômica Federal (bank 104), with 3 or 4 digits. |
| number | string <= 10 characters Bank account number |
| digit | string <= 1 characters Bank account digit |
| pix_key | string <= 100 characters Account Pix key |
object Credit card operator (person), required on credit cards. | |
| bill_expiration | integer [ 1 .. 31 ] Card invoice due day (1 to 31), required on credit cards. |
| bill_closing | integer [ 1 .. 31 ] Card invoice closing day (1 to 31), required on credit cards. |
object Company where the card invoice is generated, one of the | |
Array of objects (entity_reference) non-empty Companies where the account is available, by | |
Array of objects (entity_reference) User groups with access to the account. Without groups, the account has no restriction. A total access group cannot be linked. On update, it is the final list. | |
Array of objects (billing_account_write) Bank slip billing setups, only on checking accounts; on other accounts, the list is ignored. On update, it is the final list: a billing setup that already issued bank slips cannot be left out. | |
| next_bank_slip_number | integer [ 1 .. 2147483647 ] Number of the next bank slip, only when updating a checking account; on other accounts, it is ignored, and empty text is refused (422) on any account. The numbering only moves forward: a number lower than the current one, or not greater than the last issued bank slip, answers 422. Resending the current number changes nothing. |
Updates the description, the Pix key and the agreement code of an existing billing setup. The billing list sent is final: a billing setup left out would be deleted.
{- "description": "Banco do Brasil - Filial",
- "pix_key": "filial@agencia.com.br",
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "agreement_code": "7654321"
}
]
}Example response for a single account.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Banco do Brasil - Matriz",
- "kind": "checking_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 1500,
- "bank_operation": null,
- "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "bill_expiration": null,
- "bill_closing": null,
- "bank": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}Deletes the account or card from every company, so it requires the permission to delete accounts and cards in each company where the account is available. As in Monde, an account with movements, with a billing setup, released to a user group or set as the default receipt account cannot be deleted (409).
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique account identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query Monde's bank table, the same one used to set the bank of a checking account. Through the API the table is read-only: banks are registered in Monde.
Returns the list of banks, ordered by bank name, as in the bank choice of the checking account form.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing banks from the reference table.
{- "data": [
- {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil S.A."
}, - {
- "id": "5d0f4a3e-8b1c-4a2f-9a51-2f1d3c6b7e80",
- "number": "104",
- "name": "Caixa Econômica Federal"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific bank by its identifier.
| id required | string <uuid> Example: c3b7e8eb-1199-4457-9170-923c3fe56c92 Unique identifier of the bank |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific bank.
{- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil S.A."
}Query the invoice (nota fiscal) issuing rules, with the sale fields that compose each issuance. The rules belong to no company: they apply to the whole agency, and exist only on an agency installation.
Returns the list of invoice (nota fiscal) rules registered in the system. Null product, supplier, and payer mean the rule applies to all.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing a general rule and a rule restricted to a product and supplier.
{- "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": null,
- "revenues": [
- "du_fee",
- "rav_fee",
- "agency_service_fee"
], - "discounts": [
- "discount"
]
}, - "supplier_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Seguro viagem - fornecedor emite",
- "representative_scope": "none",
- "created_at": "2023-11-02T16:45:00",
- "payer_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "supplier_rule": {
- "recipient": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "revenues": [
- "commission_amount",
- "over_amount"
], - "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific invoice (NF) rule by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the invoice (NF) rule |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific invoice (NF) rule.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Regra padrão de pacotes",
- "representative_scope": "any",
- "created_at": "2024-03-15T10:30:00",
- "product": null,
- "supplier": null,
- "representative": null,
- "payer": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "payer_rule": {
- "recipient": null,
- "revenues": [
- "du_fee",
- "rav_fee",
- "agency_service_fee"
], - "discounts": [
- "discount"
]
}, - "supplier_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}Query, create, update, and delete tasks, with assignee, linked person, category, and due date, and comment on their history. The task the credential created is always its own; the ones of other users require the See tasks of other users permission, as in Monde (see the FAQ).
Returns the list of tasks from the companies where the credential has permission (tasks without a company are visible in all of them), from the task without due date to the one due furthest away. The filters are those of the Monde Tasks screen and combine with each other: assignee, who created it, person, category, situation, overdue, period (by due, creation or completion date) and the link to a sale, travel or bill. Without status, deleted tasks are not returned. A filter with an invalid value answers 400.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| assignee_id | string <uuid> Example: assignee_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Returns only the tasks of this assignee, by the person identifier. |
| created_by_id | string <uuid> Example: created_by_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Returns only the tasks created by this person (the task |
| person_id | string <uuid> Example: person_id=c3b7e8eb-1199-4457-9170-923c3fe56c92 Returns only the tasks linked to this person. |
| category_id | string Example: category_id=11 Returns only the tasks of this category, by the identifier obtained from List task categories. |
| status | Array of strings Items Enum: "pending" "completed" "deleted" Example: status=pending Situations to return, comma-separated: |
| overdue | boolean Example: overdue=true
|
| date_field | string Enum: "due" "created_at" "completed_at" Example: date_field=due Date used by the period filter: |
| date_from | string <date> Example: date_from=2024-04-01 Start of the period (inclusive), in the YYYY-MM-DD format. |
| date_to | string <date> Example: date_to=2024-04-30 End of the period (inclusive, the whole day), in the YYYY-MM-DD format. |
| sale_id | string <uuid> Example: sale_id=8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 Returns only the tasks linked to this sale. |
| travel_id | string <uuid> Example: travel_id=1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 Returns only the tasks linked to this travel. |
| bill_id | string <uuid> Example: bill_id=5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 Returns only the tasks linked to this bill (account payable or receivable). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing pending and completed tasks.
{- "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": null,
- "visualized": false,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00"
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "number": 1043,
- "title": "Cobrar segunda parcela",
- "description": null,
- "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": null
}
}Creates a task with title and assignee; category and due date are optional, and a task without a due date is never overdue. The task's company is optional, but stating it is not: send company_identifier with the company's CNPJ, or as null for the task to apply to every company; empty is rejected. Omitting the field is rejected, because the company is not inferred. Accepts, in history, the comments the task is born with. The task can be born linked to a sale (sale_id), a travel (travel_id) and a bill (bill_id), each one optional and with no required relation to the task person (person_id). When sent together, they must match each other: the sale must belong to the travel sent, and the bill to the sale sent. Only records the credential can read are accepted; the others answer 422 as not found. The assignee is notified by email, and the task is created as pending.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string or null = 14 characters ^[0-9]{14}$ CNPJ of the company where the task will be created, digits only. Null creates the task without a company, applying to every company; the field is required and omitting it is rejected. A company where the credential has no permission at all is rejected as a CNPJ not found |
| title required | string <= 100 characters Task title |
| description | string Task description |
| due | string <date-time> Due date and time (null when the task has no due date, and then it is never overdue) |
| category_id | integer Identifier of the task category, obtained from List task categories. |
| assignee_id required | string <uuid> Identifier of the person assigned to the task, obtained from List people. The person must be an active Monde user and, on the task of a company, have access to its tasks, as in Monde. The check applies to every change of the task, also when the assignee does not change. |
| person_id | string <uuid> Identifier of the person linked to the task, obtained from List people. |
| sale_id | string <uuid> Identifier of the sale to link, obtained from List sales. With |
| travel_id | string <uuid> Identifier of the travel to link, obtained from List travels. |
| bill_id | string <uuid> Identifier of the bill (account payable or receivable) to link, obtained from List accounts payable and receivable. With |
Array of objects (task_historic_create) Comments the task is born with | |
Array of objects (custom_field) Custom fields to fill in the task, defined by the agency |
Example creation of a task with a linked person, an initial comment, and a custom field.
{- "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"
}
]
}Example view of a task with its history and custom fields.
{- "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": null,
- "visualized": false,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00",
- "category": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "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": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Returns the data of a specific task, including its history, custom fields and attachments.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique task identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example view of a task with its history and custom fields.
{- "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": null,
- "visualized": false,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00",
- "category": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "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": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Updates an existing task. Send only the fields that should change: a field that is omitted stays as it is, and a field sent as null is removed from the task — the description, the due date, the category, the person and the links. title, assignee_id and completed cannot be removed: a task must have a title and an assignee, and sending them as null or empty is rejected (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). To complete the task send completed as true, and to reopen it, as false. company_identifier omitted keeps the task's company; with a CNPJ, it moves the task to that company and also requires the "Edit" permission on tasks there; sent as null, it leaves the task without a company, applying to every company. Custom fields are not replaced: each one sent overwrites its current value, the one sent with a null or empty value is cleared (a required one cannot be cleared: the response is 422), and the others stay. The links to a sale, travel and bill (sale_id, travel_id, bill_id) follow the creation rules: omitted, the link stays; sent as null, it is removed from the task. A task person already filled in is not replaced or removed while the task has a link: remove the links first, or in the same request. Filling in the person of a task that has none is allowed, even with a link. Comments are sent through Comment on the task. Requires the "Edit" permission on tasks. A deleted task cannot be updated: the response is 409. The task participants are notified of the change by email, as when the change is made in Monde. The response returns the updated task in the same format as the query by ID when the credential also has the "View" permission on tasks in the task's company; without it, the update is written all the same and the response returns only the id of the task. This also applies to a task the credential itself created.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique task identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string or null = 14 characters ^[0-9]{14}$ CNPJ of the company the task is moved to, digits only. Null removes the task from its company, leaving it valid for every company; omitted, it keeps the current company. A company where the credential has no permission at all is rejected as a CNPJ not found. A task of another user also requires "See tasks of other users" in the target company; without it, the answer is 403 with the Monde message |
| title | string <= 100 characters Task title |
| description | string or null Task description |
| due | string or null <date-time> Due date and time. Null removes the due date, and the task is no longer overdue; omitted, keeps the current due date |
| category_id | integer or null Identifier of the task category, obtained from List task categories. Null removes the category; omitted, keeps the current category. |
| assignee_id | string <uuid> Identifier of the person assigned to the task, obtained from List people. The person must be an active Monde user and, on the task of a company, have access to its tasks, as in Monde. The check applies to every change of the task, also when the assignee does not change. |
| person_id | string or null <uuid> Identifier of the person linked to the task, obtained from List people. |
| sale_id | string or null <uuid> Identifier of the sale to link, with the creation rules. Null removes the link; omitted, it keeps the current one. |
| travel_id | string or null <uuid> Identifier of the travel to link, with the creation rules. Null removes the link; omitted, it keeps the current one. |
| bill_id | string or null <uuid> Identifier of the bill to link, with the creation rules. Null removes the link; omitted, it keeps the current one. |
| completed | boolean
|
Array of objects (custom_field) 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 |
Example update of the title, due date, assignee, and a custom field of an existing task.
{- "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"
}
]
}Example view of a task with its history and custom fields.
{- "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": null,
- "visualized": false,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00",
- "category": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "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": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Deletes the task. A deleted task no longer appears in List tasks, 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. 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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique task identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Appends a comment to the task history and returns the task with the updated history — or only the id of the task, when the credential does not have the "View" permission on tasks in the task's company, even on a task it created. The task participants are notified of the comment by email, as when the comment is made in Monde. Requires the "Edit" permission on tasks. A deleted task does not take comments: the response is 409. The comment can carry files: send each one first through Upload attachment, with resource_type task and the task id, and send the returned ids in attachment_ids. Each attachment is linked to the comment and shows inside it in Monde. With attachments, the text is optional. The history is append-only: a recorded comment is neither changed nor deleted, and the change logs Monde generates are not sent through here.
| task_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique task identifier (UUID format). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| text | string Comment text |
| attachment_ids | Array of strings <uuid> [ items <uuid > ] Identifiers of the attachments to link to the comment, returned by Upload attachment. Each one must be an attachment of this task, not deleted and not yet in a comment; the others answer 422 as not found. |
Example comment appended to the history of an existing task.
{- "text": "Cliente confirmou os dados do embarque."
}Example view of a task with its history and custom fields.
{- "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": null,
- "visualized": false,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00",
- "category": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "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": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Query, create, update and delete task categories. Each category can be a column of the task board (kanban), and the order of the columns is also written here. Categories belong to no company: they apply to the whole agency.
Returns the list of task categories registered in the system, with the task board flag and the position of each column.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing task categories, two of them on the board.
{- "data": [
- {
- "id": 12,
- "name": "Cobrança",
- "kanban": false,
- "kanban_position": null
}, - {
- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}, - {
- "id": 7,
- "name": "Reserva",
- "kanban": true,
- "kanban_position": 1
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a task category. As on Monde's Categories screen, the new category joins the task board as the last column; send kanban as false to keep it off the board, or kanban_position to put it in another position, shifting the other columns. The name is unique, case-insensitive, and surrounding spaces are discarded. Requires the "Edit" permission on task categories.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name required | string <= 30 characters Task category name, up to 30 characters. It is unique, case-insensitive, and surrounding spaces are discarded. |
| kanban | boolean Default: true Whether the category is a column of the task board (kanban). When omitted, the category joins the board. |
| kanban_position | integer >= 1 Position of the column on the task board, starting at 1, from left to right; the other columns shift. It goes from 1 to the number of board columns already counting this category, and is only accepted for a category that stays on the board. When omitted, a new category joins as the last column and an updated one keeps its position. |
Creates the category and puts it in the second column of the task board.
{- "name": "Emissão",
- "kanban_position": 2
}Example response with a specific task category.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Returns the data of a specific task category.
| id required | integer Example: 42 Unique task category identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with a specific task category.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Updates a task category. Send only the fields that must change: an omitted field stays as it is. The name and kanban cannot be removed: sent as null they are refused (422), as are an empty name and kanban or kanban_position sent as an empty text. kanban_position is null only off the board: sent as null for a category that stays on the board, it is refused (422). Renaming the category takes its tasks along. With kanban_position, the column moves to that position of the board and the others shift; with kanban as false, the category leaves the board, and its tasks stay in the category. Requires the "Edit" permission on task categories. The response brings the updated category in the same format as the query by ID when the credential also has the "View" permission on task categories; without it, the change is saved anyway and the response brings only the id.
| id required | integer Example: 42 Unique task category identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string <= 30 characters Task category name, up to 30 characters. It is unique, case-insensitive, and surrounding spaces are discarded. |
| kanban | boolean Whether the category is a column of the task board (kanban). When it returns to the board without |
| kanban_position | integer or null >= 1 Position of the column on the task board, starting at 1, from left to right; the other columns shift. It goes from 1 to the number of board columns already counting this category, and is only accepted for a category that stays on the board. When omitted, a new category joins as the last column and an updated one keeps its position. |
Changes only the category name; its tasks follow.
{- "name": "Emissão de bilhetes"
}Example response with a specific task category.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Deletes the task category for good, and its column leaves the board. As in Monde, only a category without tasks can be deleted, counting completed and deleted tasks too: move the tasks to another category first. Requires the "Delete" permission on task categories.
| id required | integer Example: 42 Unique task category identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query, create, update and delete travels, with customer, seller, situation and the period calculated from the linked sales, and link or unlink sales. The travel the credential created, or with a sale it created, is always its own; the ones of other sellers require the Consult sales of other sellers permission, as in Monde, also to update, delete and link (see the FAQ).
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.
| date_field | string Enum: "start_date" "end_date" Example: date_field=start_date 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. |
| date_from | string <date> Example: date_from=2024-01-01 Filter travels whose field chosen in date_field is on or after this date, in ISO 8601 format (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2024-12-31 Filter travels whose field chosen in date_field is on or before this date, in ISO 8601 format (YYYY-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing upcoming and finished travels.
{- "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"
}, - {
- "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": null,
- "created_at": "2024-01-10T09:00:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a travel in the company given in company_identifier, with the same rules as Monde: description (up to 60 characters), customer (customer_id, a person) and seller (seller_id, an active seller) are required. The seller comes in the body because the API credential is not a Monde user. The travel number is generated on save. The travel is created without sales: link them afterwards with POST /travels/{id}/sales/{sale_id}. Requires the "Edit" permission of Travels in the company. The travel created by the credential is its own: it updates, deletes and links sales to it without the Consult sales of other sellers permission. A travel created by another credential follows that permission, like those of other sellers.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ of the travel's company, digits only. A company where the credential has no permission at all is rejected as a CNPJ not found |
| description required | string <= 60 characters Travel description, up to 60 characters |
| customer_id required | string <uuid> ID of the person who is the travel customer, the same as in |
| seller_id required | string <uuid> ID of the travel seller, the same as in |
| observations | string Travel observations |
Array of objects (custom_field) Custom fields to fill in the travel, defined by the agency. The required ones must be sent on creation |
Travel with description, customer, seller and observations.
{- "company_identifier": "46598887000162",
- "description": "Lua de mel - Cancún",
- "customer_id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "seller_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "observations": "Cliente prefere assentos na janela."
}Newly created travel, still without linked sales: no dates and no situation.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "number": "000043",
- "description": "Lua de mel - Cancún",
- "situation": null,
- "start_date": null,
- "end_date": null,
- "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": null,
- "sales": [ ],
- "passengers": [ ],
- "attachments": [ ],
- "custom_fields": [ ]
}Returns a specific travel with its scalar fields, its attachments and the references to the linked sales and passengers. The amounts per passenger belong to each sale, retrieved through the sale endpoint.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the travel to retrieve |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example travel with references to the linked sales and passengers.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "number": "000042",
- "description": "Lua de mel - Cancún",
- "situation": "upcoming",
- "start_date": "2024-05-10",
- "end_date": "2024-05-24",
- "observations": "Cliente prefere assentos na janela.",
- "created_at": "2024-03-15T10:30:00",
- "customer": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Updates an existing travel. Send only the fields that should change: an omitted field stays as it is. The description, customer, seller and company, which a travel cannot be without, answer 422 when sent as null or as an empty text, as in tasks. Observations are the exception: sent as null, they are cleared. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). The company does not change after the travel is created, as in Monde: company_identifier is only accepted with the travel's own CNPJ. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission; without it, the travel answers 404. The response brings the updated travel in the same format as the get by ID when the credential can also query it; otherwise, the change is saved all the same and the response brings only the travel id.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the travel |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ of the travel's company, digits only. The company does not change after the travel is created: only the travel's own CNPJ is accepted |
| description | string <= 60 characters Travel description, up to 60 characters |
| customer_id | string <uuid> ID of the person who is the travel customer, the same as in |
| seller_id | string <uuid> ID of the travel seller, the same as in |
| observations | string or null Travel observations. Sent as null, they are cleared; an empty text is saved as sent |
Array of objects (custom_field) Travel custom fields, defined by the agency. Not replaced: each field sent overwrites its current value and the ones not sent stay as they are. A required field cannot be sent empty. Send each field by |
Only the fields sent change.
{- "description": "Lua de mel - Cancún e Tulum",
- "observations": "Incluir o passeio a Tulum."
}Example travel with references to the linked sales and passengers.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "number": "000042",
- "description": "Lua de mel - Cancún",
- "situation": "upcoming",
- "start_date": "2024-05-10",
- "end_date": "2024-05-24",
- "observations": "Cliente prefere assentos na janela.",
- "created_at": "2024-03-15T10:30:00",
- "customer": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Deletes the travel for good. The linked sales leave the travel first, and each one records the unlinking in its log. A travel with attachments, including the ones already deleted, is not deleted (409), as in Monde: permanently delete the attachments in Monde first. When the company of the travel is set to accept only sales registered within a travel, a travel with linked sales cannot be deleted through the API (409): in Monde, only the administrator deletes it. Requires the "Delete" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission; without it, the travel answers 404.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the travel |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Links the sale to the travel, like the Link sale button in Monde. As in Monde, the credential must be able to open the sale: one it created or, for a sale of another seller, with the View and Open sales of other sellers permissions of Sales. A sale the credential cannot open, or of another company, answers 404, as nonexistent. A deleted sale, or one without any active product, answers 422. A sale already in this travel answers 409. A sale in another travel is moved to this one, as in Monde, without checking the credential access to the origin travel, and its leaving is recorded in the origin travel log. The link is recorded in the travel log and in the sale log. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission. The response brings the travel with the updated list of sales, or only its id to a credential that cannot query it.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the travel |
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the sale |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
Example travel with references to the linked sales and passengers.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "number": "000042",
- "description": "Lua de mel - Cancún",
- "situation": "upcoming",
- "start_date": "2024-05-10",
- "end_date": "2024-05-24",
- "observations": "Cliente prefere assentos na janela.",
- "created_at": "2024-03-15T10:30:00",
- "customer": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Removes the sale from the travel, and the unlinking is recorded in the travel log and in the sale log. A sale that is not in this travel, or that the credential cannot open (as in the link), answers 404. When the travel's company is set to accept only sales registered within a travel, the sale cannot be unlinked through the API (409): in Monde, only the administrator unlinks it; link it to another travel to move it. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the travel |
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the sale |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query, create, update, duplicate and delete the quotes registered in the system, with validity, status and the public viewing link.
Returns the list of quotes from the companies where the credential has permission.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing active and disabled quotes.
{- "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,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00"
}, - {
- "id": 41,
- "title": "Buenos Aires",
- "subtitle": "Feriado prolongado",
- "details": "Aéreo + hotel 4 estrelas no centro.",
- "valid_until": "2024-02-28",
- "active": false,
- "internal_observations": null,
- "cover_kind": "none",
- "cover_color": null,
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-01-10T09:00:00",
- "updated_at": "2024-01-12T14:20:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a quote in the company given in company_identifier, with the rules of the Quotes screen of Monde Web. The quote owner (user_id) is required, because the API credential is not a Monde user: the owner is who sees, changes and deletes the quote in Monde, besides the administrators. Title and validity (valid_until) are required, and the validity cannot be in the past. Without a cover, the quote is created with the color cover, in the primary color of the company's Quote Settings, showing the title and the subtitle. Without details, the content starts from the content template of the company, the one saved by the administrator on the Quote Settings screen of Monde Web or, when the company never saved its settings, the default template. The quote is created active, unless active is sent as false, and already has the public link in public_url. Requires the create/edit quotes permission in the company.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ of the company where the quote will be created, digits only. The company cannot be read only. A company where the credential has no permission at all is refused as a CNPJ not found. |
| user_id required | string <uuid> Identifier of the user who owns the quote, the same person |
| person_id | string <uuid> Identifier of the quote's person (customer), from List people. Optional. Sending a person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist. |
| title required | string Quote title |
| subtitle | string Quote subtitle. Optional. |
| valid_until required | string <date> Quote validity date (YYYY-MM-DD). Cannot be in the past. |
| details | string Quote content, in HTML. The HTML is cleaned before saving, with the same rules as the guides content. Optional: on creation, without it the content template of the company is used, the one saved by the administrator on the Quote Settings screen of Monde Web; sent as an empty text, the quote has no content. |
| active | boolean Default: true Indicates whether the quote is active |
| internal_observations | string Internal observations (not shown in the public link) |
| cover_kind | string Enum: "color" "image" "none" Public link cover: |
| cover_color | string Cover background color, in hexadecimal ( |
| cover_show_title | boolean Shows the title on the cover. On the |
| cover_show_subtitle | boolean Shows the subtitle on the cover. On the |
Example of creating a quote with a person and internal notes.
{- "company_identifier": "46598887000162",
- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "person_id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "valid_until": "2035-05-31",
- "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_color": "#1f4e79"
}Example response for a specific quote.
{- "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,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Returns a specific quote by its identifier.
| id required | integer Example: 42 Unique identifier of the quote |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific quote.
{- "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,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Changes an existing quote. Send only the fields that must change: a field omitted stays as it is, and a field sent as null is removed. The optional person (person_id), subtitle (subtitle), content (details) and internal notes (internal_observations) sent as null are cleared. A null cover color (cover_color) is only accepted outside the color cover. What a quote cannot be without — title, valid_until, active, user_id, company_identifier, cover_kind, cover_show_title and cover_show_subtitle — cannot be removed: sent as null, it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). As in the Monde Web screen, the quote is only saved with a validity from today on: an expired quote needs a new valid_until in any change. An image taken out of the content (details) no longer belongs to the quote and is deleted one hour later. With company_identifier, the quote moves to that company, which also requires the create/edit quotes permission there. The owner must have access to the target company: without user_id, the quote only moves when the current owner also has access to it; otherwise the change is refused (422), and an owner with access must be sent in user_id. Requires the create/edit quotes permission in the quote's company. The response brings the changed quote in the same format as the read by ID when the credential also has the "Read all quotes" permission in its company; without it, the change is saved the same way and the response brings only the id.
| id required | integer Example: 42 Unique identifier of the quote |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ of the company the quote moves to, digits only. Omitted keeps the current company; null or empty is refused. A company where the credential has no permission at all is refused as a CNPJ not found. |
| user_id | string <uuid> Identifier of the user who owns the quote, the same person |
| person_id | string or null <uuid> Identifier of the quote's person (customer), from List people. Null removes the person from the quote, and an empty text is refused (422); omitted keeps the current one. Sending a person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist. |
| title | string Quote title |
| subtitle | string or null Quote subtitle. Optional. |
| valid_until | string <date> Quote validity date (YYYY-MM-DD). Cannot be in the past. |
| details | string or null Quote content, in HTML. The HTML is cleaned before saving, with the same rules as the guides content. Optional: on creation, without it the content template of the company is used, the one saved by the administrator on the Quote Settings screen of Monde Web; sent as an empty text, the quote has no content. |
| active | boolean Indicates whether the quote is active |
| internal_observations | string or null Internal notes (not shown on the public link). Null clears the field, and an empty text is saved as sent; omitted keeps what the quote has. |
| cover_kind | string Enum: "color" "image" "none" Public link cover: |
| cover_color | string or null Cover background color, in hexadecimal ( |
| cover_show_title | boolean Shows the title on the cover. On the |
| cover_show_subtitle | boolean Shows the subtitle on the cover. On the |
Example of an update that changes only the subtitle and the validity, keeping the other fields.
{- "subtitle": "Lua de mel - 10 noites",
- "valid_until": "2035-06-15"
}Example response for a specific quote.
{- "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,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Deletes the quote for good, with its images. The public link stops working and the quote cannot be recovered. Requires the delete quotes permission in the quote's company.
| id required | integer Example: 42 Unique identifier of the quote |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Creates a copy of the quote, like the Duplicate action of the Quotes screen of Monde Web. The copy is created in the same company, with the same subtitle, content, images, cover, status and internal notes, the title prefixed with "(cópia)" and a new public link. The person and the validity are not copied: the validity (valid_until) is required and the person (person_id) is optional. The copy owner (user_id) is also required. Requires the create/edit quotes permission in the quote's company. The response brings the copy in the same format as the read by ID when the credential also has the "Read all quotes" permission in the company; without it, the copy is created the same way and the response brings only its id.
| id required | integer Example: 42 Unique identifier of the quote |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| user_id required | string <uuid> Identifier of the user who owns the copy, the same person |
| valid_until required | string <date> Quote validity date (YYYY-MM-DD). Cannot be in the past. |
| person_id | string <uuid> Identifier of the copy's person (customer), from List people. Optional: without it, the copy has no person. Sending a person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist. |
Example of a duplication with the new validity and another person.
{- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "valid_until": "2035-07-31",
- "person_id": "7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f"
}Example of a response with the created copy.
{- "id": 43,
- "title": "(cópia) Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
- "valid_until": "2035-07-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-04-02T11:00:00",
- "updated_at": "2024-04-02T11:00:00",
- "person": {
- "id": "7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}List, create, update, duplicate, and delete the agency's travel guides: HTML content with a public viewing link, like the quotes one, but without a linked person and without a validity date. Guides are a feature of the Monde Pro license and exist only in the companies that purchased it. With a read-only Monde Pro license, the company's guides are read, but not created, updated, duplicated, or deleted.
Returns the list of guides from the companies where the credential has permission, from the most recently updated to the oldest.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing an active and a deactivated guide.
{- "data": [
- {
- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00"
}, - {
- "id": 41,
- "title": "Buenos Aires",
- "subtitle": "Feriado prolongado",
- "details": "<p>Tango em San Telmo e jantar em Puerto Madero.</p>",
- "active": false,
- "internal_observations": null,
- "cover_kind": "color",
- "cover_color": "#5f6777",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-01-10T09:00:00",
- "updated_at": "2024-01-12T14:20:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a guide in the company given in company_identifier. The guide owner (user_id) is required, because the API credential is not a Monde user: the owner is who updates and deletes the guide in Monde, besides the administrators. Only the title is required. Without a cover, the guide gets the color cover, in #5f6777, with the title and the subtitle. The guide is created active, unless active is sent as false, and already with the public link in public_url. Requires the create/edit guides permission in the company.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ of the company where the guide will be created, digits only. The company must have the Monde Pro license, and neither the company nor the Monde Pro license can be read-only. A company where the credential has no permission at all is rejected as a CNPJ not found. |
| user_id required | string <uuid> Identifier of the user who owns the guide, the same person |
| title required | string Guide title |
| subtitle | string Guide subtitle. Optional. |
| details | string Guide content, in HTML. The HTML is cleaned before it is saved: paragraphs, headings, lists, tables, links, bold, italic, quotes, and code pass, and everything else becomes text or is discarded. A guide has two heading levels, |
| active | boolean Default: true Whether the guide is active. The public link only opens an active guide. Once deactivated, the guide leaves the trips that show it in the passenger app and does not return to them when reactivated. |
| cover_kind | string Enum: "color" "image" "none" "default" Cover of the public link: |
| cover_color | string Background color of the cover, in hexadecimal ( |
| cover_show_title | boolean Shows the title on the cover. Always |
| cover_show_subtitle | boolean Shows the subtitle on the cover. On the |
| hide_cover_text | boolean Kept for existing API users: |
| internal_observations | string Internal observations (not shown on the public link) |
Example of creating a guide with internal observations.
{- "company_identifier": "46598887000162",
- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "internal_observations": "Enviar junto com o voucher.",
- "cover_color": "#1f4e79"
}Example response of a specific guide.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Returns a specific guide by its identifier.
| id required | integer Example: 42 Unique guide identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a specific guide.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Updates an existing guide. Send only the fields that should change: a field that is omitted stays as it is, and a field sent as null is removed. The optional subtitle (subtitle), content (details) and internal observations (internal_observations) sent as null are cleared. A null cover color (cover_color) without cover_kind is refused on a guide with the color cover; with cover_kind color, it becomes the default #5f6777 tone. What a guide cannot be without — title, active, user_id, company_identifier, cover_kind, hide_cover_text, cover_show_title and cover_show_subtitle — cannot be removed: sent as null, it is rejected (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). An image taken out of the content (details) no longer belongs to the guide and is deleted one hour later. With company_identifier, the guide moves to that company, which also requires the create/edit guides permission there. The owner must have access to the target company: without user_id, the guide only moves when the current owner also has access to it; otherwise the change is refused (422), and an owner with access must be sent in user_id. Requires the create/edit guides permission in the guide's company. The response returns the updated guide in the same format as the query by ID when the credential also has the "Read all guides" permission in the guide's company; without it, the update is written all the same and the response returns only the id of the guide.
| id required | integer Example: 42 Unique guide identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ of the company the guide moves to, digits only. Omitted, it keeps the current company; null or empty is refused. A company where the credential has no permission at all is rejected as a CNPJ not found. |
| user_id | string <uuid> Identifier of the user who owns the guide, the same person |
| title | string Guide title |
| subtitle | string or null Guide subtitle. Optional. |
| details | string Guide content, in HTML. The HTML is cleaned before it is saved: paragraphs, headings, lists, tables, links, bold, italic, quotes, and code pass, and everything else becomes text or is discarded. A guide has two heading levels, |
| active | boolean Whether the guide is active. The public link only opens an active guide. Once deactivated, the guide leaves the trips that show it in the passenger app and does not return to them when reactivated. |
| cover_kind | string Enum: "color" "image" "none" "default" Cover of the public link: |
| cover_color | string or null Background color of the cover, in hexadecimal ( |
| cover_show_title | boolean Shows the title on the cover. Always |
| cover_show_subtitle | boolean Shows the subtitle on the cover. On the |
| hide_cover_text | boolean Kept for existing API users: |
| internal_observations | string or null Internal observations (not shown on the public link). Null clears the field, and an empty text is saved as sent; omitted, it keeps what the guide has. |
Example of an update that changes only the title and the subtitle, keeping the other fields.
{- "title": "Lisboa e Sintra",
- "subtitle": "Roteiro de 6 dias"
}Example response of a specific guide.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Deletes the guide permanently, along with its images. The public link stops working, the guide leaves the trips that show it in the passenger app, and it cannot be recovered. Requires the delete guides permission in the guide's company.
| id required | integer Example: 42 Unique guide identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Creates a copy of the guide, like the Duplicate action of the Guides screen of Monde Web. The copy is created in the same company, with the same subtitle, content, images, cover, status and internal notes, the title prefixed with "(cópia)" and a new public link. The copy owner (user_id) is required. Requires the create/edit guides permission in the guide's company. The response brings the copy in the same format as the read by ID when the credential also has the "Read all guides" permission in the company; without it, the copy is created the same way and the response brings only its id.
| id required | integer Example: 42 Unique guide identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| user_id required | string <uuid> Identifier of the user who owns the copy, the same person |
Example of a duplication informing the copy owner.
{- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Example of a response with the created copy.
{- "id": 43,
- "title": "(cópia) Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-04-02T11:00:00",
- "updated_at": "2024-04-02T11:00:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Query the billing rules, with the rule owner, closing period and due date conditions. Rules apply to the whole agency, with no company.
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.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing supplier and client rules.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Faturamento semanal aéreo",
- "person_kind": "supplier",
- "destination": "national",
- "movement": "to_pay",
- "cost_center": null,
- "closing": {
- "period_kind": "weekly",
- "week_start": "monday",
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_checkin"
}, - "due_date": {
- "days_to_skip": 5,
- "on_weekend": "stay"
}
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Cliente corporativo mensal",
- "person_kind": "customer",
- "destination": "every",
- "movement": "every_movement",
- "cost_center": "Comercial",
- "closing": {
- "period_kind": "monthly",
- "week_start": null,
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_sale_date"
}, - "due_date": {
- "days_to_skip": 10,
- "on_weekend": "next"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific billing rule by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the billing rule |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific billing rule.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Faturamento semanal aéreo",
- "person_kind": "supplier",
- "destination": "national",
- "movement": "to_pay",
- "cost_center": null,
- "closing": {
- "period_kind": "weekly",
- "week_start": "monday",
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_checkin"
}, - "due_date": {
- "days_to_skip": 5,
- "on_weekend": "stay"
}, - "person": null,
- "product": null,
- "supplier": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "requester": null
}Query the vendor integrations, which import the sales made in the vendor's system. The vendor's secrets (password, token, API keys and PIN) are never returned: the query only says whether they are filled.
Returns the list of integrations from the companies where the credential has permission (integrations without a company apply to all of them). The additional fields, with the vendor access data, are only in the query by ID.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing vendor and searcher integrations.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Assist Card Matriz",
- "active": true,
- "vendor_id": "b2359357-cff7-4d43-b6d2-99adf2ff373b",
- "vendor_name": "Assist Card"
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Argo Buscador",
- "active": false,
- "vendor_id": "31d759f3-ee91-4a10-8432-0f76b40cd11e",
- "vendor_name": "Argo IT"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific integration by its identifier, with the additional fields the vendor declares. Only the service address and the agency's identification at the vendor come back with a value. The other fields, such as user, password, token, API keys and PIN, are never returned: filled says whether they are filled.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Integration unique identifier |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response of a specific integration, with the user and the password omitted.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Assist Card Matriz",
- "active": true,
- "vendor_id": "b2359357-cff7-4d43-b6d2-99adf2ff373b",
- "vendor_name": "Assist Card",
- "person": {
- "id": "5c4b3a29-1807-4f6e-9d5c-4b3a29180706"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "additional_fields": [
- {
- "name": "agency_code",
- "type": "text",
- "value": "1000",
- "filled": true
}, - {
- "name": "user",
- "type": "text",
- "value": null,
- "filled": true
}, - {
- "name": "pass",
- "type": "password",
- "value": null,
- "filled": true
}
]
}Query the people registered in the system, with contact data, documents, and additional information.
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}).
| name | string Example: name=Maria da Silva Filters by name, case-, accent- and position-insensitive (substring match). |
| cpf_cnpj | string Example: cpf_cnpj=38107867807 Filters by CPF or CNPJ (matches either one). Provide digits only, without dots, slashes, dashes or spaces. |
| passport_number | string Example: passport_number=FG225776 Filters by passport number, case- and accent-insensitive (substring match). |
| phone | string Example: phone=11934567890 Filters by any of the phone numbers (landline, business or mobile). Provide digits only; matches any part of the stored number, regardless of formatting. |
| kind | string Enum: "individual" "company" Example: kind=individual Filters by person kind: |
| code | integer Example: code=1024 Filters by the person's sequential code (exact match). |
string Example: email=contato@exemplo.com Filters by email, case- and accent-insensitive (substring match). | |
| label_id | string <uuid> Example: label_id=2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 Filters the people who have the given label (UUID, the |
| birthday_from | string <date> Example: birthday_from=2026-12-28 Start of the birthday window (YYYY-MM-DD). Returns the people whose birth day and month fall between |
| birthday_to | string <date> Example: birthday_to=2027-01-05 End of the birthday window (YYYY-MM-DD), inclusive. See |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example query response containing an individual and a legal person.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null
}, - {
- "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": null,
- "birthdate": null,
- "rg_ie": "9012345678",
- "city_inscription": "1234567",
- "tax_identification_number": null,
- "passport_number": null,
- "passport_expiration_date": null,
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@operadora.com.br",
- "phone_number": "4133334444",
- "mobile_number": null,
- "business_phone": null,
- "cvc_code": null,
- "observations": null,
- "charge_billet_fee": true,
- "created_at": "2019-04-18T08:15:00",
- "address": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": null,
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": null,
- "last_contacts": {
- "first_sale_date": null,
- "last_sale_date": null,
- "last_departure_date": null,
- "last_return_date": null,
- "last_task_update_at": null
}, - "tax_withholding": {
- "iss": true,
- "ir": false,
- "pis_cofins_csll": false
}, - "airline": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates an individual or a legal person. Every request creates a new registration: the external_id, when provided, must be free, and the CPF/CNPJ cannot belong to any person already registered. The response returns the created person in the same format as the get by ID. Sending seller also requires the "Change seller" permission, and promoter, the "Change promoter" one, as in Monde; without it, the answer is 403. Sending credit_cards or kandir_law also requires the "View financial tab" permission on people, and adding cards, the "Register credit card" one, as in Monde, where the cards and the Kandir law sit on the Financial tab of the person; without it, the answer is 403 with the Monde message. Without "View financial tab", the response does not bring credit_cards nor kandir_law, and without "View credit card data", it does not bring credit_cards: the field does not come.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| person_kind required | string Enum: "individual" "company" Indicates whether it is a person (individual) or legal entity (company). |
| external_id | string <= 50 characters 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. |
| name required | string <= 100 characters Name or trade name, according to the person kind. |
| legal_name | string or null <= 100 characters Legal name. |
| gender | string or null Enum: "female" "male" null Gender. |
| birthdate | string or null <date> Birthdate in ISO 8601 format (YYYY-MM-DD). |
| cpf_cnpj | string [ 11 .. 14 ] characters Brazilian Individual Taxpayer Registry (CPF) or National Registry of Legal Entities (CNPJ), according to the person kind, without dots, slashes, dashes or spaces. |
| rg_ie | string or null <= 20 characters Brazilian Identity Card (RG) or Brazilian State Registration (IE), according to the person kind, without dots, dashes, or spaces. |
| passport_number | string or null <= 20 characters Passport number, without dots, dashes, or spaces. |
| passport_expiration_date | string or null <date> Passport expiration date in ISO 8601 format (YYYY-MM-DD). |
| foreigner | boolean Default: false Indicates whether the person or company is foreign. Use |
| foreign_identity_document | string or null <= 30 characters Identity document of the foreigner, issued in their country of origin. Without dots, dashes or spaces. |
| business_phone | string or null <= 20 characters Business phone |
object or null (person_birthplace) Place of birth: the city where the person was born. Provide the IBGE code or, when it is not available, the city name with state and country. Without the IBGE code, the city is looked up by name, ignoring accents and case, among the cities the agency can use: in Brazil, in the state; abroad, in the country. The city is not registered: a name that matches none is refused (422). | |
object or null (person_additional_data) Additional data of the individual person. Absent (null) for legal person. | |
| website | string or null <= 50 characters Website (legal person) |
| tax_identification_number | string or null <= 20 characters Tax identification number (foreign legal person) |
object or null (person_tax_withholding) Tax withholdings of the legal person. Absent (null) for individual person. | |
object or null (person_airline) Airline data of the legal person (suppliers). Absent (null) for individual person. | |
string or null <= 200 characters Email address. | |
| phone_number | string or null <= 20 characters Phone number, without dashes or spaces. For international numbers, use + and the country code. |
| mobile_number | string or null <= 20 characters Mobile phone number, without dashes or spaces. For international numbers, use + and the country code. |
object or null Address. | |
| city_inscription | string or null <= 15 characters City inscription |
| observations | string or null Person observations |
| charge_billet_fee | boolean Default: false Indicates whether the bank slip fee is charged to the person |
object (entity_reference) Seller responsible for the person | |
object (entity_reference) Person promoter (operator plans) | |
Array of objects (entity_reference) Labels assigned to the person. | |
Array of objects (person_contact) People linked to this registration as contacts. Each person must already be registered and cannot repeat in the list. | |
Array of objects (person_custom_field) Custom fields of people, defined by the agency. Send each field by | |
Array of objects (person_credit_card_write) Credit cards of the person, individual or company. The number and the security code are stored encrypted and never come back in the response, which brings only the last four digits. The card is valid until the last day of the expiration month, and an expired card is refused. Requires the "View financial tab" and "Register credit card" permissions on people. | |
Array of objects (person_cost_center_write) Cost centers of the corporate client: its departments accepted in the cost center of the passenger and of the invoice item when it is the payer. They are not the cost centers of the agency, from | |
Array of objects (person_kandir_law_write) Kandir law withholdings (Brazilian law 9,430/1996, art. 64) of the company, one per product, in the same format as the get by ID. Only the active Airfare, Travel Insurance and Ground Transportation products accept a withholding. A percentage left out is zero, and a negative one is refused. The |
Example of an individual person registration with address, place of birth, documents and parentage.
{- "person_kind": "individual",
- "external_id": "CRM-4471",
- "name": "Maria da Silva",
- "cpf_cnpj": "38107867807",
- "rg_ie": "461196037",
- "gender": "female",
- "birthdate": "1990-02-12",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "email": "maria@exemplo.com",
- "phone_number": "1134567890",
- "mobile_number": "11934567890",
- "business_phone": "1134567891",
- "city_inscription": "123456789",
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308"
}, - "birthplace": {
- "city_ibge": "3550308"
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP",
- "rg_issue_date": "2010-03-01",
- "birth_certificate": "093456 01 55 2010 1 00123 456 7890123-45",
- "mother_name": "Joana da Silva"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "expiration_month": 5,
- "expiration_year": 2032
}, - {
- "number": "5555555555554444",
- "name": "MARIA S SOUZA",
- "issuer": "MasterCard",
- "expiration_month": 8,
- "expiration_year": 2031
}
]
}Example of the complete individual person, with the grouped blocks and the weak entities.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "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",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Returns the full data of a person by its identifier, including the grouped blocks (additional data, last contacts, withholdings, and airline) and the weak entities (contacts, labels, custom fields, attachments, credit cards (always masked), and Kandir Law tax withholding). Like the Financial tab in Monde, credit_cards and kandir_law only come with the "View financial tab" permission on people, and credit_cards, also with the "View credit card data" one. Without the permission, the field does not come: it is left out, not sent as null.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of the complete individual person, with the grouped blocks and the weak entities.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "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",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Updates a person already registered. Send only the fields that must change: a field left out stays as it is, and a field sent as null is removed. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422), the codes that locate the city (city_ibge, city_name, state_code, country_code) and the code of airline, which is unique among people, included. An object sent as null removes everything it writes (address, birthplace, additional_data, airline), and a null field inside it, only that data; the city is removed when city_ibge and city_name come null. A null seller or promoter removes the seller or the promoter. These cannot be removed, and sending them as null is refused (422): name, person_kind, foreigner, charge_billet_fee, the external_id (it can be replaced by another one, but not removed), the tax_withholding flags and, when the person is a Monde user, the email. The kind of the person does not change: person_kind, when provided, must be the one the person already is. The external_id starts identifying the person, as long as it does not identify another one; the CPF/CNPJ and the airline code cannot belong to another person. As in Monde, the stored CPF/CNPJ is checked on every update: on a person with an invalid document, the update answers 422 on the cpf_cnpj field until it is sent corrected, or null to remove it. When the person is a Monde user, the email cannot be the one of another user either. The labels, contacts, credit_cards, cost_centers and kandir_law lists work by replacement: the list sent becomes the list of the person, an empty or null list removes every item and leaving the field out keeps the current ones. Custom fields do not replace: every one sent is written over the current value, one sent with a null or empty value is cleared (a required one is refused), and the remaining ones stay. The response returns the updated person in the same format as the get by ID when the credential also has the "View" permission on people; without it, the update is written all the same and the response returns only the id of the person. A person that is a company of the system and the email of a person that is an active Monde user are only changed by an administrator, as in Monde: the update answers 403 with the reason. Changing or removing (null) seller also requires the "Change seller" permission, and changing or removing promoter, the "Change promoter" one; the one resent equal to the current one, and a null one on a person without seller or promoter, ask no permission. Sending credit_cards or kandir_law with some item, or empty or null when they remove what the person has, also requires the "View financial tab" permission on people, and each card operation, its own permission, as in Monde: adding a card (item without id) requires "Register credit card"; changing a card (item with id and some field different from the stored one, or with number or cvv, which always count as a change; one resent as the query returns it asks nothing) requires "View credit card data" and "Edit credit card"; and a list that leaves out a card the person has, removing it, requires "Remove credit card". A card cited only by its id stays as it is and asks no permission of its own. Without the permission, the answer is 403 with the Monde message, and nothing is changed. In the response, without "View financial tab", credit_cards and kandir_law do not come, and without "View credit card data", credit_cards does not come: the field is left out, not sent as null.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| person_kind | string Enum: "individual" "company" Indicates whether it is a person (individual) or legal entity (company). |
| external_id | string <= 50 characters 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. |
| name | string <= 100 characters Name or trade name, according to the person kind. |
| legal_name | string or null <= 100 characters Legal name. |
| gender | string or null Enum: "female" "male" null Gender. |
| birthdate | string or null <date> Birthdate in ISO 8601 format (YYYY-MM-DD). |
| cpf_cnpj | string [ 11 .. 14 ] characters Brazilian Individual Taxpayer Registry (CPF) or National Registry of Legal Entities (CNPJ), according to the person kind, without dots, slashes, dashes or spaces. |
| rg_ie | string or null <= 20 characters Brazilian Identity Card (RG) or Brazilian State Registration (IE), according to the person kind, without dots, dashes, or spaces. |
| passport_number | string or null <= 20 characters Passport number, without dots, dashes, or spaces. |
| passport_expiration_date | string or null <date> Passport expiration date in ISO 8601 format (YYYY-MM-DD). |
| foreigner | boolean Default: false Indicates whether the person or company is foreign. Use |
| foreign_identity_document | string or null <= 30 characters Identity document of the foreigner, issued in their country of origin. Without dots, dashes or spaces. |
| business_phone | string or null <= 20 characters Business phone |
object or null (person_birthplace) Place of birth: the city where the person was born. Provide the IBGE code or, when it is not available, the city name with state and country. Without the IBGE code, the city is looked up by name, ignoring accents and case, among the cities the agency can use: in Brazil, in the state; abroad, in the country. The city is not registered: a name that matches none is refused (422). | |
object or null (person_additional_data) Additional data of the individual person. Absent (null) for legal person. | |
| website | string or null <= 50 characters Website (legal person) |
| tax_identification_number | string or null <= 20 characters Tax identification number (foreign legal person) |
object or null (person_tax_withholding) Tax withholdings of the legal person. Absent (null) for individual person. | |
object or null (person_airline) Airline data of the legal person (suppliers). Absent (null) for individual person. | |
string or null <= 200 characters Email address. | |
| phone_number | string or null <= 20 characters Phone number, without dashes or spaces. For international numbers, use + and the country code. |
| mobile_number | string or null <= 20 characters Mobile phone number, without dashes or spaces. For international numbers, use + and the country code. |
object or null Address. | |
| city_inscription | string or null <= 15 characters City inscription |
| observations | string or null Person observations |
| charge_billet_fee | boolean Default: false Indicates whether the bank slip fee is charged to the person |
entity_reference (object) or null Seller responsible for the person | |
entity_reference (object) or null Person promoter (operator plans) | |
Array of objects or null (entity_reference) Labels of the person. The list sent replaces the current one: a label left out of it is removed. Send an empty or null list to remove every label; leave the field out to keep the current ones. Each label must already be registered. | |
Array of objects or null (person_contact) People linked to this registration as contacts. The list sent replaces the current one: a contact left out of it is undone. The role of each contact is the one that comes in the list: leaving it out leaves the contact with no role. Send an empty or null list to undo every contact; leave the field out to keep the current ones. Each person must already be registered and cannot repeat in the list. The links in which this person is the contact of somebody else are not affected. | |
Array of objects (person_custom_field) Custom fields of people, defined by the agency. Unlike the other lists, it does not replace: every field sent is written over the current value and the ones left out stay as they are, so an empty or null list changes nothing. A field sent with a null or empty | |
Array of objects or null (person_credit_card_write) Credit cards of the person. The list sent replaces the current one: since the read does not return the number, a card the person already has is cited by its | |
Array of objects or null (person_cost_center_write) Cost centers of the corporate client (not the ones of the agency, from | |
Array of objects or null (person_kandir_law_write) Kandir law withholdings of the company, one per product. The list sent replaces the current one: the product identifies the withholding, so a product the person already has changes its withholding, and the group, scope and tax left out stay as they are (a percentage sent null is refused); a new product adds a withholding, with the percentages left out set to zero; a withholding left out of the list is deleted. Send an empty or null list to delete them all; leave the field out to keep the current ones. Requires the "View financial tab" permission on people when it brings some withholding or removes the ones the person has. |
Example of updating the contact details, address, labels and custom fields of a person already registered.
{- "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"
}
]
}Example of the complete individual person, with the grouped blocks and the weak entities.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "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",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Returns the individual's photo (or the company's logo) as an image, with the Content-Type of the stored format. Requires the permission to read people. This call does not require the Content-Type header.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}Stores the individual's photo (or the company's logo), replacing any existing one. The image goes in the file field of a multipart/form-data request and must be a JPEG of up to 150 KB, the same limits as Monde, which only displays images in that format. Requires the permission to edit people, in a company that is not read-only. The change is recorded in the person's history.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "multipart/form-data" Example: multipart/form-data Request content type. Must be multipart/form-data. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| file required | string <binary> The image, as JPEG, up to 150 KB. |
Example of the complete individual person, with the grouped blocks and the weak entities.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "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",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Removes the individual's photo (or the company's logo). Requires the permission to edit people, in a company that is not read-only. The removal is recorded in the person's history.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Converts the person into the kind given in person_kind, like the Converter para Pessoa Jurídica / Converter para Pessoa Física action of Monde's people list. Data that only the original kind has is erased: converting to a company erases CPF, RG, gender, business phone, passport and its expiration, RG issuer and issue date, and birthplace; converting to an individual erases CNPJ, state registration, legal name and website. A system user cannot become a company, and a system company does not change kind. Requires the permission to edit people, in a company that is not read-only. The kind does not change through Update person, only here.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique person identifier (UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| person_kind required | string Enum: "individual" "company" Target kind: |
{- "person_kind": "company"
}Example of the complete individual person, with the grouped blocks and the weak entities.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "code": 1042,
- "person_kind": "individual",
- "name": "Carlos Souza",
- "legal_name": null,
- "cpf_cnpj": "12345678909",
- "gender": "male",
- "birthdate": "1985-07-22",
- "rg_ie": "203456789",
- "city_inscription": null,
- "tax_identification_number": null,
- "passport_number": "BR123456",
- "passport_expiration_date": "2028-10-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "carlos@exemplo.com.br",
- "phone_number": "4133334444",
- "mobile_number": "41999998888",
- "business_phone": "4130302020",
- "website": null,
- "cvc_code": null,
- "observations": "Cliente preferencial.",
- "charge_billet_fee": false,
- "created_at": "2021-11-05T10:30:00",
- "address": {
- "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": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "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": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "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",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Query, create, change and delete the labels used to classify people. There is a single label registry for the whole system, with no company: the permissions apply in any active company where they are granted, and writing requires a company that is not read only.
Returns the list of labels registered in the system.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing every registered label.
{- "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": null
}
}Creates a label. The name is required, has up to 38 characters and cannot repeat the name of another label. Requires the "Edit" permission on labels.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name required | string <= 38 characters Label name, with up to 38 characters and different from the name of the other labels |
Creates the VIP label.
{- "name": "VIP"
}Example response for a specific label.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Returns a specific label by its identifier.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the label |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific label.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Renames a label. A name omitted stays as it is; sent as null or as an empty text, it is rejected (422), as a label cannot be left without a name. The new name follows the same rules as the creation, and the people that have the label keep it. Requires the "Edit" permission on labels. The response brings the changed label when the credential also has the "View" permission on labels; without it, the change is saved all the same and the response brings only the label id.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the label |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| name | string <= 38 characters Label name, with up to 38 characters and different from the name of the other labels |
Changes the label name.
{- "name": "Cliente VIP"
}Example response for a specific label.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Deletes the label permanently and removes it from every person that had it, as the deletion in Monde does. The deletion cannot be undone. Requires the "Delete" permission on labels.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Unique identifier of the label |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Query the system companies the credential reaches: the active companies where it has the "Read all companies" permission. This is where the CNPJ that writes ask for in company_identifier comes from.
Returns the active companies where the credential has the "Read all companies" permission, in alphabetical order of the name. A read only company is in the list, flagged in read_only: it is still queried, but it rejects writes.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with the companies the credential reaches, one of them read only.
{- "data": [
- {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10",
- "name": "Monde Viagens",
- "legal_name": "Monde Viagens e Turismo Ltda",
- "cnpj": "46598887000162",
- "read_only": false,
- "person": {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10"
}
}, - {
- "id": "4c7e2b19-0a3d-4f6e-8b51-2d9c6a7e1f30",
- "name": "Monde Viagens Filial",
- "legal_name": "Monde Viagens Filial Ltda",
- "cnpj": "11222333000181",
- "read_only": true,
- "person": {
- "id": "4c7e2b19-0a3d-4f6e-8b51-2d9c6a7e1f30"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific company by its identifier. Requires the "Read all companies" permission in the company itself, which must be active. A company out of that reach answers 403, also when the id does not exist.
| id required | string <uuid> Example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10 Unique identifier of the company |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response for a specific company.
{- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10",
- "name": "Monde Viagens",
- "legal_name": "Monde Viagens e Turismo Ltda",
- "cnpj": "46598887000162",
- "read_only": false,
- "person": {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10"
}
}Query and create the accounts payable and receivable (financial entries) of the companies where the credential has permission. The same resource covers both cases: accounts receivable (transaction_kind = credit) and accounts payable (transaction_kind = debit). It brings identification, values, status, categories, apportionments, settlement movements, items, commissions, attachments and custom fields. The entry the credential created is always its own; the ones of other users require the access to the entries of all users, or its slice, as in Monde (see the FAQ).
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}.
| date_field | string Enum: "issue_date" "due_date" "settlement_date" Example: date_field=due_date 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. |
| date_from | string <date> Example: date_from=2024-01-01 Filter bills whose field chosen in date_field is on or after this date, in ISO 8601 format (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2024-12-31 Filter bills whose field chosen in date_field is on or before this date, in ISO 8601 format (YYYY-MM-DD). |
| transaction_kind | string Enum: "credit" "debit" Example: transaction_kind=credit Filters by the nature of the entry: |
| kind | string Enum: "normal" "sale_payment" "sale_standalone" "vendor_standalone" "vendor_invoice" "customer_invoice" "credit_card_invoice" "commission" Example: kind=customer_invoice Origin of the entry.
|
| status | Array of strings Items Enum: "open" "overdue" "settled" "canceled" Example: status=open,overdue Filters by status. Accepts one or more comma-separated values:
open and overdue bills; settled and canceled bills are returned only when explicitly requested.
|
| recurrence_group_id | string <uuid> Example: recurrence_group_id=5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f Filters by the entries of an installment or recurrence series, by the |
| number | string Example: number=362 Filters by the bill number shown in the app (one per request). Installment bills carry a parcel suffix (e.g., |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response containing an account receivable (customer invoice) and an account payable (card invoice).
{- "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,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null
}, - {
- "id": "9f8e7d6c-5b4a-4938-8271-6f5e4d3c2b1a",
- "number": "67890",
- "transaction_kind": "debit",
- "kind": "credit_card_invoice",
- "description": "Fatura Mastercard",
- "document": null,
- "invoice_number": null,
- "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": null,
- "billet": null,
- "check": null,
- "card": {
- "brand": "MasterCard",
- "last_digits": "4117",
- "authorization": "600551159"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates an open or already settled financial entry, with the same rules as Monde's manual entry. transaction_kind sets whether it is an account receivable (credit) or payable (debit), and any category is accepted.
Categories and final amount. The signed sum of the categories is the final amount (final_amount): a category of the same kind as the entry adds, one of the opposite kind is deducted (the kind comes in kind, in List categories). If the final amount differs from amount, the difference is a surcharge or discount, subject to the company's surcharge and discount lock. The final amount cannot be negative, and the same category cannot repeat with the same description.
Apportionments. Travel agencies only. The cost center apportionment (apportionments.per_cost_center) may total between 0 and 100% of the final amount; the split between companies (apportionments.per_company), when sent, must total exactly 100% and only accepts companies where the credential can also create entries. For tour operators, apportionments and own operation are rejected.
Settlement. To create the entry already settled, send settlement_date with the movements, one per account the money entered or left. It also requires the "Settle account payable" or "Settle account receivable" permission, according to the entry, as in Monde; without it, the answer is 403. When the movements do not add up to the final amount, say what to do with the difference in balance_resolution, as in the settlement: with category, it goes to a category, as a discount (paid less) or surcharge (paid more), and the final amount becomes what was paid. The category comes in balance_category_id; without it, the company's default category for that case applies (discount given or received, surcharge charged or paid), and without a default the request is rejected. The category must be of the kind that brings the final amount to what was paid. Without balance_resolution, the movements must add up exactly to the final amount; a payment with interest or discount can also be sent by adjusting the categories. With partial, the partial payment, when less than the final amount was paid: the entry is settled with what was paid and gets the " 1/2" suffix in the description, and the balance becomes a new open entry, with the " 2/2" suffix and the same categories in the balance's proportion. As in Monde, both keep the same number in parts: entry 71 becomes 71-1 and the balance 71-2. An installment that already has a part in its number (72-2) keeps it, and the balance takes the next free part. With no balance, the partial payment generates nothing; an overpayment is rejected. partial_payment: true is still accepted and is the same as balance_resolution: partial; sent together, both must say the same, and a partial_payment that contradicts balance_resolution is rejected with 422. The settlement date cannot be later than the last movement date, and the issue date cannot be later than the settlement. Each movement uses an active account linked to the company, and the payment method follows the account kind: cash and check accounts accept cash or check, a credit card account accepts only credit card, and a checking account accepts the others. A check requires its number. Installments (installments) only in a credit card account. On accounts receivable the movement date lock applies, and a closed cash day rejects the movement with the reason (in Portuguese), such as O caixa do dia "10/10/2026" da conta "Caixa" está fechado.
Card fee. On an account receivable paid by credit or debit card into a checking account, send the card operator fee in card_rate, as in Monde: amount is what the customer paid, and the account receives amount less the fee. The sum of the fees becomes the card fee category configured in the company, which lowers the final amount; if that category is already in categories, the fee goes into it, and its amount becomes the sum of the fees. Without the category configured, the fee is rejected with 422, as is a fee on another payment method, on an account payable or outside a checking account, and a fee equal to or greater than amount. Example: an account receivable of R$ 420.00 with a R$ 20.00 fee: the movement has amount 420 and card_rate 20, the account receives R$ 400.00 and the final amount becomes R$ 400.00.
Card refund. An account receivable can also be settled in a credit card account, only with the credit card payment method: it is the refund, which goes into the card invoice and lowers its total, as in Monde. In installments, each installment goes into the invoice of its month.
Installments and recurrence. Send recurrence_kind with the periodicity. In installments (installment), installments is the total number of installments, from 2 to 200, and each installment repeats the entry's full amount: R$ 1,500.00 in 3 installments creates 3 entries of R$ 1,500.00. Installments fall due one per period from due_date, get the " 1/3" suffix in the description and -1 in the number; the description has up to 50 characters precisely so that suffix fits. The recurrence (recurrent) creates the entries for the next 5 years with the same amount and description, and Monde keeps creating the following ones. The fortnight (biweekly) is 15 days. The series is generated in the background, as in Monde: the response brings the first entry with recurrence_group_id already filled in, and the others show up shortly after in List accounts payable and receivable with the recurrence_group_id filter. Until the series is generated, the entry read by ID shows no recurrence_group_id, and recurrence_status tells whether it is still pending or the last attempt failed. The installment suffixes go into the description and number of every entry when the series is generated, the first one included. A partial payment and balance_resolution cannot be combined with installments or recurrence: the installments copy the first entry's categories, and the difference category belongs only to its settlement.
Company locks. Apply as configured in the company: the due date and movement date locks on accounts receivable, and the surcharge and discount lock. Only a credential with the "Ignore locks" permission in the company of the entry goes through them, as in Monde.
Defaults. Without issue_date, the issue date is the earliest of today, the due date and the settlement date; when sent, it cannot be later than the due date. Without account_id, the entry gets the company's default forecast account; a sale entry is left without a forecast account, as in Monde. The entry is always in BRL. Fields outside the contract are ignored.
Errors. An error on a field of a list item (categories, movements, custom_fields and the apportionments) carries the item position in the list sent, counted from 0: 'movements[1] account_id' refers to the second movement. Each item in error gets its own message. A rule checked over the whole list, such as the movements total or a repeated category, comes on the list name, without position. A format error on an item field also carries the position: check sent as text instead of an object answers The 'movements[0] check' field must be a list or an object….
Sale entry. To post an account payable or receivable on a sale, like the button on the sale Financial tab in Monde, send sale_id, by the id from GET /sales. The entry is created as a sale standalone entry (kind equal to sale_standalone), linked to the sale and in its company, and it shows up in financial.standalone_bills of Get sale by ID. Only the company comes from the sale: person, categories, amounts and the other fields come from the payload, as in any entry. company_identifier may be omitted; when sent, it must be the CNPJ of the sale company. A closed sale accepts the entry, and a deleted one answers 409. A sale entry has no own operation, installments or recurrence: operation_id and recurrence_kind are rejected with 422. It can be created already settled, like the others. It requires, in the sale company, the permissions to create accounts payable and receivable described below and the "View financial tab" permission on sales; the permission to edit the sale is not required, since the sale does not change. The sale must be among those the credential reads: one out of reach answers 422 on sale_id, like one that does not exist. Since the Financial tab only shows with the sale open, a sale from another seller also requires "Open sales of other sellers", and without it the answer is 403; through an automatic connection authorized before the "of others" permissions, only a sale created by the connection itself.
Requires the "Edit" permission on accounts payable and receivable in the company, which cannot be read-only; through an automatic connection authorized before the "of others" permissions, the permission to create and edit own accounts also works. The created entry belongs to the credential. The response brings the created entry, the same as Get account payable or receivable by ID, even for a credential without the "View" permission, and in generated_bills the partial payment's balance, which is created in the same call: if it is rejected, nothing is saved. Installments and recurrences do not come in generated_bills: they are fetched by recurrence_group_id. Following the series, by the read by ID or by the list, requires the permission to read accounts payable and receivable.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ of the entry's company. The credential must be able to create entries in it. Required, except for a sale entry (with |
| sale_id | string <uuid> Sale on which the account payable or receivable is posted, by the id from |
| transaction_kind required | string Enum: "credit" "debit" Nature of the entry: |
| person_id required | string <uuid> Person of the entry (customer or supplier), by the id from |
| description required | string <= 50 characters Entry description, up to 50 characters. Of the 60 Monde stores, 10 are reserved for what the system itself appends, such as the " 1/3" installment suffix and the " 1/2" of a partial payment. |
| document | string <= 50 characters Reference document, such as the invoice number, up to 50 characters. |
| amount required | number <double> decimal places <= 2 > 0 Entry amount, greater than zero, with up to 2 decimal places. |
| currency | string = 3 characters ISO 4217 code of the entry currency, among the active currencies. When omitted, the entry is in Real ( |
| issue_date | string <date> Issue date in ISO 8601 format (YYYY-MM-DD). When omitted, it is today, or the due date or the settlement date when they are earlier. It cannot be later than the due date or the settlement date. |
| due_date required | string <date> Due date in ISO 8601 format (YYYY-MM-DD). For accounts receivable, it is subject to the company's due date lock. |
| account_id | string <uuid> Account expected for the settlement, by the id from |
| operation_id | string <uuid> Own operation, by the id of the own operation product. It must be active. Travel agencies only. |
| observations | string Entry notes. |
| billing_account_id | string <uuid> Billing account of the bank slip, by the id in |
| billet_demonstrative | string Demonstrative of the bank slip, the text printed on it. Receivables only. |
required | Array of objects (bill_category_create) non-empty Entry categories, at least one. Their signed sum is the final amount. |
object Entry apportionments. Travel agencies only. | |
Array of objects (custom_field) Finance custom fields, by the id from | |
| settlement_date | string <date> Settlement date in ISO 8601 format (YYYY-MM-DD), sent with |
Array of objects (bill_movement_create) Settlement movements, sent with | |
| partial_payment | boolean Partial payment, the same as |
| balance_resolution | string Enum: "category" "partial" What to do with the difference between what was paid and the final amount, in an entry created already settled: |
| balance_category_id | string <uuid> Only with |
| recurrence_kind | string Enum: "installment" "recurrent" Creates the series from the entry, in the background: |
| periodicity | string Enum: "weekly" "biweekly" "monthly" "bimonthly" "quarterly" "semiannual" "annual" Interval between the series entries: |
| installments | integer [ 2 .. 200 ] Total number of installments, from 2 to 200, counting the entry itself. Each installment repeats the full amount. |
Account payable with document, forecast account, two categories, cost center and company apportionments, and a custom field.
{- "company_identifier": "46598887000162",
- "transaction_kind": "debit",
- "person_id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "description": "Aluguel escritório - Outubro/2026",
- "document": "NF 1001",
- "amount": 1500,
- "issue_date": "2026-10-07",
- "due_date": "2026-10-15",
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "observations": "Contrato 2026/10",
- "categories": [
- {
- "category_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
- "amount": 1200,
- "description": "Aluguel"
}, - {
- "category_id": "e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9",
- "amount": 300
}
], - "apportionments": {
- "per_cost_center": [
- {
- "cost_center_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "percentage": 60
}
], - "per_company": [
- {
- "company_identifier": "46598887000162",
- "percentage": 100
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
]
}Example detail of a customer invoice, with categories, movements, apportionments, items, attachments and custom fields.
{- "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,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "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": null,
- "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,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "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",
}
], - "categories": [
- {
- "amount": 1500,
- "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": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}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.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example detail of a customer invoice, with categories, movements, apportionments, items, attachments and custom fields.
{- "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,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "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": null,
- "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,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "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",
}
], - "categories": [
- {
- "amount": 1500,
- "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": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Updates a financial entry, open or settled, with the same rules as the manual entry in Monde. Send only the fields that must change: an omitted field stays as it is. document, observations and operation_id are cleared when sent as null; person_id, description, issue_date, due_date, account_id and amount are required on the entry, and sending them null or empty is refused, as is a null or empty company_identifier. A list sent as null counts as the empty list: a null categories is refused like the empty list, and a null apportionments empties both apportionments (a null per_cost_center or per_company empties only that one). Custom fields are not replaced: each one sent is written over the current one, one sent with a null or empty value is cleared, and the others stay; required ones do not have to be sent again, but cannot be cleared. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).
What changes. Person, description, document, issue date, due date, forecast account, own operation, observations, custom fields, amount, categories, apportionments, company and, on a settled entry, the settlement date and the movements. This operation does not settle or unsettle: for that, use Settle account payable or receivable and Undo the settlement. The nature (transaction_kind) does not change: when sent, it is ignored like any field outside the contract.
Which entries. Every entry that is not deleted, open or settled, with the locks Monde applies to each type (kind). A deleted entry and an invalid invoice answer 409.
sale_payment, or with a linked sale): person, company and amount do not change. On sale_standalone, only the company.customer_invoice, vendor_invoice, vendor_standalone): person, company and original amount do not change; the amount comes from the items.credit_card_invoice): due date, company and amount do not change, and it has no categories. The apportionments split its final amount, the sum of the card purchases.commission): like the standalone entry, but without the own operation.category_id. The own operation is accepted only on a standalone entry (normal) without an invoice number, as in Monde.settlement_date changes the settlement date, which cannot be empty or later than the date of the last movement. Changing the settlement date to one different from the stored one also requires the "Settle account payable" or "Settle account receivable" permission, depending on the nature of the entry, as in Monde; without it, the answer is 403 with the Monde message. The same date sent again asks no permission. Each item of movements with an id points to a movement the entry already has, and changes only the account, payment method, date, amount, card fee, check or card sent. An item without id is a new movement, like Monde's Adicionar, and comes with the account, payment method, date and amount. The movements not sent stay as they are, and movements cannot be removed. The movement ids come in movements of Get account payable or receivable by ID. The movements must add up exactly to the final amount: changing the amount requires the movement along with it. On a movement with a card fee (card_rate), the amount is what the customer paid, and the account receives the amount less the fee: changing only the fee keeps what the customer paid and changes what went into the account, as in Monde, and the card fee category follows, as do the agency card fee of the sale products and the sale revenue. The payment method of a movement with a system-generated fee cannot change to one that is not a card. An account receivable can move to a credit card account, with the credit card payment method: it is the refund, which goes into the card invoice. The company of a settled entry does not change. The closed cash day and, in accounts receivable, the movement date block apply as in Monde. On an open entry, a date in settlement_date or a movement in movements is refused: this operation does not settle.undo_bank_reconciliation as true. With the confirmation, the change is written, and the reconciliation of that movement will have to be redone. A change that does not touch the reconciled movements, such as one to the categories, the apportionments or the description, keeps the reconciliation and is written without the confirmation.categories sent replace those of the entry, and their signed sum is the final amount, as in the creation: the difference from amount is a surcharge or discount, subject to the company's surcharge and discount block. The list cannot be empty. An amount sent without categories follows the Monde rule: with a single category, it follows the new amount; with more than one, the new amount must equal their sum, otherwise it is refused and the categories must be sent along.apportionments.per_cost_center can be between 0 and 100% of the final amount, and apportionments.per_company, when sent, must add up to exactly 100% and only accepts companies where the credential can also create entries. An empty list removes the apportionment.company_identifier moves the entry to another company, and requires the "Edit" permission on accounts payable and receivable there too, and that company cannot be read-only. An entry of another user also requires, in the target company, access to the entries of other users (whole or the entry's slice); without it, the answer is 403 with the Monde message. Without account_id, the forecast account stays the same if the new company also has it; otherwise, the default forecast account of the new company applies. As in Monde, an entry with a registered or issued billet does not change company.recurrence_scope is this_and_following: then it also applies to the following entries of the series, as the "Update this and following" option in Monde. The following entries are updated in the background, right after the response. Settlement, number, document and billet data are never taken to them; their due date follows the periodicity of the series from the changed entry, and in a recurrence the issue date does too. Each following entry is only changed when the credential could change it directly, with the rules at the end of this description: the "Edit" permission in its company, which cannot be read-only; on an entry of another user, access to the other users' entries (whole or in the entry's slice); and, on a settled one, "Edit settled entry". A following entry that does not meet this stays as it is, without stopping the others. A deleted following entry also stays as it is. On an entry outside a series, this_and_following is refused.id. This also applies to the entry the credential itself created.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| person_id | string <uuid> Person of the entry (customer or supplier), by the id from |
| description | string <= 50 characters Description of the entry, up to 50 characters. Cannot be empty. |
| document | string or null <= 50 characters Reference document, such as the invoice number, up to 50 characters. Null clears it; empty text is saved. |
| issue_date | string <date> Issue date in ISO 8601 format (YYYY-MM-DD). Cannot be later than the due date. |
| due_date | string <date> Due date in ISO 8601 format (YYYY-MM-DD). In accounts receivable, it is subject to the company's due date block. |
| account_id | string <uuid> Forecast account for the settlement, by the id from |
| operation_id | string or null <uuid> Own operation, by the id of the own operation product. Must be active. Agencies and standalone entries without an invoice number only. Null clears it. |
| observations | string or null Observations of the entry. Null clears them; empty text is saved. |
| billing_account_id | string or null <uuid> Billing account of the bank slip, by the id in |
| billet_demonstrative | string or null Demonstrative of the bank slip, the text printed on it. Receivables only. Null or empty text clears it: Monde does not store an empty demonstrative. |
| close_invoice | boolean Confirms closing the open client invoice along with the billing account: |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ of the company the entry moves to. The credential must be able to create entries there. An entry with a registered or issued billet does not change company. |
| amount | number <double> decimal places <= 2 > 0 Amount of the entry, greater than zero, with up to 2 decimal places. Without |
Array of objects (bill_category_create) non-empty Categories of the entry, at least one. They replace the current ones, and their signed sum is the final amount. | |
object or null Apportionments of the entry. Agencies only. Each one sent replaces the current one; the one not sent stays as it is. | |
| recurrence_scope | string Enum: "only_this" "this_and_following" Only for installment or recurrent entries: |
Array of objects (custom_field) Custom fields of the financial module, by the id from | |
| settlement_date | string <date> Settled entries only. Settlement date in ISO 8601 format (YYYY-MM-DD). Cannot be empty or later than the date of the last movement. |
Array of objects (bill_movement_update) Settled entries only. Movements the entry already has, each one by its id, with what changes in it, and the new ones, without id, complete. The ones not sent stay as they are; movements cannot be removed. | |
| undo_bank_reconciliation | boolean Confirms a change that undoes the bank reconciliation: |
Changes only the fields sent; the others stay as they are.
{- "description": "Aluguel escritório - Novembro/2026",
- "document": "NF 1002",
- "due_date": "2026-11-15",
- "observations": "Vencimento renegociado com o locador"
}Example detail of a customer invoice, with categories, movements, apportionments, items, attachments and custom fields.
{- "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,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "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": null,
- "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,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "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",
}
], - "categories": [
- {
- "amount": 1500,
- "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": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Deletes the entry as Monde does: it is not erased, it is marked as deleted (canceled equal to true). It no longer shows up in List accounts payable and receivable, unless the status parameter asks for the canceled ones, and stays available in the query by ID, with the categories, apportionments and attachments it had.
Which entries. The standalone entry (normal) and the client and vendor invoice (customer_invoice, vendor_invoice, vendor_standalone). On an invoice, its items leave it: client items are invoiced again by the invoicing rules, vendor items wait to be invoiced (and are invoiced again when the agency invoices vendors automatically), and the CVC statement items entered straight on the invoice and the items of a canceled sale are erased. The invoice is marked as deleted, even with no items. These answer 409, with the reason:
sale_payment, sale_standalone or with a linked sale): it leaves through the sale deletion;credit_card_invoice), which leaves on its own when it has no entries;commission);No confirmation. This is the deletion without confirmation: the DELETE has no body, and a body sent is ignored. So a settled entry and an entry with a reconciled movement answer 409, and a recurrence_scope answers 422: on an entry of a series, the DELETE deletes only that entry. When the 409 refusal asks for a confirmation, or to also delete the following entries of the series, use Delete account payable or receivable with confirmation, which has the same rules and carries the confirmations in the body.
The deletion is recorded in the entry log, on behalf of the credential.
It requires the "Delete" permission on accounts payable and receivable on the entry's company, which cannot be read-only; the "Edit" permission is not enough. Permissions are checked before anything else: without "Edit settled entry", a settled entry answers 403, even one that would also be refused with 409, such as an entry generated by a sale. The credential deletes the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. It does not require Idempotency-Key: repeating the request after the deletion answers 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Deletes the entry with the answers to the questions Monde asks before deleting: remove the settlement, undo the bank reconciliation and also delete the following entries of the series. It is the same deletion as Delete account payable or receivable, with the same rules, permissions and responses. The difference is that the confirmations go in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way.
The entry is not erased: it is marked as deleted (canceled equal to true), as in Monde. The entries accepted and the 409 refusals are those of the DELETE.
Settled entry. Deleting removes the settlement, and the movements leave the accounts, like the Monde question "This account is already settled. Remove the settlement and delete?". A request without remove_settlement equal to true answers 409. It also requires the "Edit settled entry" permission on accounts payable and receivable. A closed cash register on the date of a movement, and a card movement of a credit card invoice already settled, prevent the deletion: the response is 422 with the reason.
Bank reconciliation. An entry with a reconciled movement answers 409, with the Monde warning, until the request carries undo_bank_reconciliation equal to true. With the confirmation, the reconciliation is undone and will have to be redone.
Installments and recurrence. On an entry of a series, the deletion applies only to it, unless recurrence_scope is this_and_following, like the "Delete this and following" option in Monde: the following entries of the series with no movement are erased, in the background, right after the response, and the series stops repeating. Each following entry is only erased when the credential could delete it directly: with the "Delete" permission on accounts payable and receivable in its company, which cannot be read-only; on an entry of another user, access to the other users' entries (whole or in the entry's slice); and, on a settled one, "Edit settled entry". A following entry that does not meet this stays, out of the series. The erased ones do not come back. On an entry outside a series, this_and_following is refused.
The body only carries these confirmations, and an omitted field counts as not confirmed. A value out of format answers 422, before the 409 refusals. The deletion is recorded in the entry log, on behalf of the credential.
It requires the "Delete" permission on accounts payable and receivable on the entry's company, which cannot be read-only; the "Edit" permission is not enough. Permissions are checked before anything else: without "Edit settled entry", a settled entry answers 403. The credential deletes the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message.
It requires Idempotency-Key: without it, the response is 400. A resend with the same key returns the response of the first deletion, 204 with the X-Idempotent-Replay: true header, without deleting again.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| recurrence_scope | string Enum: "only_this" "this_and_following" Only for an installment or recurrence entry: |
| remove_settlement | boolean Confirms the deletion of a settled entry, which removes its settlement and movements. Required as |
| undo_bank_reconciliation | boolean Confirms that the entry's bank reconciliation will be undone. Required as |
{- "remove_settlement": true
}{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Settles an open financial entry, with the settlement rules of Monde. Send the settlement date (settlement_date) and the movements (movements), one per account the money came into or left, with the account, payment method, date and amount, as in the creation already settled. Each movement uses an active account linked to the entry's company, and the payment method follows the account type: cash and check accounts accept cash or check, a credit card account accepts only credit card, and a checking account accepts the others. A check requires its number. Installments (installments) only on a credit card account. The settlement date cannot be later than the date of the last movement, and the issue date cannot be later than the settlement date.
Card fee and refund. On an account receivable paid by credit or debit card into a checking account, card_rate is the card operator fee: the account receives amount less the fee, and the sum of the fees becomes the company's card fee category, which lowers the final amount, as in the settled creation. An account receivable settled in a credit card account, with the credit card payment method, is the refund, which goes into the card invoice.
Amount paid different from the final amount. When the movements do not add up to the final amount, say what to do with the difference in balance_resolution, as Monde asks when settling:
category: the difference goes to a category, as a discount (paid less) or surcharge (paid more), and the final amount becomes what was paid. The category comes in balance_category_id; without it, the company's default category for that case applies (discount granted or received, surcharge charged or paid), and without a default the request is refused. The category must be of the type that brings the final amount to what was paid: an expense on an account payable paid more, for instance. The company's surcharge and discount block applies.partial: only when less than the final amount was paid. The entry is settled with what was paid and gets the suffix " 1/2" in the description, and the balance becomes a new open entry, with the suffix " 2/2" and the same categories in proportion to the balance. The balance comes in generated_bills.Without balance_resolution, the movements must add up exactly to the final amount. On a credit card invoice, the difference always goes to the next invoice of the same card, with no choice (balance_resolution does not change where it goes): what was left unpaid enters it as debt, and what was overpaid, as a deduction. On a customer invoice generated by Monde and on a supplier invoice other than the CVC one, the API settles only the full amount, and a payment lower or greater than it is refused with 422. On other invoices, the difference is resolved only with category; a partial payment is refused with 422.
Which entries. Every kind, as in Monde: the standalone entry (normal), the sale payment (sale_payment), the sale standalone entry (sale_standalone), the commission (commission), the customer and supplier invoice (customer_invoice, vendor_invoice, vendor_standalone) and the credit card invoice (credit_card_invoice). These answer 409, with the reason: an entry already settled (to change the settlement, use the update), a deleted one and an invalid invoice. An entry in another currency is settled as in Monde: the movement amount is in the currency of the entry and, in an account in another currency, goes in converted by the exchange rate (exchange_rate). A movement in an account outside BRL keeps the reference exchange rate from the account currency into BRL (reference_exchange_rate). As in Monde, both are suggested by the latest rate and can be corrected: when omitted, the registered rates apply (without a registered rate to convert, 422); when sent, the ones from the bank apply.
Sale payment. Each payment made to the agency in a sale (cash, card, billet, check, deposit and others, one entry per installment) is a sale_payment entry, and its id comes in payments.agency.bills of Get sale by ID and of the response of the sale creation and update. Payments to the supplier and agency credit create no entry and are not settled. The settlement uses the payment method and data agreed in the sale, like "Settle using sale data" in Monde: payment_method_id is optional in the movement and, when absent, the sale's method applies; the movement using the sale's method gets the card or check informed in the sale, which card and check replace when sent. The card fee calculated in the sale moves to the first movement, when it is a card one (otherwise, it stays on the entry), without sending card_rate: as in every movement with a fee, the amount is what the customer paid, and the account receives the amount less the fee. The card fee of the settlement is prorated among the sale products, in their agency card fee, and comes off the sale revenue, as in Monde. The balance of a partial payment (balance_resolution as partial) is created linked to the same sale, without the " 1/2" and " 2/2" suffixes in the description: it shows up in payments.agency.bills of the sale. In the partial payment, the payment items stay on the entry up to the amount paid, and the item that goes past it is split: the paid part stays, and the rest goes to the balance, each part with the agency card fee in proportion to its amount. The categories of the balance come from the company's default invoice categories; without them, the settlement is refused with 422 and nothing is written. The payment's person, company and amount do not change.
Monde rules. On accounts receivable, the company's movement date block and surcharge and discount block apply, and for the integration they always apply. A closed cash day refuses the movement with the reason, such as O caixa do dia "14/10/2026" da conta "Caixa" está fechado. The settlement and the movements are recorded in the entry's log, on behalf of the credential.
Responses follow an order: the permission (403), the request format (422), the entry's situation (409) and the settlement and Monde rules (422). The errors of an item of movements bring its position, counted from 0.
Requires the "Edit" permission on accounts payable and receivable in the entry's company, which cannot be read-only: settling is the same right as creating the entry already settled. It also requires the Settle account payable or Settle account receivable permission, according to the nature of the entry; without it, the response is 403 with the Monde message. The credential settles the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. The response brings the settled entry, the same as Get account payable or receivable by ID, with the partial payment balance in generated_bills, when the credential also has the "View" permission on accounts payable and receivable in the entry's company; without it, the settlement is written all the same and the response brings only the id. This also applies to the entry the credential itself created.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| settlement_date required | string <date> Settlement date in ISO 8601 format (YYYY-MM-DD). It cannot be later than the date of the last movement, nor earlier than the issue date. |
required | Array of objects (bill_movement_create) non-empty Settlement movements, at least one: one per account the money came into or left. Without |
| balance_resolution | string Enum: "category" "partial" What to do with the difference between what was paid and the final amount: |
| balance_category_id | string <uuid> Only with |
Account of R$ 420.00 paid in cash in the cash account.
{- "settlement_date": "2026-10-14",
- "movements": [
- {
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "payment_method_id": "fc9f5c65-71b2-4bab-ba56-aee44fe6d998",
- "date": "2026-10-14",
- "amount": 420
}
]
}Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Undoes the settlement of an entry, as removing the settlement in Monde: the settlement date is cleared, the movements leave the accounts and the entry is open again. The card fee and bank fee generated by the settlement go along, except the card fee calculated in the sale, which stays on the sale payment. The agency card fee of the sale products goes back to zero, and the sale revenue no longer deducts it, as in Monde; on a new settlement, the fee is prorated by the amount of each product; the surcharge and discount posted in it stay, and the final amount keeps them. The entry with the balance of a partial payment also stays. A billet pending write-off goes back to registered, and the credit generated by the settlement is reversed. The removal of the movements is recorded in the entry's log, on behalf of the credential.
Which entries. The same ones the settlement accepts. These answer 409, with the reason: an open entry, a deleted one and an invoice whose balance was taken to another entry (its settlement is not undone while the balance is there). On a credit card invoice, the balance taken to the next invoice of the same card leaves it along; the refusal only comes when that next invoice is already settled.
No confirmation. This is the undo without confirmation: the DELETE has no body, and a body sent is ignored. So an entry with a reconciled movement answers 409, and a recurrence_scope answers 422: on an entry of a series, the DELETE undoes only its own settlement. When the 409 refusal asks for the confirmation, or to also undo the settlement of the following entries of the series, use Undo the settlement with confirmation, which has the same rules and carries the confirmations in the body.
A closed cash day on the date of any movement, and a card movement of a credit card invoice already settled, prevent the undo: the response is 422 with the reason.
Requires the "Edit" and "Edit settled entry" permissions on accounts payable and receivable, in the entry's company, which cannot be read-only. Permissions are checked before anything else: without "Edit settled entry", the response is 403 even for an entry that is already open. The credential undoes the settlement of the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. It does not require an Idempotency-Key: repeating the request after the undo answers 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Undoes the settlement of the entry with the answers to the Monde questions: undo the bank reconciliation and also undo the settlement of the following entries of the series. It is the same undo as Undo the settlement of account payable or receivable, with the same rules, permissions and responses. The difference is that the confirmations go in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way.
The settlement date is cleared, the movements leave the accounts and the entry is open again, as in the DELETE. The entries accepted and the 409 refusals are also those of the DELETE.
Bank reconciliation. An entry with a reconciled movement answers 409, with the Monde warning, until the request brings undo_bank_reconciliation as true. With the confirmation, the reconciliation is undone and will have to be redone.
A closed cash day on the date of any movement, and a card movement of a credit card invoice already settled, prevent the undo: the response is 422 with the reason. The body only carries the confirmations, and an omitted field counts as not confirmed. A value out of format answers 422, before the refusals with 409.
Installments and recurrence. On an entry of a series, only its settlement is undone, unless recurrence_scope is this_and_following, like the "Update this and following" option in Monde: then the settlement of the following settled entries of the series is undone too. The following open entries, the deleted ones and the previous ones stay as they are. Each following entry goes through the same refusals as the entry sent (the balance taken to another entry, the reconciliation without the undo_bank_reconciliation confirmation) and requires that the credential could undo its settlement directly. It is all or nothing: if one of them cannot be reopened, no settlement is undone, and the response is 409 naming the following entry that blocked it and why; a closed cash day on the date of a movement of any of them answers 422. On an entry outside a series, this_and_following is refused with 422.
Requires the "Edit" and "Edit settled entry" permissions on accounts payable and receivable, in the entry's company, which cannot be read-only. Permissions are checked before anything else: without "Edit settled entry", the response is 403 even for an entry that is already open. The credential undoes the settlement of the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message.
It requires Idempotency-Key: without it, the response is 400. A resend with the same key returns the response of the first request, 204 with the X-Idempotent-Replay: true header, without undoing again.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| recurrence_scope | string Enum: "only_this" "this_and_following" Only for an installment or recurrence entry: |
| undo_bank_reconciliation | boolean Confirms that the entry's bank reconciliation will be undone. Required as |
{- "recurrence_scope": "this_and_following",
- "undo_bank_reconciliation": true
}{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Settles several open entries in one call, like settling the entries checked in the Monde list. Send the ids in bill_ids, up to 100, without repeating. Each entry is settled for its whole final amount, on the same date (settlement_date), in the same account (account_id) and with the same payment method (payment_method_id) and the same check (check) or card (card) data. To pay only part of an entry, or to split the settlement among accounts, use Settle account payable or receivable.
All or nothing. If one of the entries cannot be settled, none is, and the message names the one that refused it, by its number: Não é possível liquidar o lançamento Nº 71. O lançamento está excluído e não pode ser alterado..
Sale data. With use_sale_data set to true, each sale payment is settled with the payment method and the check or card data agreed in its own sale, like the Monde "Liquidar usando dados da venda". It only applies when every entry is a sale payment (sale_payment), and then payment_method_id, check and card are not accepted. The default is false.
Account, payment method and card fee. The account must be active and linked to the companies of every entry, and the payment method follows the account type, as in the settlement of one entry: cash and check accounts accept cash or check, the credit card account accepts only credit card, and the checking account accepts the others. Installments (installments) only in a credit card account. The card fee is not sent: it comes from the categories of each entry, as in Monde, and card_rate is refused.
Currency. The entries must be in the same currency. An account in another currency is only accepted when Monde works with more than one currency (in an operator or with multiple currencies), as in the Monde batch settlement; there, exchange_rate converts the amount of all of them; omitted, the latest exchange rate applies, and without a registered rate the request is refused with 422.
Which entries. The same ones the settlement of one entry accepts, with the same 409 refusals: the entry already settled, the deleted one and the invalid invoice. The Monde rules apply to each one, such as the issue date later than the settlement, the company locks and the closed cash day, which answer 422 with the reason. The settlement and the movements go to the log of each entry, on behalf of the credential.
The responses follow an order: the entry that does not exist (404, with the ids), the permission (403), the request format (422), the status of each entry (409) and the settlement and Monde rules (422).
Requires, on each entry, the permissions of the settlement of one entry: "Edit" on accounts payable and receivable in its company, which cannot be read-only, and Settle accounts payable or Settle accounts receivable, according to its nature. Missing it on one entry is enough for the response to be 403 with the Monde message and nothing to be settled. The reach is also the same: the credential settles the entries it created and, with access to other users' entries, the others; one outside that access answers 404. The response brings in data the settled entries, each one like Get account payable or receivable by ID, when the credential has the "View" permission on accounts payable and receivable in its company; without it, the settlement is written all the same and only the id comes.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| bill_ids required | Array of strings <uuid> [ 1 .. 100 ] items unique [ items <uuid > ] Ids (UUID) of the entries to settle, from 1 to 100, without repeating. All of them must be in the same currency. |
| settlement_date required | string <date> Settlement date in ISO 8601 format (YYYY-MM-DD), the same for every entry. It is also the date of the movements, and the issue date of each entry cannot be later than it. |
| account_id required | string <uuid> Account the money came into or left, the same for every entry: active and linked to the companies of all of them. |
| use_sale_data | boolean Default: false With |
| payment_method_id | string <uuid> Payment method, the same for every entry, which follows the account type. Omitted, each entry has no payment method in the movement. Not accepted with |
| installments | integer [ 1 .. 99 ] Installments, from 1 to 99. More than one only in a credit card account, where each installment goes into its month's invoice. |
object Check data, only with the check payment method, which requires the number. Not accepted with | |
object Card data, only with the credit or debit card payment methods. Not accepted with | |
| exchange_rate | number <double> > 0 Exchange rate from the entries' currency to the account's currency, the same for all of them, when the two differ. Omitted, the latest exchange rate applies; sent with the account in the entries' currency, it is ignored. |
Two entries paid in cash in the cash account, each one for its final amount.
{- "bill_ids": [
- "212b54b8-27df-4859-80a9-79ad855bcd09",
- "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f"
], - "settlement_date": "2026-10-14",
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "payment_method_id": "fc9f5c65-71b2-4bab-ba56-aee44fe6d998"
}Response for a credential without the "View" permission on accounts payable and receivable in the entries' company: returns only the id of each one.
{- "data": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f"
}
]
}Restores a deleted entry, like Restore in Monde: the deletion is logical, and the entry comes back to the listings as it was before being deleted, with its categories, apportionments and attachments. The settlement that went away with the deletion does not come back: the restored entry is open, and to settle it again use Settle account payable or receivable. A billet left waiting to be cleared at the bank because of the deletion goes back to registered, except on a fintech billing account, where the clearing was already requested from the bank. The restoration is in the entry's log, on behalf of the credential.
Which entries. Only the standalone entry (normal), as in Monde. These answer 409, with the reason: an entry that is not deleted, one generated by a sale (restored from the sale), the client and supplier invoice, the commission and the other types. Following entries of a series removed by "delete this and following" no longer exist and do not come back.
Requires the "Restore" and "Edit" permissions on accounts payable and receivable, in the entry's company, which cannot be read-only. The credential restores the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. It requires neither Idempotency-Key nor a body: repeating the request after the restoration answers 409. The response brings the restored entry, like Get account payable or receivable by ID, when the credential has the "View" permission on accounts payable and receivable in its company; without that permission, only the id. This also applies to the entry the credential itself created.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Unique identifier of the account payable or receivable. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example detail of a customer invoice, with categories, movements, apportionments, items, attachments and custom fields.
{- "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,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "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": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "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": null,
- "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,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "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",
}
], - "categories": [
- {
- "amount": 1500,
- "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": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Generates the bank slip of the receivable, like Monde's Imprimir Boleto: a bank slip not issued yet is numbered and issued, with the digitable line and the barcode, and one already issued is returned again, with the same number. A bank slip registered by PJBank is returned with the Pix copy-and-paste code; while it is on its way to the bank, the response is 422, and you have to wait for the registration. For the PDF, use Download the bank slip PDF.
Billing account. The bank slip is issued by the billing account of the entry, written in billing_account_id on creation or update. Without one, the only billing account of the company that issues without registration applies; with more than one, the response is 422 with their ids, and the chosen one goes in billing_account_id, as Monde asks. The chosen one is written on the entry.
Foreign currency. The bank slip is issued in reais. On an entry in another currency, send the exchange rate of the issue in exchange_rate: without it, the response is 422, as Monde asks for the exchange rate.
Open client invoice. The bank slip charges what the invoice holds, and Monde only issues it with the invoice closed: it asks whether to close the invoice. Through the API, an open client invoice answers 409 until the request brings close_invoice as true, which closes the invoice and issues the bank slip, with the rules and the "Fechar Fatura" permission of Close a client invoice.
Monde's refusals answer 422 with its message: a payable, a settled entry and a billing status that does not allow issuing. A deleted entry answers 409.
Requires the "Imprimir boleto" permission of sales in the entry company and, on a bank slip not issued yet, also "Gerar boletos" of payables and receivables, with the company open for writing, as in Monde. The reach is that of the entry query.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Receivable ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| billing_account_id | string <uuid> Billing account of the bank slip, by the id in |
| exchange_rate | number <double> Exchange rate of the issue, greater than zero, on an entry in a foreign currency: the bank slip is issued in reais. |
| close_invoice | boolean Confirms closing the open client invoice, to generate its bank slip. Without it, an open invoice answers 409. |
{ }{- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "number": 15838,
- "our_number": "109/00015838-6",
- "digitable_line": "34191.09008 01583.861412 04640.150005 7 16540000014935",
- "barcode": "34197165400000149351090015838614120464015000",
- "amount": 149.35,
- "due_date": "2026-11-20",
- "pix_code": null,
- "bank": {
- "code": "341-7",
- "name": "Itaú"
}
}Returns the PDF of the bank slip already generated, the same one Monde sends by e-mail: the payer receipt and the payment slip, with the barcode and, on PJBank, the Pix QR code. On an entry in a foreign currency, the bank slip uses the exchange rate of the last generation.
A bank slip not generated yet answers 409: generate it first with Generate the bank slip of a receivable. A billing status Monde does not print answers 422.
Requires the "Imprimir boleto" permission of sales in the entry company, with the reach of the entry query.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Receivable ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}Closes the client invoice, like Monde's Fechar Fatura: a closed invoice does not accept changes to its items, so it can be sent to the client. The first closing numbers the invoice and stamps the date it was invoiced; an invoice that had never been invoiced gets the closing day as its issue date. Closing again after reopening keeps the number.
Only client invoices are closed. The following answer 409, with the reason: a deleted financial entry, one that is not a client invoice and an invoice already closed. The following answer 422, as in Monde: an issue date before the earliest sale of the items and an item still awaiting deletion.
Requires the "Fechar Fatura" permission of payables and receivables in the invoice company, which cannot be read-only. It does not require "Edit": as in Monde, the credential only has to reach the invoice, with the same reach as the query. The response brings the closed invoice, or only its id to a credential without the "View" permission.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Reopens a closed client invoice, like Monde's Reabrir Fatura, so its items can be changed again. The invoice number stays. If the invoice was already sent to the client, consider making the changes in the next invoice.
The following answer 409, with the reason: a deleted financial entry, one that is not a client invoice and an invoice that is not closed. An item still awaiting deletion prevents reopening, with 422, as in Monde.
Requires the "Reabrir Fatura" permission of payables and receivables in the invoice company, which cannot be read-only, with the same reach as Close a client invoice. It requires neither Idempotency-Key nor a body: repeating the request after reopening answers 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Changes the two columns Monde edits in the invoice items grid. checked marks or unmarks the item as checked, and applies to vendor invoices generated by Monde and to separate vendor invoices. cost_center changes the item cost center, and applies to client invoices generated by Monde, outside an operator base, which does not show the column. With a legal person payer, the cost center must be one of those registered on it (the match ignores case and surrounding spaces, and the item keeps the name as registered), unless the agency uses free text cost centers; null clears the cost center. An item that becomes equal to another one of the invoice is added to it, as in Monde.
Item added to another one. Two items of an invoice are equal when they have the same sale product, side, kind and cost center. An item that becomes equal to another one is added to it and ceases to exist, and its id starts answering 404. It happens when the cost center changes, where the changed item goes away and the other one stays, and when the item enters another invoice, where the item that entered goes away and the one already there stays. A refund is never added. After each action on the items, the valid ids are those in items of the response; to find the line again, use sale_product, side, kind and cost_center. Repeating with the same Idempotency-Key returns the original response, with the ids of that moment: for the current ones, read the invoice with Get payable or receivable by ID.
Which invoices. The actions on the items apply to client invoices, vendor invoices and separate vendor invoices, except the CVC vendor invoice. The following answer 409, with the reason: a deleted financial entry, one that is not such an invoice, a settled invoice, a closed invoice and a field that does not apply to that invoice. Monde asks whether to undo the settlement or reopen the invoice and repeats the operation; through the API, undo the settlement with Undo the settlement of a payable or receivable or reopen the invoice with Reopen a client invoice before repeating.
Requires the "Edit" permission of payables and receivables in the invoice company, with the same reach as editing the financial entry. An item that is not on the invoice answers 404. The response brings the invoice as it ended up, like Get payable or receivable by ID, or only its id to a credential without the "View" permission.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| id required | string <uuid> Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 Invoice item ID, the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| checked | boolean Marks the item as checked ( |
| cost_center | string or null <= 50 characters Item cost center. |
{- "checked": true
}Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Corrects the values of an item, like Monde's Corrigir valores. It applies to client and vendor invoices generated by Monde, on an item linked to a sale product. value is the new item amount, with its sign, and the difference goes to the next invoice. On a vendor invoice, the commission, the over and the card fees (cc_du_fee and cc_rav_fee) change on the sale product, and the invoice item follows; the commission and the over take the percentage or the amount, and the other one is calculated over the product base. On a client invoice, only value. An omitted field stays as it is. The corrected item keeps the same id; the difference is a new item on the next invoice, where it may be added to an equal item.
Changing value requires the invoice to be open: settled and closed invoices answer 409. The commission, the over and the fees change even with the invoice closed, and the adjustment goes to another invoice of the vendor. A card fee above the product fee answers 422, as in Monde.
Requires the "Edit" and "Alterar taxa CC" permissions of payables and receivables, in the invoice company. When the correction actually changes the commission, over or fees of the product of a closed sale, it also requires "Alterar dados do produto em vendas fechadas" of sales; and, on a sale with a printed receipt, "Alterar vendas com recibo impresso". Without them, the response is 403 with Monde's message.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| id required | string <uuid> Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 Invoice item ID, the |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| value | number <double> New item amount, with its sign. The difference goes to the next invoice. |
| commission_percentage | number <double> Commission percentage of the sale product. Vendor invoices only. |
| commission_amount | number <double> Commission amount of the sale product. Vendor invoices only. |
| over_percentage | number <double> Over percentage of the sale product. Vendor invoices only. |
| over_amount | number <double> Over amount of the sale product. Vendor invoices only. |
| cc_du_fee | number <double> CC DU fee of the sale product, which cannot exceed the DU fee. Airfare vendor invoices only. |
| cc_rav_fee | number <double> CC RAV fee of the sale product, which cannot exceed the RAV fee. Vendor invoices only. |
{- "commission_amount": 20
}Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Brings to the invoice items of another open invoice, like Monde's Adicionar itens à fatura. The items that can enter are those Items that can enter the invoice lists: of the same person, company and currency, from an invoice that is neither settled nor closed. A client invoice takes items from another client invoice; a vendor invoice and a separate vendor invoice, from vendor invoices generated by Monde and separate vendor invoices. An id that cannot enter refuses the whole call with 422, and nothing is moved. The invoice the item leaves, if left without items, is deleted. An item that enters equal to an item of the invoice is added to it: the id sent ceases to exist, and the response brings the item that was already there, with the sum. See Item added to another one in Change the checked status or cost center of an invoice item.
The same invoices and refusals of Change the checked status or cost center of an invoice item apply, as well as the same "Edit" permission. The response brings the invoice as it ended up.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs of the items the action applies to. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Lists the items of the invoices and of the accounts payable and receivable, one per row, with the sale each came from and the entry it belongs to: the breakdown of each payment. With date_field=settlement_date and the period, it returns the items of everything settled in the month, without opening invoice by invoice.
The amount carries the sign Monde stores, and the items of an entry add up to its amount, negative on an account payable. On a supplier invoice, what is paid to the supplier comes negative and what is received from the customer, positive. The sum matches the entry amount, not the final amount of the settlement.
The items of the same entry come together, from the latest settlement to the earliest, and those of open entries come last. Items of a deleted entry and items not yet in an entry are left out.
Requires the "Visualizar" permission of accounts payable and receivable and reaches the same entries as List accounts payable and receivable.
| bill_id | string <uuid> Example: bill_id=212b54b8-27df-4859-80a9-79ad855bcd09 Entry ID: only its items. It is the |
| account_id | string <uuid> Example: account_id=6e0216e5-5536-4f4b-8c93-36371398b3cf Account ID of the entry: only the items of its entries. |
| person_id | string <uuid> Example: person_id=7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a Person ID of the item. |
| side | string Enum: "vendor" "customer" Example: side=vendor Item side: |
| date_field | string Enum: "settlement_date" "due_date" "issue_date" Example: date_field=settlement_date Date of the period: |
| date_from | string <date> Example: date_from=2026-10-01 Start of the period, inclusive (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 End of the period, inclusive (YYYY-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "description": "Pacote Cancún",
- "cost_center": null,
- "checked": true,
- "amount": -22000,
- "side": "vendor",
- "kind": "invoice",
- "document": "LOC111",
- "issue_date": "2026-10-01",
- "person": {
- "id": "7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a"
}, - "sale": {
- "id": "0b6f3d1a-6c2e-4a8f-9d71-2e5c8b4a7f10"
}, - "sale_product": {
- "id": "9a1c2e3f-4b5d-4e6f-8a7b-1c2d3e4f5a6b"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "settlement_date": "2026-10-15"
}, - {
- "id": "8e1d2c3b-4a5f-4e6d-9c8b-7a6f5e4d3c2b",
- "description": "Comissão recebida do cliente",
- "cost_center": null,
- "checked": true,
- "amount": 12000,
- "side": "customer",
- "kind": "invoice",
- "document": "LOC333",
- "issue_date": "2026-10-02",
- "person": {
- "id": "2bda359b-9554-43a5-a220-d145d70c01cb"
}, - "sale": {
- "id": "d05a6c2d-25d0-498d-881f-c906d327b3a0"
}, - "sale_product": {
- "id": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "settlement_date": "2026-10-15"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Lists the items Add items to the invoice accepts, with the invoice each one is on and its due date, from the oldest due date to the newest. Only the invoices the credential reaches come in. q searches, as in Monde, the invoice and sale numbers, the product document, the item description, the vendor, the amount and the sale and due dates.
Requires the "Edit" permission of payables and receivables in the invoice company. A deleted financial entry and one that is not an invoice with items answer 409.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| q | string Example: q=Hospedagem Text to search in the items. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "description": "Diárias de Hospedagem",
- "cost_center": null,
- "checked": false,
- "amount": -400,
- "side": "vendor",
- "kind": "invoice",
- "document": "HTL-20931",
- "issue_date": "2026-07-20",
- "person": {
- "id": "7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a"
}, - "sale": {
- "id": "0b6f3d1a-6c2e-4a8f-9d71-2e5c8b4a7f10"
}, - "sale_product": {
- "id": "9a1c2e3f-4b5d-4e6f-8a7b-1c2d3e4f5a6b"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "due_date": "2026-08-05"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Sends each item to the invoice its invoicing rule points to, as Monde does in two actions with the same engine. On a client invoice typed by hand it is Remover itens da fatura: the item leaves it and goes to the invoice generated by Monde. On an invoice generated by Monde it is Recalcular vencimento dos itens selecionados: the item changes invoice if the rule changed after invoicing. On other invoices, it answers 409. An id that is not on this invoice refuses the whole call with 422.
The same refusals of Change the checked status or cost center of an invoice item apply. Requires the "Edit" permission of payables and receivables, also for recalculating the due date, which Monde does not require. The response brings the invoice as it ended up and, in reprocessed_items, where each item sent ended up: the invoice (bill) and the item on it (item). The item is the item itself or, when the destination invoice already had an equal item, the item it was added to; an item the rule keeps on the invoice comes with the invoice itself. An invoice left without items is deleted, and the response brings only reprocessed_items.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs of the items the action applies to. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}{- "reprocessed_items": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "bill": {
- "id": "9a1d6c3e-52b7-4e0f-8a3d-1f6b2c7e4d90"
}, - "item": {
- "id": "0b7e2f4a-6c1d-4a9e-b3f5-8d2c1e7a6f40"
}
}
]
}Takes the items to a new separate invoice, typed by hand, like Monde's Faturar Avulso: a separate vendor invoice when the items are vendor items, and a client invoice when they are client items. The due date is due_date or, without it, today, as in Monde. An item without amount stays on the invoice; without any item with amount, the response is 422. An id that is not on this invoice refuses the whole call with 422. The invoice the items leave, if left without items, is deleted. The items keep the same id on the new invoice.
The same invoices and refusals of Change the checked status or cost center of an invoice item apply, as well as the same "Edit" permission. The response is 201 with the new invoice, or only its id to a credential without the "View" permission.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Invoice ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs of the items the action applies to. |
| due_date | string <date> Due date of the separate invoice. Without it, it is due today. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}Update response for a credential without the "View" permission on accounts payable and receivable in the entry's company, even on an entry it created: returns only the id of the entry.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}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.
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}.
| account_id | string <uuid> Example: account_id=f9d961b8-ea88-4346-8e52-afe94267417a Filters the movements of a specific account. |
| payment_method_id | string <uuid> Example: payment_method_id=c3b7e8eb-1199-4457-9170-923c3fe56c92 Filters the movements of a specific payment method. |
| transaction_kind | string Enum: "credit" "debit" Example: transaction_kind=debit Filters by the direction of the movement.
|
| date_field | string Value: "movement_date" Example: date_field=movement_date Date field used by the filter. Accepted value: movement_date. Required when date_from or date_to is provided. |
| date_from | string <date> Example: date_from=2026-10-01 Filter movements dated on or after this date, in ISO 8601 format (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 Filter movements dated on or before this date, in ISO 8601 format (YYYY-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with a card settlement and a transfer between accounts.
{- "data": [
- {
- "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
- "date": "2026-01-26",
- "amount": -9112.17,
- "transaction_kind": "debit",
- "description": null,
- "check": null,
- "card": {
- "brand": "MasterCard",
- "last_digits": "4117",
- "authorization": "600551159"
}
}, - {
- "id": "0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40",
- "date": "2026-01-26",
- "amount": 63063,
- "transaction_kind": "credit",
- "description": "Repasse diário",
- "check": null,
- "card": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Account movement identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of a movement that settles an account payable by credit card.
{- "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
- "date": "2026-01-26",
- "amount": -9112.17,
- "transaction_kind": "debit",
- "description": null,
- "check": null,
- "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": null,
- "counterpart_account": null
}Balance, statement and cash closing of a checking or cash account, as on the Monde Account Statement screen. An account of another kind (credit card, checks, investment) answers 404. The balance and the statement belong to the Saldo e Extrato (balance and statement) resource, separate from reading Accounts and Cards, with the Extrato de Conta permission, as in Monde. Closing and reopening the cash ask for the Fechar Caixa and Reabrir Caixa permissions of the Contas e Cartões (accounts and cards) resource, one for each action, as in Monde. Through the automatic connection, reading the balance and the statement and closing and reopening the cash are an exception granted by Monde on approval: the statement brings every movement of the account and the closing applies to the whole account, including what the agency recorded. One of the account companies granting the permission is enough. The closing is a watermark: closing a day closes every day up to it, and with the cash closed Monde refuses to insert, change or delete movements on those days.
Balance of the account at the end of the given day: the initial balance of the account plus every movement up to the date, inclusive. It is the same balance the statement closes that day with.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID of the checking or cash account, the same as in Accounts and Cards. |
| date | string <date> Example: date=2026-10-15 Date of the balance (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "date": "2026-10-15",
- "currency": "BRL",
- "balance": 1849.75,
- "cash_closed_until": "2026-10-10"
}Statement of the account in the period, line by line as in Monde: the previous balance, the movements of each day (entries and transfers, in the order they were saved) and the balance at the end of each day with movements, telling whether the cash is closed. Not paginated: the period has at most 45 days. Since it brings the name and document of people, each query is recorded in the History as an export of the Account Statement.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID of the checking or cash account, the same as in Accounts and Cards. |
| date_from required | string <date> Example: date_from=2026-10-01 First day of the statement (ISO 8601, |
| date_to required | string <date> Example: date_to=2026-10-15 Last day of the statement (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "currency": "BRL",
- "date_from": "2026-10-01",
- "date_to": "2026-10-15",
- "cash_closed_until": "2026-10-10",
- "opening_balance": 2000,
- "closing_balance": 1849.75,
- "data": [
- {
- "type": "opening_balance",
- "date": "2026-09-30",
- "balance": 2000,
- "cash_closed": true
}, - {
- "type": "bill_movement",
- "date": "2026-10-02",
- "account_movement": {
- "id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
}, - "bill": {
- "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"
}, - "sale": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "number": "1520",
- "description": "Pacote Lisboa",
- "document": null,
- "person": {
- "name": "Ana Souza",
- "document": "52998224725"
}, - "check": null,
- "card": {
- "brand": "Visa",
- "last_digits": "1234",
- "ticket_card": null
}, - "billet": null,
- "amount": 0
}, - {
- "type": "daily_balance",
- "date": "2026-10-02",
- "balance": 2000,
- "cash_closed": true
}, - {
- "type": "transfer",
- "date": "2026-10-15",
- "account_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "bill": null,
- "sale": null,
- "number": null,
- "description": "Transferência para: Banco. Sangria do caixa",
- "document": null,
- "person": null,
- "check": null,
- "card": null,
- "billet": null,
- "amount": -150.25
}, - {
- "type": "daily_balance",
- "date": "2026-10-15",
- "balance": 1849.75,
- "cash_closed": false
}
]
}Closes the cash of the account up to the given day, with the Monde rules: it does not close a future day nor a day already closed (reopen it first). When expected_balance is sent, the closing is refused if the balance of the day changed since it was read, like the screen review. Only active checking or cash accounts; a read-only company does not close. The closing is logged on the account with the credential. Requires Idempotency-Key.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID of the checking or cash account, the same as in Accounts and Cards. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| date required | string <date> Day up to which the cash is closed (ISO 8601, |
| expected_balance | number <double> Balance of the day reviewed by the integrator (the |
{- "date": "2026-10-15",
- "expected_balance": 1849.75
}{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "cash_closed_until": "2026-10-15"
}Reopens the cash from the given day: it and the following days accept movements again. It only moves the closing back; reopening a day already open answers 422. The reopening is logged on the account with the credential. Does not require Idempotency-Key.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID of the checking or cash account, the same as in Accounts and Cards. |
| date required | string <date> Example: 2026-10-10 Day to reopen (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Read, create, change and delete the transfers between the agency accounts, as on the Monde Transfer screen. A transfer is two sibling movements: the outflow on the origin account (Debit in account payment method) and the inflow on the destination account (Bank deposit). Both also show up in Account movements and in the statement. Only active checking or cash accounts transfer, and both accounts must belong to companies where the credential holds the permission: reaching one of them is not enough. A closed cash on the date refuses saving, changing and deleting, as in Monde. Permissions of the Transfers between Accounts resource, the Monde ones: Transferência entre Contas (read), Editar (create and change), Excluir (delete) and Visualizar Log (view log), which shows the history of the transfers in Logs (origin conta_movimento). Through the automatic connection, reading, editing, deleting and viewing the log are an exception granted by Monde on approval: a transfer does not record who created it, so whoever reads or writes transfers also reaches the ones the agency recorded.
Lists the transfers whose two accounts belong to companies where the credential can read transfers, newest first. Each transfer appears once, by its origin movement.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| account_id | string <uuid> Example: account_id=f9d961b8-ea88-4346-8e52-afe94267417a Filters the transfers leaving or entering this account (UUID). |
| date_from | string <date> Example: date_from=2026-10-01 Start date of the transfer (ISO 8601, |
| date_to | string <date> Example: date_to=2026-10-31 End date of the transfer (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates the transfer with the rules of the Monde screen: active checking or cash accounts, different from each other, amount greater than zero and description up to 100 characters. Both accounts must belong to companies where the credential inserts and edits transfers, outside read-only companies. The insertion is logged with the credential. The response brings the transfer only to whoever can also read it; others get only the id. Requires Idempotency-Key.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| date required | string <date> Date of the transfer (ISO 8601, |
| origin_account_id required | string <uuid> Account the amount leaves: the |
| destination_account_id required | string <uuid> Account the amount enters: the |
| amount required | number <double> Amount to transfer, greater than zero and with up to 2 decimal places. |
| description | string or null <= 100 characters Description of the transfer, up to 100 characters. |
{- "date": "2026-10-15",
- "origin_account_id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853",
- "destination_account_id": "6e0216e5-5536-4f4b-8c93-36371398b3cf",
- "amount": 150.25,
- "description": "Sangria do caixa"
}{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Returns the transfer. It can be opened by the ID of either movement, and always answers by the origin one.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Changes only the fields sent; an omitted field stays as is, and a description sent as null is cleared. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). The accounts are still checked when not sent: a transfer whose account is no longer an active checking or cash account is only saved by choosing another one. When one of the movements is in a bank reconciliation, changing its date, amount or account undoes the reconciliation, and that change asks for undo_bank_reconciliation as true, as the Monde warning does: without it, the response is 409. Changing only the description keeps the reconciliation and is saved without the confirmation. The change is logged with the credential. The response brings the transfer only to whoever can also read it; others get only the id. Requires Idempotency-Key.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| date | string <date> Date of the transfer (ISO 8601, |
| origin_account_id | string <uuid> Account the amount leaves: the |
| destination_account_id | string <uuid> Account the amount enters: the |
| amount | number <double> Amount to transfer, greater than zero and with up to 2 decimal places. |
| description | string or null <= 100 characters Description of the transfer, up to 100 characters. |
| undo_bank_reconciliation | boolean Confirms that saving may undo the bank reconciliation of one of the movements. Without it, the deletion of a reconciled transfer and a change to the date, amount or account of the reconciled movement answer 409. |
{- "amount": 200
}{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Deletes both movements of the transfer, without confirmation: the DELETE has no body, and a body sent is ignored. When one of the movements is in a bank reconciliation, the deletion undoes the reconciliation, so the response is 409. In that case, to delete anyway, use Delete transfer with confirmation. The deletion is not logged, as in Monde. Requires the Excluir (delete) permission of Transfers between Accounts in the companies of both accounts, which cannot be read-only. Does not require Idempotency-Key: repeating answers 404.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Deletes both movements of the transfer with the confirmation Monde asks for when one of them is in a bank reconciliation. It is the same deletion as Delete transfer, with the same rules, permissions and responses. The difference is that the confirmation goes in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way. When one of the movements is in a bank reconciliation, the deletion undoes the reconciliation: without undo_bank_reconciliation as true, the response is 409; with the confirmation, the reconciliation is undone and will have to be redone. A value that is not a boolean answers 422. The deletion is not logged, as in Monde. Requires the Excluir (delete) permission of Transfers between Accounts in the companies of both accounts, which cannot be read-only. Requires Idempotency-Key: without it, the response is 400. As the deleted transfer no longer exists, a resend after the deletion answers 404.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| undo_bank_reconciliation | boolean Confirms that saving may undo the bank reconciliation of one of the movements. Without it, the deletion of a reconciled transfer and a change to the date, amount or account of the reconciled movement answer 409. |
{- "undo_bank_reconciliation": true
}{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Query, record and delete the sale refunds: refund side, amount, dates and the references to the sale, the sale product, the person, the company and the account payable or receivable.
Returns the refunds of the companies the credential has permission for.
| refund_type | string Enum: "customer" "vendor" Example: refund_type=customer Filters by the refund side.
|
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Response example with a supplier refund and a customer refund.
{- "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"
}, - {
- "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": null
}
}Returns a refund by its identifier. It is the endpoint that resolves the refund references returned by other resources.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Refund identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of a supplier refund that already has an account payable or receivable.
{- "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": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "person": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}
}Deletes the refund, like deleting the refund on the sale in Monde. A refund not invoiced yet goes away alone; one on an invoice leaves it, and the invoice left empty goes away too. The product refund and the sale revenue go back to what they were.
Answers 409 when the refund invoice is settled or closed (reopen it in Monde first) or when the refund is on an entry that is not an invoice. The customer refund, which in Monde leaves through the payments grid of the sale, is only deleted on an open sale: on a closed sale, it answers 409 (reopen the sale in Monde first).
A vendor refund that has already become an account payable/receivable is not deleted through the sale in Monde: it is the one on the account generated for it alone (bill on recording) or, with the automatic vendor invoice off (and on products imported from CVC), the one on any invoice. In Monde, it leaves by deleting the account, after a confirmation. This DELETE is the deletion without confirmation: it has no body, and a body sent is ignored. So that refund answers 409 and nothing changes. To confirm the deletion of the account, use Delete refund with confirmation.
In Monde, deleting a refund is editing the sale, with no permission of its own: requires the Edit permission on Sales in the refund company, which cannot be read-only, and, on a sale the credential did not create, Edit sales of other sellers. The vendor refund, which in Monde leaves through the Financial tab of the sale, also requires View financial tab. On a sale with a printed receipt, both the customer and the vendor refund also require Change sales with a printed receipt.
Requires the Idempotency-Key, because the deletion changes the financial records. As the deleted refund no longer exists, a resend with the same key after the deletion answers 404, without deleting anything again.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Refund identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Deletes the refund with the confirmation Monde asks for before deleting the account payable/receivable the refund is on. It is the same deletion as Delete refund, with the same rules, permissions and responses. The difference is that the confirmation goes in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way.
A refund not invoiced yet goes away alone; one on an invoice leaves it, and the invoice left empty goes away too. The product refund and the sale revenue go back to what they were. The 409 refusals of the DELETE apply here too: a settled or closed invoice, an entry that is not an invoice and a customer refund on a closed sale.
A vendor refund that has already become an account payable/receivable is not deleted through the sale in Monde: it is the one on the account generated for it alone (bill on recording) or, with the automatic vendor invoice off (and on products imported from CVC), the one on any invoice. In Monde, it leaves by deleting the account, after a confirmation. Here, the confirmation goes in remove_from_bill: without it as true, the deletion answers 409 and nothing changes; with it, the whole account is deleted, as in Monde: the refund leaves, and the other items of the account are not deleted, they go back to pending, without an invoice (with the automatic vendor invoice on, they go back to the invoice of the billing rules). Example: an invoice of R$ 1,200.00 with this refund of R$ 200.00 and another item of R$ 1,000.00 is deleted; the refund goes away, and the R$ 1,000.00 item goes back to pending. What prevents deleting the account in Monde (such as a system invoice that still has items) answers 409, and nothing changes.
In Monde, deleting a refund is editing the sale, with no permission of its own: requires the Edit permission on Sales in the refund company, which cannot be read-only, and, on a sale the credential did not create, Edit sales of other sellers. The vendor refund, which in Monde leaves through the Financial tab of the sale, also requires View financial tab. On a sale with a printed receipt, both the customer and the vendor refund also require Change sales with a printed receipt. Deleting the whole account with remove_from_bill is, in Monde, deleting the entry: it also requires Edit and Delete on Accounts Payable and Receivable over that account and, on another user's account, the access to the entries of other users; without them, 403.
Requires the Idempotency-Key: without it, the response is 400. As the deleted refund no longer exists, a resend after the deletion answers 404, without deleting anything again.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Refund identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| remove_from_bill | boolean Confirms the deletion of a vendor refund that has already become an account payable/receivable: the whole account is deleted, and its other items go back to pending, without an invoice. Required as |
{- "remove_from_bill": true
}{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Records the refund of a sale product, like the Customer Refund and Vendor Refund actions of the product in Monde. The refund goes into the product refund and, through it, into the sale revenue.
customer: the agency gives the amount back to the customer. The refund is recorded as negative, on behalf of person_id (the sale payer, when omitted), in the product sale currency and due on the day.vendor: the vendor gives the amount back to the agency (credit, the default) or the agency pays the vendor (debit), on behalf of the product representative or, without one, the vendor, in the product sale currency (on an operator base, in the origin currency).billing, invoice sends the refund to the invoice by the billing rules, in the background: the customer invoice always; the vendor invoice only with the automatic vendor invoice on, and outside CVC products. Until then, bill comes back null. bill generates right away a separate invoice with the refund alone, due on the day, which comes back in bill. 409), and the product cannot be deleted. The customer refund exists only for agencies: on an operator base, it answers 403. Refused with 422: a refund with credit control on, a vendor refund of an own operation and a refund without the default refund category set on the company. id.| id required | string <uuid> Example: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 Identifier of the sale of the refunded product. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| sale_product_id required | string <uuid> Identifier of the refunded sale product, as it appears on the product inside the sale. |
| refund_type required | string Enum: "customer" "vendor" Refund side.
|
| amount required | number <double> > 0 Refund amount, positive. The sign comes from |
| transaction_kind | string Enum: "credit" "debit" Direction of the money for the agency.
|
| billing required | string Enum: "invoice" "bill" How the refund is billed.
|
| issue_date | string <date> Refund issue date. When omitted, today. |
| description | string <= 100 characters Refund description, up to 100 characters. |
| person_id | string <uuid> Person who receives the customer refund. When omitted, the sale payer. Not valid on a vendor refund. Sending the person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist. |
| cost_center | string <= 50 characters Cost center of the customer refund, only with |
Example of a customer refund that goes to the customer invoice.
{- "sale_product_id": "e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148",
- "refund_type": "customer",
- "amount": 1208.89,
- "billing": "invoice",
- "issue_date": "2022-04-09",
- "description": "Reembolso devido ao cancelamento da viagem",
- "person_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Example of a customer refund still without an account payable or receivable.
{- "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": {
- "id": "3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63"
}, - "sale_product": {
- "id": "e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148"
}, - "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "bill": null
}The reports of Monde, with the same query as the screen: the API and the report bring the same rows, with the same filters. Each report requires its own permission, as in Monde, and reaches only the companies where the credential has the permission and that have a license. The rows are paginated by cursor. As the reports bring people's contact data and documents, each page fetched is recorded in the History as an export of the report.
The passengers of the products sold, as the Passenger List report in Monde: one row per passenger of each product, with their contact data, documents and address, the air segments with the seat, the product details and amounts, and the people of the sale. It is the same query as the report, so the API and the screen bring the same passengers. It requires the Lista de Passageiros permission of the Lista de Passageiros resource, as in Monde. Without the Consultar passageiros de outros vendedores/intermediários permission, only the passengers of the sales the integration itself created come. Through the automatic connection, that permission is an exception granted by Monde on approval.
The passengers come in departure order and, on the same day, by passenger. Deleted products are left out and, without include_canceled, so are the canceled passengers. A company without the permission in the credential or without a license does not come. As in Monde, the approver and the own operation only come for an agency, and the promoter only for an operator: the field that does not belong to the agency type is not in the response. As it brings the passengers' contact data and documents, each page fetched is recorded in the History as an export of the Passenger List.
| date_field | string Enum: "departure_date" "arrival_date" "sale_date" "canceled_at" Example: date_field=departure_date Date that |
| date_from | string <date> Example: date_from=2026-11-01 First day of the period (ISO 8601, |
| date_to | string <date> Example: date_to=2026-11-30 Last day of the period (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" "canceled" Example: status=opened,closed Sale statuses, comma-separated: |
| include_canceled | boolean With |
| person_id | string <uuid> Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the passenger of this person. |
| payer_id | string <uuid> Example: payer_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this payer. |
| seller_id | string <uuid> Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this seller. Together with |
| intermediary_id | string <uuid> Example: intermediary_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this intermediary. Together with |
| requester_id | string <uuid> Example: requester_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this requester. |
| approver_id | string <uuid> Example: approver_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this approver. |
| promoter_id | string <uuid> Example: promoter_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this promoter. |
| product_id | string <uuid> Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the products of this registered product, including the sales where it is the own operation, as in Monde. |
| supplier_id | string <uuid> Example: supplier_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the products of this supplier. |
| representative_id | string <uuid> Example: representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the products of this representative. |
| city_id | string <uuid> Example: city_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the passengers who live in this city, the one in the person's registration. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Only the sales of these companies, comma-separated. |
| label_id | Array of strings <uuid> [ items <uuid > ] Example: label_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Only the passengers with any of these labels, comma-separated. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
A passenger of an airline ticket with a connection in a closed sale, within a travel, with a seat assigned only in the first segment.
{- "data": [
- {
- "id": "2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "name": "Ana Souza",
- "emission_name": "SOUZA/ANA",
- "gender": "F",
- "birthdate": "1990-05-04",
- "birthplace": "Florianópolis",
- "cpf": "52998224725",
- "rg": "1234456",
- "rg_issuing_agency": "SSP",
- "rg_issue_date": "2008-03-02",
- "birth_certificate": null,
- "passport_number": "FX123456",
- "passport_expiration_date": "2031-02-03",
- "email": "ana@example.com",
- "phone_number": "4833221100",
- "mobile_number": "48999887766",
- "address": {
- "postal_code": "88010000",
- "street": "Rua Felipe Schmidt",
- "street_number": "100",
- "additional_info": "Apto 301",
- "neighborhood": "Centro",
- "city_name": "Florianópolis",
- "state_code": "SC"
}, - "ticket_number": "0472345678901",
- "cost_center": null,
- "canceled_at": null,
- "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10",
- "number": 1024,
- "date": "2026-10-01",
- "status": "closed"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "product": {
- "id": "a2c099e8-d6af-4de5-8d74-3005dd49d632",
- "name": "Passagem Aérea"
}, - "supplier": {
- "id": "3f1c9e20-5d7a-4b6c-9e2f-1a2b3c4d5e6f",
- "name": "Companhia Aérea",
- "city_name": "São Paulo"
}, - "representative": null,
- "departure_date": "2026-11-10T23:55:00",
- "arrival_date": "2026-11-11T17:05:00",
- "destination": "international",
- "document": "ABC123",
- "product_details": {
- "nights": null,
- "accommodation_kind": null,
- "room_category": null,
- "meal_plan": null,
- "cabin_kind": null,
- "cabin_number": null,
- "cabin_category": null,
- "ship_name": null,
- "cruise_destination": null,
- "vehicle_category": null,
- "pickup_location": null,
- "dropoff_location": null,
- "package_name": null,
- "transport": null
}, - "airline_segments": [
- {
- "airline_code": "TP",
- "flight_number": "88",
- "class": "Y",
- "origin": "GRU",
- "departure_date": "2026-11-10T23:55:00",
- "destination": "LIS",
- "arrival_date": "2026-11-11T13:40:00",
- "seat_number": "12A"
}, - {
- "airline_code": "TP",
- "flight_number": "1950",
- "class": "Y",
- "origin": "LIS",
- "departure_date": "2026-11-11T16:10:00",
- "destination": "OPO",
- "arrival_date": "2026-11-11T17:05:00",
- "seat_number": null
}
], - "amounts": {
- "currency": "BRL",
- "amount": 3200,
- "fees": 420.5,
- "other_fees": 0,
- "total_fees": 420.5,
- "du_fee": 0,
- "du_fee_discount": 0,
- "rav_fee": 150,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "customer_amount": 3200,
- "total_amount": 3770.5
}, - "external_number": null,
- "additional1": null,
- "additional2": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Agência Matriz"
}, - "seller": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64",
- "name": "Carlos Vendedor"
}, - "payer": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza",
- "phone_number": "4833221100"
}, - "intermediary": null,
- "requester": null,
- "approver": null,
- "own_operation": null,
- "travel": {
- "id": "8b649124-14e2-4c43-b24f-2423e8db0423",
- "number": "000001",
- "description": "Lua de mel"
}, - "custom_fields": {
- "person": [ ],
- "sale": [
- {
- "id": 12,
- "value": "Indicação"
}
], - "travel": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}The products sold, as the Vendas por Produto report in Monde: one row per product, with the people of the sale, the product details and amounts, the passengers, the invoices and the air segments. It is the same query as the report, so the API and the screen bring the same products. It requires the Vendas por Produto permission of the Vendas por Produto resource, as in Monde. Without the Consultar vendas de outros vendedores/intermediários permission, only the products of the sales the integration itself created come. Through the automatic connection, that permission is an exception granted by Monde on approval. Without the Visualizar comissão, over e receitas permission, the commission object does not come.
The products come from the most recent sale to the oldest and, on the same date, by sale number. Deleted products are left out. A company without the permission in the credential or without a license does not come. As in Monde, with more than one currency (on an operator, or on an agency with multicurrency) the deductions, Additional 1, the invoices and the over base do not come, and the promoter only comes in that case. The External Number and the Additionals without a title in the Settings do not come either. As it brings the payer's contact data and document, each page fetched is recorded in the History as an export of Vendas por Produto.
| date_field | string Enum: "sale_date" "departure_date" "arrival_date" "canceled_at" Example: date_field=sale_date Date that |
| date_from | string <date> Example: date_from=2026-10-01 First day of the period (ISO 8601, |
| date_to | string <date> Example: date_to=2026-10-31 Last day of the period (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" "canceled" Example: status=opened,closed Sale statuses, comma-separated: |
| product_status | Array of strings Items Enum: "active" "canceled" Example: product_status=active Product statuses, comma-separated: |
| seller_id | string <uuid> Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this seller. |
| product_id | string <uuid> Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the products sold of this registered product. |
| supplier_representative_id | string <uuid> Example: supplier_representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the products where this person is the supplier or the representative, as the Fornecedor/Representante filter of Monde. |
| own_operation_id | string <uuid> Example: own_operation_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Only the sales of this own operation. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Only the sales of these companies, comma-separated. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
An airline ticket with one passenger, one invoice and the commission, on an agency without multicurrency.
{- "data": [
- {
- "id": "2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35",
- "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10",
- "number": 1024,
- "date": "2026-10-01",
- "status": "closed"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Viagens Floripa"
}, - "own_operation": null,
- "seller": {
- "id": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
- "name": "Carla Mendes"
}, - "payer": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza",
- "person_kind": "individual",
- "cpf_cnpj": "52998224725",
- "email": "ana@example.com",
- "phone_number": "4833221100",
- "mobile_number": "48999887766"
}, - "requester": null,
- "intermediary": null,
- "approver": null,
- "travel": {
- "id": "4d5e6f70-8192-4a3b-9c4d-5e6f708192a3",
- "number": "000001",
- "description": "Lua de mel"
}, - "product": {
- "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
- "name": "Passagem Aérea"
}, - "supplier": {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "name": "TAP Air Portugal",
- "city_name": "Lisboa",
- "state_code": null,
- "country_name": "Portugal"
}, - "representative": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
- "name": "Consolidadora Sul"
}, - "status": "active",
- "departure_date": "2026-11-10T23:55:00",
- "arrival_date": "2026-11-20T10:15:00",
- "canceled_at": null,
- "quantity": 1,
- "destination": "international",
- "document": "ABC123",
- "external_number": null,
- "additional1": null,
- "additional2": null,
- "product_details": {
- "nights": null,
- "accommodation_kind": null,
- "room_category": null,
- "meal_plan": null,
- "cabin_kind": null,
- "cabin_number": null,
- "cabin_category": null,
- "ship_name": null,
- "cruise_destination": null,
- "vehicle_category": null,
- "pickup_location": null,
- "dropoff_location": null,
- "package_name": null,
- "transport": null
}, - "passengers": [
- {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza"
}
], - "nfs": [
- {
- "id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c",
- "nfse_number": "2026000123"
}
], - "airline_segments": [
- {
- "airline_code": "TP",
- "flight_number": "88",
- "class": "Y",
- "origin": "GRU",
- "departure_date": "2026-11-10T23:55:00",
- "destination": "LIS",
- "arrival_date": "2026-11-11T13:40:00"
}
], - "amounts": {
- "currency": "BRL",
- "unit_amount": 4500,
- "unit_fees": 380,
- "total_products": 4500,
- "fees": 380,
- "other_fees": 0,
- "total_fees": 380,
- "du_fee": 120,
- "cc_du_fee": 0,
- "cc_du_fee_percentage": 0,
- "du_fee_discount": 0,
- "rav_fee": 0,
- "cc_rav_fee": 0,
- "cc_rav_fee_percentage": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "agency_service_fee": 0,
- "discount": 0,
- "total_discount": 0,
- "deductions": 0,
- "billing": 5000,
- "total_amount": 5000,
- "customer_refund": 0,
- "supplier_refund": 0,
- "agency_card_rate": 0,
- "supplier_fine": 0,
- "deleted_balance": 0,
- "kandir_retention": 0
}, - "origin_amounts": {
- "currency": "BRL",
- "exchange_rate": 1,
- "total_products": 4500,
- "total_fees": 380,
- "agency_fee": 0,
- "du_fee": 120,
- "deductions": 0,
- "agency_service_fee": 0,
- "discount": 0,
- "du_fee_discount": 0,
- "rav_fee_discount": 0,
- "total_amount": 5000
}, - "commission": {
- "commission_amount": 450,
- "commission_percentage": 10,
- "over": 0,
- "over_amount": 0,
- "over_percentage": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "revenue": 570,
- "revenue_percentage": 11.4
}, - "custom_fields": {
- "person": [ ],
- "sale": [ ],
- "travel": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}The sale amounts summed by seller, as the Vendas por Vendedor report of Monde: one row per seller and company, with the number of sales and products and every amount column of the report. It is the same query as the report, so the API and the screen sum the same products. A seller who sells in more than one company comes in one row per company. It requires the Vendas por Vendedor permission of the Vendas por Vendedor resource, as in Monde, and does not exist on an operadora. Without the Consultar vendas de outros vendedores/intermediários permission, the sum brings only the sales the integration itself created. Through the automatic connection, that permission is an exception granted by Monde on approval.
The rows come in alphabetical order of the seller. Canceled sales and deleted products are left out. A company without the permission on the credential or without a license is not included. The sale period is required, in date_from and date_to: to sum several years, fetch one period at a time. Each page fetched is recorded in the History as an export of Vendas por Vendedor.
| date_field | string Value: "sale_date" Example: date_field=sale_date Date that |
| date_from required | string <date> Example: date_from=2026-10-01 First day of the sale period (ISO 8601, |
| date_to required | string <date> Example: date_to=2026-10-31 Last day of the sale period (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" Example: status=closed Sale statuses, comma separated: |
| product_status | Array of strings Items Enum: "active" "canceled" Example: product_status=active Product statuses, comma separated: |
| seller_id | Array of strings <uuid> [ items <uuid > ] Example: seller_id=7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f Only these sellers, comma separated. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Only the sales of these companies, comma separated. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
A seller with twelve closed sales in the month, in one company.
{- "data": [
- {
- "seller": {
- "id": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
- "name": "Carla Mendes"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Viagens Floripa"
}, - "sales_count": 12,
- "products_count": 18,
- "amounts": {
- "total_amount": 65421.65,
- "billing": 60441.25,
- "total_products": 58210,
- "total_fees": 4980.4,
- "du_fee": 1450,
- "cc_du_fee": 0,
- "du_fee_discount": 0,
- "rav_fee": 960,
- "cc_rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "agency_service_fee": 0,
- "discount": 178.75,
- "deductions": 0
}, - "commission": {
- "commission_amount": 5390.5,
- "over_amount": 420,
- "intermediary_commission_amount": 0,
- "intermediary_over_amount": 0,
- "revenue": 7616.32
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
Returns the receipts of the companies the credential has permission for. A deleted receipt is not returned.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
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.
{- "data": [
- {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92",
- "receipt_number": "89100000164635",
- "movement_date": "2019-12-29",
- "sale_date": "2019-12-29T18:00:00",
- "cancellation_date": null,
- "boarding_date": "2020-04-10",
- "return_date": "2020-04-15",
- "product_name": "Hotel Internacional",
- "package_name": "MADRI",
- "total_payments": 2068.04,
- "total_taxes": 0,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 0,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 0,
- "opfax": 1826.4,
- "opfax_balance": 200.9,
- "balance": 0,
- "imported": true,
- "edited": false,
- "checked": false,
- "deleted": false,
- "created_at": "2019-12-30T12:14:02"
}, - {
- "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
- "receipt_number": "89930000112199",
- "movement_date": "2019-12-26",
- "sale_date": "2019-12-26T18:00:00",
- "cancellation_date": null,
- "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,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 111.33,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 34.78,
- "opfax": 0,
- "opfax_balance": 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": null
}
}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.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 CVC statement receipt identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of a settled receipt, with sale, sale product and fiscal note.
{- "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
- "receipt_number": "89930000112199",
- "movement_date": "2019-12-26",
- "sale_date": "2019-12-26T18:00:00",
- "cancellation_date": null,
- "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,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 111.33,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 34.78,
- "opfax": 0,
- "opfax_balance": 0,
- "balance": 76.55,
- "imported": true,
- "edited": false,
- "checked": false,
- "deleted": false,
- "created_at": "2019-12-30T08:45:48",
- "movement_kind": {
- "code": 0,
- "name": "BAIXA DE RECIBO"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "contractor": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "seller": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "intermediary": null,
- "sale": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "sale_product": {
- "id": "3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63"
}, - "nf": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "created_by": {
- "id": "1c4d8f2a-5b73-4e91-a6c8-3d90f2e5b174"
}
}Read the receipts of CVC's Master Statement, the "Master Franchise Transfer" ones. The Master Statement exists only in the company enabled as a master franchise agency, in Settings › CVC: a company without that setting is left out of the listing, and reading it by ID returns 403. The receipt has the same format as the CVC Statement.
Returns the Master Statement receipts of the companies where the credential has permission and that are enabled as a master franchise agency, from the latest movement to the earliest. Deleted receipts are not returned.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with an imported receipt.
{- "data": [
- {
- "id": "8a5f1d27-3e9c-4b80-b6d2-1c7e4f9a3b56",
- "receipt_number": "0217000001198",
- "movement_date": "2026-09-08",
- "sale_date": "2026-08-28T15:12:00",
- "cancellation_date": null,
- "boarding_date": "2026-11-03",
- "return_date": "2026-11-10",
- "product_name": "Fácil Internacional",
- "package_name": "LISBOA",
- "total_payments": 6230.5,
- "total_taxes": 0,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 623.05,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 0,
- "opfax": 0,
- "opfax_balance": 0,
- "balance": 623.05,
- "imported": true,
- "edited": false,
- "checked": false,
- "deleted": false,
- "created_at": "2026-09-09T07:05:41"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a Master Statement receipt by its identifier, including a deleted receipt, which comes with deleted true. A receipt of another movement kind returns 404: it is read through the CVC Statement.
| id required | string <uuid> Example: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 Master Statement receipt identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Typed receipt, without invoice.
{- "id": "4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84",
- "receipt_number": "0217000001234",
- "movement_date": "2026-09-10",
- "sale_date": "2026-09-02T00:00:00",
- "cancellation_date": null,
- "boarding_date": null,
- "return_date": null,
- "product_name": null,
- "package_name": null,
- "total_payments": 4800,
- "total_taxes": 120,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 480,
- "retained_commission": 0,
- "intermediary_commission": 96,
- "deposit": 0,
- "opfax": 0,
- "opfax_balance": 0,
- "balance": 384,
- "imported": false,
- "edited": true,
- "checked": false,
- "deleted": false,
- "created_at": "2026-09-10T14:32:05",
- "movement_kind": {
- "name": "Repasse Master Franqueado"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "contractor": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "seller": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "intermediary": null,
- "sale": null,
- "sale_product": null,
- "nf": null,
- "created_by": null
}Query the service invoices: numbering, status, dates, amounts, withholdings and taxes, the recipient data stored on the invoice (with the reference to their city), the NFS-e data and, when getting the invoice by ID, the items and the references to person, company, sale product and sale.
You can also create, edit and delete a standalone invoice and run the actions on it: issue the NFS-e, cancel, record an issuance made at the city hall, adjust the amount, remove the numbering, create a copy for reissue and download the XML. The permissions are the Monde ones: writing and the actions that only change the invoice require Edit, deleting requires Delete, issuing the NFS-e and canceling through e-Notas require Issue NFS-e, and creating the copy for reissue requires Create copy for reissue. Invoices do not exist on an operator (consolidator) installation: there, writing answers 403.
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.
| status | string Enum: "unissued" "issued" "processing" "processing_cancellation" "awaiting_processing" "canceled" "awaiting_issue" "awaiting_cancellation" Example: status=issued Filters by the invoice status.
|
| period_start | string <date> Example: period_start=2023-01-01 Filters the invoices issued from this date on, in ISO 8601 format (YYYY-MM-DD). |
| period_end | string <date> Example: period_end=2023-12-31 Filters the invoices issued up to this date, in ISO 8601 format (YYYY-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Response example with a canceled invoice and an issued invoice.
{- "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": null,
- "nbs_code": null,
- "document": "9572810403321",
- "manual_emission": true,
- "amount": 1840,
- "service_amount": 1840,
- "net_amount": 1748,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Nota cancelada a pedido do tomador.",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": "2023-03-02T09:14:52",
- "created_at": "2023-02-27T10:03:41",
- "recipient": {
- "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": null,
- "phone": "(11) 4831-1245",
- "email": "fiscal@voeazul.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "6d2b8e04-91a7-4c35-8f60-2a7d1c9e5b38"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13302",
- "batch": "8471",
- "protocol": "202302271003410001",
- "verification_code": "K2QW71PZ",
- "processed_at": "2023-02-27T10:05:12",
- "errors": null
}
}, - {
- "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": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 113.48,
- "service_amount": 2613.82,
- "net_amount": 113.48,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": "2023-02-09T17:26:29",
- "canceled_at": null,
- "created_at": "2023-02-09T17:16:14",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": null,
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 5.67,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13299",
- "batch": null,
- "protocol": null,
- "verification_code": "BFLXB50A",
- "processed_at": "2023-02-09T17:26:29",
- "errors": null
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Creates a standalone, unissued invoice in the company of company_identifier. The recipient is the registered person (person_id), with their data and withholdings, or the data sent in recipient, with the withholdings in taxes. Operation nature, CFOP, NBS code and rates come from the company's invoice settings when omitted, and the issue date is today. The invoice amount is the sum of the items, and the taxes are calculated on save. Numbering only comes with the issuance.
Each item may carry a local_id, returned in the response next to the identifier the item received.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ of the issuing company, digits only. Required on create. The invoice company does not change: on edit, the CNPJ of its own company is ignored, and another one answers 422 |
| issue_date | string <date> Invoice issue date |
| operation_nature | string <= 30 characters Operation nature declared on the invoice |
| cfop | string <= 10 characters Operations and Services Fiscal Code (CFOP) of the invoice |
| nbs_code | string Brazilian Services Nomenclature (NBS) code of the invoice |
| observations | string <= 2000 characters Invoice observations |
| person_id | string or null <uuid> Identifier of the registered person who is the recipient. The recipient data and withholdings come from their record |
object (nf_recipient_write) Recipient data typed in the invoice. On create, it comes instead of person_id. On edit of an invoice linked to a registered person, the block only applies with person_id sent as null, the explicit choice of a typed recipient, as in Monde; without it, the block is ignored. A field omitted from the block stays as it is. | |
object (nf_taxes_write) Invoice withholdings. They only apply with the recipient in recipient: with person_id, the withholdings are the person's, and the ones sent are ignored. | |
required | Array of objects (nf_item_write) Invoice items |
Creates an invoice with the recipient data sent, ISS withholding and two items.
{- "company_identifier": "62046591000140",
- "issue_date": "2026-10-16",
- "operation_nature": "Prestação de Serviço",
- "nbs_code": "109051200",
- "observations": "Referente à viagem de outubro",
- "recipient": {
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "city_id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false
}, - "items": [
- {
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500
}, - {
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350
}
]
}Unissued invoice, with the local_id of each item sent.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}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.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example of an issued invoice, with one item and the references to the sale that originated it.
{- "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": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 113.48,
- "service_amount": 2613.82,
- "net_amount": 113.48,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": "2023-02-09T17:26:29",
- "canceled_at": null,
- "created_at": "2023-02-09T17:16:14",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": null,
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 5.67,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13299",
- "batch": null,
- "protocol": null,
- "verification_code": "BFLXB50A",
- "processed_at": "2023-02-09T17:26:29",
- "errors": null
}, - "person": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "created_by": {
- "id": "3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15"
}, - "canceled_by": null,
- "items": [
- {
- "id": "2b7f0c94-6e1a-4d38-a5c2-9f4e1b7d3a60",
- "description": "Prestação de serviço de intermediação de venda de Passagem Aérea",
- "amount": 113.48,
- "service_amount": 2613.82,
- "approximate_taxes_amount": 0
}
]
}Changes an unissued invoice; an invoice in any other status answers 409. An omitted field stays as it is. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). The items list, when sent, is the final list: an item with id stays and changes only what was sent, an item without id is added, and an invoice item that was not sent is removed. The invoice company does not change.
As in the edit screen, saving recalculates the amount and the taxes, and a registered recipient is refreshed with the person's current data. To change the issue date, send only issue_date.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| issue_date | string <date> Invoice issue date |
| operation_nature | string <= 30 characters Operation nature declared on the invoice |
| cfop | string <= 10 characters Operations and Services Fiscal Code (CFOP) of the invoice |
| nbs_code | string Brazilian Services Nomenclature (NBS) code of the invoice |
| observations | string <= 2000 characters Invoice observations |
| person_id | string or null <uuid> Identifier of the registered person who is the recipient. The recipient data and withholdings come from their record |
object (nf_recipient_write) Recipient data typed in the invoice. On create, it comes instead of person_id. On edit of an invoice linked to a registered person, the block only applies with person_id sent as null, the explicit choice of a typed recipient, as in Monde; without it, the block is ignored. A field omitted from the block stays as it is. | |
object (nf_taxes_write) Invoice withholdings. They only apply with the recipient in recipient: with person_id, the withholdings are the person's, and the ones sent are ignored. | |
Array of objects (nf_item_write) Invoice items |
Changes the issue date, changes the amount of one item, adds another and removes the ones not sent.
{- "issue_date": "2026-10-20",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "amount": 1600
}, - {
- "local_id": "linha-3",
- "description": "Intermediação de passeio",
- "amount": 120
}
]
}Unissued invoice, with the local_id of each item sent.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Deletes an unissued invoice. An issued invoice is not deleted (409): cancel it with the cancellation endpoint. An invoice linked to a financial entry is not deleted either (409).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Sends the unissued invoice to the NFS-e issuance through e-Notas. Issuance is asynchronous: the 202 response brings the invoice awaiting issuance (awaiting_issue), and the city hall answers later. Follow it with Get invoice by ID: it goes through processing and ends issued (issued), with the number in nfse.number, or back to unissued (unissued), with the reason in nfse.errors.
Before sending, the invoice clears previous errors, takes the ISS rate from the settings, refreshes a registered recipient and recalculates the taxes. The company must be set up in e-Notas, and the invoice must be unissued (409 in both cases). An invoice with a negative amount is not sent (422).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
The invoice sent to e-Notas, awaiting the city hall's answer.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "awaiting_issue",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Cancels an issued invoice; an invoice in another status answers 409. When the company issues through e-Notas and also cancels at the city hall, and the invoice was not issued manually, the response is 202 and the invoice awaits the cancellation (awaiting_cancellation) until the city hall confirms. Otherwise the invoice is canceled only in Monde, right away (200): cancel it at the city hall as well.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
For a credential that cannot read invoices in the company, the write returns only the identifiers.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Records the NFS-e the agency issued directly on the city hall website: the unissued invoice becomes issued, with the given number and flagged as manual issuance. Without a number, it gets the next one of the RPS series. Only for an unissued electronic invoice (409).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| nfse_number required | string <= 20 characters NFS-e number generated by the city hall, up to 20 characters |
{- "nfse_number": "4521"
}For a credential that cannot read invoices in the company, the write returns only the identifiers.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Increases or decreases by a percentage the amount of each item of an unissued invoice (409 otherwise), rounded to two decimals. The invoice amount becomes the sum of the items, and the taxes are recalculated. If the amount turns negative, the invoice is saved with the error in nfse.errors.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| percentage required | number <double> Adjustment percentage, other than zero: positive increases the amount, negative decreases it (e.g. -10 reduces by 10%) |
Reduces the amount of each invoice item by 10%.
{- "percentage": -10
}For a credential that cannot read invoices in the company, the write returns only the identifiers.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Removes the number and the series of an unissued invoice (409 otherwise), so it is numbered again on issuance. Repeating the removal changes nothing, so this endpoint does not require an Idempotency-Key.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Creates a new, unissued invoice from a canceled invoice (409 otherwise), to reissue it. The copy takes the issue date, the recipient and the items of the original, with the company's current invoice settings; the registered person and the withholdings are not copied, and the taxes are recalculated. The response brings the copy.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
Unissued invoice, with the local_id of each item sent.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Returns the XML file of the issued NFS-e, downloaded from e-Notas or, without it, the one saved in the invoice. An invoice that is not issued answers 409, and an issued one without XML answers 404. Requires only the permission to read invoices.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}Redirects (302) to the PDF of the issued or canceled NFS-e at e-Notas, the address Monde opens in the browser from the invoice. An invoice that is neither issued nor canceled answers 409, and one without the address of the PDF answers 404. Requires only the permission to read invoices.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Invoice identifier. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
{- "errors": [
- "The access credentials are not valid."
]
}Generate the service invoices (NFs) of sold products from the invoice (NF) rules, as in Monde's Gerar Notas Fiscais screen. The flow has two steps: List invoices to generate returns, for each product of a closed sale, the invoices it already has and the ones the generation would save, with the recipient, the amount, the taxes, the rule and the formula; then Generate invoices saves the chosen ones, all or none. The reference company (company_identifier) plays the role of the company the user logs into in Monde: it supplies the operation nature, the CFOP, the tax rates, the issue date and the item template of every invoice, and each invoice belongs to the company of the sale. Generated invoices are unissued and show up in List invoices. The resource does not exist on operator installations.
Returns the products of closed sales (product not deleted) of the companies where the credential can list invoices to generate, from the oldest to the newest by sale date and number, with the invoices the invoice (NF) rules build for each one. Each product gets up to one invoice per recipient of the rule (payer, supplier and representative), valued by the formula minus what the non-canceled invoices of the same product and recipient already covered. A product whose invoices already cover its revenue is left out. Without a period, the list brings the sales from the first day of the month until today. As in Monde, the sales the credential itself created come in; the sales of the other sellers come in the companies where it also has Consultar vendas de outros vendedores/intermediários in Sales. Each page scans at most 2,000 products: in a period where almost everything already has invoices, the page may come with fewer items than size, or empty, with has_next_page true; follow next_cursor until has_next_page is false. Keep the previewed_at of the response: it goes in the generation request. The pages followed by next_cursor return the previewed_at of the first one.
| company_identifier required | string Example: company_identifier=11222333000181 CNPJ of the reference company, which supplies the operation nature, the CFOP, the tax rates, the issue date and the item template of the invoices. Required. |
| date_field | string Enum: "sale_date" "product_start" Example: date_field=sale_date The date the period filters. Required when
|
| date_from | string <date> Example: date_from=2026-10-01 Start of the period, in ISO 8601 format (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 End of the period, in ISO 8601 format (YYYY-MM-DD). |
| supplier_representative_id | string <uuid> Example: supplier_representative_id=0f3c1d52-7f0a-4a55-9a2e-1b6d1c2f3a4b Brings only the products where this person is the supplier or the representative. |
| include_without_revenue | boolean Default: false Includes the products without revenue, with the zero-valued invoices the rules build for them. Default: |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "sale_product": {
- "id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8"
}, - "sale": {
- "id": "1c6e2b7a-0d4f-4b1a-9e3c-5a7b8c9d0e1f"
}, - "company": {
- "id": "3a9d5c1e-2b4f-4c6a-8d0e-1f2a3b4c5d6e"
}, - "sale_number": 1532,
- "sale_date": "2026-10-05",
- "product": {
- "id": "4b2a6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d"
}, - "payer": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "supplier": {
- "id": "7e9a1b3c-4d6f-4e8a-0b2c-5d7e9f1a3b4c"
}, - "representative": null,
- "start_date": "2026-11-10",
- "end_date": "2026-11-20",
- "total_amount": 1500,
- "revenues": 120,
- "nfs_amount": 120,
- "balance": 0,
- "valid": true,
- "errors": [ ],
- "existing_nfs": [ ],
- "new_nfs": [
- {
- "recipient": {
- "kind": "payer",
- "name": "Maria Souza",
- "cpf_cnpj": "52998224725",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Centro",
- "additional_info": null,
- "phone": "(47) 3221-0100",
- "email": "maria@example.com",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "8f0b2c4d-5e7a-4f9b-1c3d-6e8f0a2b4c5d"
}
}, - "person": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "issue_date": "2026-10-16",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "amount": 120,
- "service_amount": 1500,
- "net_amount": 120,
- "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 6,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nf_rule": {
- "id": "2d4f6a8c-9e1b-4c3d-5e7f-8a0b2c4d6e8f"
}, - "nf_rule_description": "Regra do pagante",
- "formula": "Taxa de Serviço",
- "complementary": false,
- "generatable": true,
- "error": null
}
]
}
], - "previewed_at": "2026-10-16T10:15:30.123456-03:00",
- "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Generates the invoices chosen in the list of invoices to generate, identified by the sale product (sale_product_id) and the recipient (recipient_kind). The invoices are built again at generation time, with the same rules, and saved all or none: if a requested invoice cannot be generated (it already exists, has an error or the rule does not build it), nothing is saved and the response is 422. If another generation saved an invoice for any of these products after the given previewed_at, the response is 409 and the list has to be queried again. A product the list would not show (a sale the credential does not reach, invoices that already cover the revenue or, without include_without_revenue, a product without revenue) also refuses the whole request with 422. The credential needs the Gerar Notas Fiscais permission in the reference company and in the company of each sale. The response brings the full generated invoices to whoever can also read invoices in their company; to the others, only the id.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ of the reference company, the same one of the list of invoices to generate |
| previewed_at required | string <date-time> The |
| include_without_revenue | boolean Default: false The same value used in the query: with |
required | Array of objects [ 1 .. 500 ] items The invoices to generate, at most 500 per request, without repeating the same invoice |
{- "company_identifier": "11222333000181",
- "previewed_at": "2026-10-16T10:15:30.123456-03:00",
- "include_without_revenue": false,
- "nfs": [
- {
- "sale_product_id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8",
- "recipient_kind": "payer"
}
]
}{- "data": [
- {
- "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
- "number": null,
- "series": "1",
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 120,
- "service_amount": 1500,
- "net_amount": 120,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:16:02",
- "recipient": {
- "kind": "payer",
- "name": "Maria Souza",
- "cpf_cnpj": "52998224725",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Centro",
- "additional_info": null,
- "phone": "(47) 3221-0100",
- "email": "maria@example.com",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "8f0b2c4d-5e7a-4f9b-1c3d-6e8f0a2b4c5d"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 6,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "company": {
- "id": "3a9d5c1e-2b4f-4c6a-8d0e-1f2a3b4c5d6e"
}, - "sale_product": {
- "id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8"
}, - "sale": {
- "id": "1c6e2b7a-0d4f-4b1a-9e3c-5a7b8c9d0e1f"
}, - "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "description": "Passagem Aérea - venda 1532",
- "amount": 120,
- "service_amount": 1500,
- "approximate_taxes_amount": 0
}
]
}
]
}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.
Returns the system change history, with filters by author, audited record, action and origin. The list brings only the fields of the entry itself; for the author and the audited record, use Get log by ID. The history is scoped by record type, as in Monde: the log of each record type comes to whoever has its "View log" permission (sales, people, accounts payable and receivable, travels, accounts, transfers between accounts, invoices, invoice rules and CVC statement) or, for a record type without that permission, to whoever reads it. The log of the cities, which no longer have a permission, only comes to whoever reads the whole log. In the log of a sale, an entry, an invoice and a task, the permission counts in the company of the record. In the log of the accounts and of the transfers between accounts, the permission in any company shows the log of all of them, as in Monde, which checks "View log" in the company the user logged into, not in the companies of the accounts. The log of a sale, an entry or a task of another user only comes to whoever also reaches the record, as in its get: for a sale, whoever opens it ("Open sales of other sellers/intermediaries"); for an entry, whoever accesses the entries of other users (whole or the slice); for a task, whoever sees the tasks of other users. In Monde the log sits on the record's tab, which only opens with those permissions; that is why the log of a sale, an entry or a task already deleted only comes to whoever reads the whole log. Exports are left out. An entry the credential does not see answers 404 in Get log by ID.
| person_id | string <uuid> Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Filters by the identifier of the author of the change. |
| resource_id | string <uuid> Example: resource_id=9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118 Filters by the identifier of the audited record. |
| kind | string Enum: "insertion" "edition" "deletion" "custom" "export" "email" Example: kind=edition Filters by the recorded action.
|
| origin | string Example: origin=financeiro_categoria Filters by the origin of the change, using the exact value recorded in the log. One value per call. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Returns the history with an edition, a report export and a record creation written by an API request, with no author.
{- "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"
}, - {
- "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": null
}
}Returns a history entry by its identifier, with the references to the author of the change and to the audited record.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identifier of the history entry. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Returns a change made by a person, with the references to the author and to the audited record.
{- "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": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "resource": {
- "id": "9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118"
}
}Query the definitions of the system's custom fields by resource (sales, travels, people, accounts payable/receivable and tasks): the identifier, the name, the kind, whether it is required and the registered options. The value of each field is sent on the sale, the person and the bill.
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.
| resource | string Enum: "sales" "travels" "people" "bills" "tasks" Example: resource=sales Filters by the custom field resource (origin). One value per call; absent lists every resource.
|
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Returns the definitions of sales custom fields, with a list-kind field and a text field.
{- "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": null
}
}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.
| id required | integer Example: 123 Identifier of the custom field to fetch. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Returns the definition of a single list-kind custom field, with its registered options.
{- "id": 123,
- "resource": "sales",
- "name": "Centro de custo",
- "kind": "choices",
- "required": true,
- "active": true,
- "choices": [
- "Matriz",
- "Filial"
]
}List commission plans, as in the Commission Plans registry of Monde. A plan has goal ranges (the percentage of the month goal a person must reach for the range to apply); each range has the all-products entry and, optionally, entries for specific products; and each entry has the commission values of each role: a percentage over sale fields or a fixed amount, and optionally other values for sales with an intermediary. When commissions are closed, the highest range the person reached applies, with the entry of the sold product (without it, the all-products entry) and the rule of the role of the person (without it in the product entry, the one in the all-products entry). Plans are linked to people in the Monde roles registry. The resource exists only for agencies: in an operator installation, every call returns 403. Reading requires the "Visualizar" permission of Commission Plans.
Returns the commission plans, by name.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with two plans.
{- "data": [
- {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
- "description": "Plano padrão"
}, - {
- "id": "8d7c6b5a-4f3e-4d2c-9b1a-0e9f8d7c6b5a",
- "description": "Plano gerentes"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a commission plan with its goal ranges, the products of each range and the values of each role. Ranges come by percentage, the all-products entry comes first in each range, and the field of the type not in use (the fixed amount in a percentage commission, and vice versa) comes as zero.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Unique identifier of the commission plan |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example plan with two ranges: until 100% of the goal the seller earns 3% (1.5% in a sale with an intermediary); from 100%, 5%, and R$ 50.00 per unit of a specific product.
{- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
- "description": "Plano padrão",
- "goal_ranges": [
- {
- "id": "a0b1c2d3-e4f5-4a6b-8c7d-9e0f1a2b3c4d",
- "achieved_percentage": 0,
- "products": [
- {
- "id": "b1c2d3e4-f5a6-4b7c-9d8e-0f1a2b3c4d5e",
- "product": null,
- "rules": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-8e9f-1a2b3c4d5e6f",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "percentage",
- "percentage": 3,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount"
], - "differentiate_intermediary": true,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 1.5,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount",
- "intermediary_commission_amount"
]
}
}
]
}
]
}, - {
- "id": "d3e4f5a6-b7c8-4d9e-9f0a-2b3c4d5e6f7a",
- "achieved_percentage": 100,
- "products": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-8a1b-3c4d5e6f7a8b",
- "product": null,
- "rules": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-9b2c-4d5e6f7a8b9c",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "percentage",
- "percentage": 5,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount"
], - "differentiate_intermediary": false,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 0,
- "amount": 0,
- "calculated_on": [ ]
}
}
]
}, - {
- "id": "a6b7c8d9-e0f1-4a2b-8c3d-5e6f7a8b9c0d",
- "product": {
- "id": "9a8b7c6d-5e4f-4321-8a9b-0c1d2e3f4a5b"
}, - "rules": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-9d4e-6f7a8b9c0d1e",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "amount",
- "percentage": 0,
- "amount": 50,
- "calculated_on": [ ],
- "differentiate_intermediary": false,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 0,
- "amount": 0,
- "calculated_on": [ ]
}
}
]
}
]
}
]
}List the sales goals, as in the Goals screen of Monde. A goal belongs to a person in a role, per year, with the amount of each month; when commissions are closed, what the person sold in the month is compared with the month goal to find the range of the commission plan. This resource is read only: as in Monde, a goal is written through the role, in the "Plan and Goals" of the person. To create, update or delete a goal, send the goals list of the person in people when updating the role, with the "Editar" permission of Person roles. The resource exists only for agencies: in an operator installation, every call returns 403. Reading requires the "Visualizar" permission of Goals.
Returns the goals, from the most recent year to the oldest, with optional filters by year, role and person.
| year | integer Example: year=2026 Year of the goal, with four digits |
| person_role_id | string <uuid> Example: person_role_id=f453b283-750d-4c5d-a493-a6bf8064090e Identifier of the role |
| person_id | string <uuid> Example: person_id=3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 Identifier of the person |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example response with the goal of a seller.
{- "data": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Returns a specific goal by its identifier.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Unique identifier of the goal |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
Example goal of a seller, with their commission plan.
{- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}Bank reconciliation of a checking account: upload the OFX statement exported from internet banking, read the uploaded statements with the summary of what is already reconciled, and discard a statement uploaded by mistake. Linking the lines and verifying the entries are done in the Bank Reconciliation screen of Monde Web. The permission is the Monde one, Bank Reconciliation, in one of the companies of the checking account. Through the automatic connection, the reconciliation is an exception granted by Monde at approval: it reaches the statement and the account movements of the whole account, from any origin.
Returns the statements uploaded to the active checking accounts of the companies where the credential has the Bank Reconciliation permission, newest first. Filter by account with account_id.
| account_id | string <uuid> Only the statements of this checking account (UUID). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Uploads the OFX statement (.ofx or .qfx, up to 5 MB) of an active checking account, as multipart/form-data, and runs the automatic matching. The import is the one of the screen: a line is identified by the account and the FITID, so uploading a period again does not duplicate lines, and the bank correction (CORRECTFITID) is applied when possible. Bank, branch and account number that do not match the account only produce a warning in warnings; a currency other than the account's and a file without transactions are refused with 422. An unknown account, or one that is not an active checking account, also answers 422. It does not take company_identifier: the statement belongs to the checking account, which may be of more than one company, and the Bank Reconciliation permission in one of them is enough.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "multipart/form-data" Example: multipart/form-data Request content type. Must be multipart/form-data. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| account_id required | string <uuid> Active checking account to reconcile (UUID). |
| file required | string <binary> OFX file (.ofx or .qfx) exported from internet banking, up to 5 MB. |
{- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00",
- "situations": {
- "ambiguous": 1,
- "bank_only": 4,
- "system_only": 2,
- "suggested": 10,
- "reconciled": 28
}, - "pending_count": 17,
- "reconciled_count": 28,
- "balance": {
- "date": "2025-01-31",
- "bank": 15230.45,
- "system": 15180.45,
- "difference": 50
}
}Returns the statement with the reconciliation summary: how many lines are in each situation and the bank balance compared with the system balance on the same date.
| id required | string <uuid> Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 Identifier (UUID) of the uploaded statement. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00",
- "situations": {
- "ambiguous": 1,
- "bank_only": 4,
- "system_only": 2,
- "suggested": 10,
- "reconciled": 28
}, - "pending_count": 17,
- "reconciled_count": 28,
- "balance": {
- "date": "2025-01-31",
- "bank": 15230.45,
- "system": 15180.45,
- "difference": 50
}
}Discards the statement: deletes the lines it inserted (a line that already existed from a previous upload stays) and undoes the verification of the entries linked to them. With a verified entry on a closed cash day nothing is deleted and the answer is 422. Does not require Idempotency-Key.
| id required | string <uuid> Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 Identifier (UUID) of the uploaded statement. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The access credentials are not valid."
]
}Get notified when records change instead of polling the lists. A subscription (webhook) belongs to the credential that registered it and is managed through this API.
How it works. Every write to the API records — made by Monde Desktop, Monde Web or the API itself — stores the event in the database, in the same transaction. Every minute the events are grouped and delivered: one POST per event and subscription, with up to 100 records; beyond that, more than one POST is sent. The notice is thin: it carries the event and the ids, and the current state comes from querying the resource. The same record saved several times within a minute is listed once.
{
"id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
"event": "sales.changed",
"resource": "sales",
"occurred_at": "2026-10-16T14:32:10-03:00",
"data": [
{ "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" },
{ "id": "c92f0d13-6b1a-4f7e-8d2c-3e4f5a6b7c8d", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" }
]
}
Events. The catalog is in List webhook events: changed (record created or updated) and deleted for each resource, plus business events (sale closed and reopened, product canceled, commission closed and paid, sale imported from an integration queue, invoice issued and canceled, task overdue, integration import completed and CVC statement import completed). Creation and update are a single event: the notice only carries the id, and the query tells how the record is; if your system does not have the record yet, it is new. A change to an item that is part of the record (product, passenger, segment, commission, attachment and payment of the sale; items, categories and apportionment of the bill; the group of a financial category) generates the record changed event. In business events each item also carries subresource_id, the item that triggered the event (the canceled product, the commission, the imported sale). company_id is null for records that do not belong to a company.
tasks.overdue is a time event: it is sent once per due date, about a minute after the due date passes without the task being completed. A task saved already overdue, or that became overdue while no webhook subscribed to the event, does not generate it. In cvc_statements.import_completed, the item id is the import run, available in Get log by ID to credentials with the Logs permission; the statements it created or changed send their own events. integrations.import_completed says the imported sales queue of the integration was updated. cvc_statements.import_completed is not sent for an import that failed or found no new file. A currency only generates changed, when it is activated or deactivated. Ships and cabins are identified by their name: changing it generates the deleted of the old id and the changed of the new one.
Order and repetition. The order between notices is not guaranteed: if querying an id returns 404, the record was deleted. The credential also receives notices of what it wrote itself: an integration that writes back to Monde when it receives a notice must ignore its own change, or it loops.
Who receives. Only events of resources the credential can read can be subscribed, and a notice is only sent for a record the get-by-ID would return to the credential: the company must grant read access to the resource and have an active license. A deactivated credential stops receiving.
Headers and signature. Each delivery carries X-Monde-Event, X-Monde-Delivery (the delivery id, the same in every attempt: use it to discard repeated notices), X-Monde-Timestamp (seconds since 1970) and X-Monde-Signature, formatted as sha256=<hex>: the HMAC-SHA256 of "<timestamp>.<body>" with the subscription secret. Verify the signature against the body exactly as received and reject old timestamps.
Retries. A 2xx response confirms the delivery. Any other response, connection error or a wait above 10 seconds is retried with increasing waits (1, 2, 4, 8, 16, 32 and 64 minutes), 8 attempts in total. Redirects are not followed. A 410 response means the address no longer exists: the delivery gives up at once, without retrying, and counts as exhausted. After 10 consecutive exhausted deliveries the subscription is deactivated: active becomes false and disabled_at and last_error tell when and why; sending active as true re-enables it. While the webhook is deactivated there are no notices: the deliveries that were pending are recorded as failed, and re-enabling does not resend what changed in that period. After re-enabling, query the resource list to catch up on what changed. Each delivery's history is kept for 30 days in List webhook deliveries.
Address. Only https, and never an internal, local or reserved network address; the check is repeated before each delivery.
Requires the credential's Webhooks permission: read to query, create and edit to register and change, delete to remove.
Lists the authenticated credential's webhooks, newest first. The secret is never returned.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Registers a webhook for the authenticated credential. Send the secret (32 to 255 characters; an empty one is refused) or omit it so the API generates one: the generated secret comes only once, in this response, in the secret field. Each event must be in the catalog and belong to a resource the credential can read. Requires Idempotency-Key.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| url | string <uri> https address that receives the POST. Internal, local or reserved network addresses are refused. |
| description | string or null <= 255 characters Free description, up to 255 characters. |
| events | Array of strings non-empty List of catalog events of resources the credential can read. Cannot be empty. |
| active | boolean Whether the webhook receives deliveries. |
| secret | string [ 32 .. 255 ] characters HMAC-SHA256 signing key, 32 to 255 characters. Write-only. |
{- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
]
}{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00",
- "secret": "aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4"
}Returns a webhook of the authenticated credential. Another credential's webhook responds 404.
| id required | string <uuid> Webhook ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}Changes only the fields sent: {"active": true} re-enables a deactivated webhook without resending the secret. The events list sent replaces the previous one. A secret sent replaces the secret and is not returned. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). Requires Idempotency-Key.
| id required | string <uuid> Webhook ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
| Idempotency-Key required | string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][... Example: 550e8400-e29b-41d4-a716-446655440000 Client-generated idempotency key (UUID v4). See the Idempotency section for more details. |
| url | string <uri> https address that receives the POST. Internal, local or reserved network addresses are refused. |
| description | string or null <= 255 characters Free description, up to 255 characters. |
| events | Array of strings non-empty List of catalog events of resources the credential can read. Cannot be empty. |
| active | boolean Whether the webhook receives deliveries. |
| secret | string [ 32 .. 255 ] characters HMAC-SHA256 signing key, 32 to 255 characters. Write-only. |
{- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
]
}{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}Deletes the webhook and its delivery history. Pending deliveries are not made.
| id required | string <uuid> Webhook ID. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "errors": [
- "The request could not be processed due to a syntax or formatting error. Ensure that all parameters, such as the request body, are correct before trying again."
]
}Delivery history of the last 30 days, newest first: the body sent, the number of attempts, the last response code and the last error.
| webhook_id required | string <uuid> Webhook ID. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor of the next page, exactly as it came in |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Number of records per page |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
- "event": "sales.product_canceled",
- "status": "delivered",
- "attempts": 1,
- "response_status": 204,
- "last_error": null,
- "payload": {
- "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
- "event": "sales.product_canceled",
- "resource": "sales",
- "occurred_at": "2026-10-16T14:32:10-03:00",
- "data": [
- {
- "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21",
- "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab",
- "subresource_id": "9ba44a55-8c48-49d2-98ac-d397702ec961"
}
]
}, - "delivered_at": "2026-10-16T14:33:02-03:00",
- "created_at": "2026-10-16T14:33:01-03:00",
- "updated_at": "2026-10-16T14:33:02-03:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Catalog of the events a webhook can subscribe to, with the description and whether the authenticated credential can subscribe to them (subscribable, when it can read the resource).
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Access credential provided by the travel agency, in the Bearer scheme. |
| Content-Type required | string Value: "application/json" Example: application/json Request content type. Must be application/json. |
{- "data": [
- {
- "name": "sales.closed",
- "resource": "sales",
- "action": "closed",
- "description": "Venda fechada",
- "subscribable": true
}
]
}The most common questions about the v3 API, with a short answer and a link to the section that covers the subject in detail.
v2 still works, but it is legacy and no longer receives updates: every integration should use v3, which is the one in this documentation. v3 authenticates with the credential the agency generates; v2 uses the login and password of a Monde user and has its own documentation.
Send the credential in the Authorization header with the Bearer scheme, as shown in Authentication. The credential does not expire, but the agency can revoke it at any time.
In Monde, under Cadastros > Integrações, in the API Monde integration. That is where the agency picks the credential permissions, per company and per resource, and from there it hands the credential to whoever is integrating.
Yes. When generating the credential, the agency grants only the read permissions of the resources it wants to share. Writes answer 403.
Yes. One credential accesses every company of the agency that was granted permission on it. Every company with an active Monde license can be used by the API, with no separate license. A read-only company is only read: writes to it answer 403 with "The company is read-only: its records can be read through the API, but not written.".
As in Monde, each permission applies to what the credential itself created, and the "of others" permissions extend the reach to the rest: in sales, Consult, Open and Edit sales of other sellers; in accounts payable and receivable, Access entries of all users and of the system or one of its slices (client invoices, supplier invoices, credit card invoices, entries with an own operation and with a sale); in tasks, See tasks of other users. A travel belongs to the credential when the credential created it or created one of its sales, and the other travels follow Consult sales of other sellers. Listing and getting require the "View" permission of the resource also for what the credential itself created, as in Monde, where the record does not open without it; without that permission the update response brings only the identifiers, and the creation response brings the whole created record. A record of another user outside the reach answers 404; one it reads but cannot change answers 403 with the Monde message. A credential generated before these permissions keeps reaching every record, as before.
Either the credential lacks the permission for that resource, the company has no active Monde license or is read-only on a write, or the resource requires the Monde Pro license, as Guides do. The response message says which cause it is. When it is the permission, there is no need to generate a new credential: the agency only has to grant the permission on the existing one.
Through Automatic connection. The agency authorizes the partner inside Monde, without sharing a credential, and the permissions are the ones set when the partner was approved.
Not for now: the API serves the production data of the agency. While developing, start with queries, using a read-only credential, and use idempotency on writes so that repeating a request does not duplicate records.
The limit applies to a short time window, counted per IP, and there is no daily or monthly quota. The values and what to do on a 429 are in Rate limits.
By cursor, with up to 50 records per page. Repeat the query sending the next_cursor of the previous response while has_next_page is true. See Pagination.
Yes. The API reads and writes the same database the agency uses in Monde, with no copy or sync delay.
Yes, with the credential created by the agency itself: register an https address in Webhooks and receive a signed POST when records change. The Webhooks permission is not offered through the Automatic connection: there, the integration queries the API periodically. For sales, the updated_since filter brings only what changed since the last query, including a change to a part of the sale, such as a product, passenger or payment.
Through the Changelog, which records every change with its date and highlights the ones that alter the contract. The API is in beta, so fields and endpoints may still change. The badge on each endpoint tells whether it can already be used: see Endpoint availability.
Yes. Any tool that makes HTTP requests with the authentication header can consume the API. For AI agents that write code, the documentation is also available as text at https://web.monde.com.br/llms.txt.
In List sales, pick the date in date_field (sale, departure or return date) and send the range in date_from and date_to.
Use updated_since in List sales, with a date or a date and time. It also brings a sale entered with a past date, because it looks at when the sale was changed, not at its date, and it brings the sale when one of the parts shown in Get sale by ID changes, such as products, passengers, payments and linked bills. The full list is in the filter description. Keep the instant the query started, before the first page, and start the next query from it with an overlap of a few minutes before it. Upsert each sale by id, and send status=opened,closed,canceled to also receive deletions. Today this filter exists only for sales.
Use people_id with the person ID, which you can look up in List people. The filter brings every sale in which the person appears in any role: payer, passenger, seller, supplier. To split by seller or by company, use the seller and the company that come in Get sale by ID.
List sales brings the main data and the totals of each sale. Products, payments, commissions, attachments and custom fields come in Get sale by ID.
By default, the query brings only open and closed sales. For deleted ones, send status=canceled.
Suppliers, representatives, payers and passengers are person records. Look them up in Get person by ID and keep the result so you do not repeat the same query for every sale.
Not under those names. The sale brings the value of each product, the fees, the commissions and the over, the revenue and the totals, and each integration builds its own indicators from those values.
No. The API delivers the records, and the report is built on the integration side, from the queried sales.
In Accounts Payable and Receivable, Account movements, Refunds and Invoices. The sale detail also brings the bills it generated.
Yes, in Create a sale, one sale per request. The accepted products and the required fields are in the operation description.
No. Each request writes one sale. For volume, send them one after the other, within the rate limits.
Send the Idempotency-Key header, required in Create a sale. While the key is valid, repeating it returns the response of the first request, without writing again. The key expires after at least one day. See Idempotency.
In the sale, each person is looked up by the external_id your integration sent before and, without that link, by the CPF or CNPJ. The person is registered only when neither finds it. Always send the CPF or CNPJ to reuse the record that already exists in Monde.
People, tasks, attachments and accounts payable and receivable. The badge on each operation tells whether it is already available, and the Changelog records every new operation.
Yes. In Travels, the integration creates, updates and deletes travels and links or unlinks their sales, with the Edit and Delete permissions of Travels. The travel created by the credential is its own: updating, deleting and linking sales to it do not require Consult sales of other sellers, which the travels of other sellers and of other credentials require.
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.
details of guides and quotes now accepts data-carousel="thumbnails" on the paragraph of the carousel images, which shows thumbnails below instead of dots. Any other value, or the attribute on another tag, is dropped. ) between them.cover_kind (color, image, or none), cover_color, cover_show_title, cover_show_subtitle, and cover_image_url.cover_kind, cover_color, cover_show_title, and cover_show_subtitle. The cover image can only be chosen in Monde Web. Without a cover, a new quote gets the color cover, in the primary color of the company's Quote Settings.subtitle and details are no longer required: they can be omitted on creation, and null clears them on update.seller who is an inactive seller in Monde is now rejected with 422, as in Monde, instead of answering 500. A credential without the permission to edit Sellers still receives 403, as for a seller not yet registered. On update, the seller the sale already has is still accepted, even if inactive.color, image, or none, like the quote cover, and guides also return cover_show_title, cover_show_subtitle, and cover_image_url. Guides that had the default cover moved to color, in #5f6777.cover_show_title and cover_show_subtitle. hide_cover_text is still accepted and stands for both, and the default cover is still accepted and works as color in #5f6777. Without a cover, a new guide gets the color cover in that color.details is no longer required: it can be omitted on creation, and null clears it on update.details of quotes now accepts the three guide blocks: highlight box, section with a background image, and two columns, as <div data-block>. Before, they became plain text.details of guides, the highlight box is now text only: an image goes to a paragraph right after it, and a table, quote, code, or horizontal rule goes after it. The section with a background image keeps only the first image, and the others are discarded.kind of List logs and Get log by ID now returns email for an e-mail sent from the record, such as the billet or the invoice of a bill. The description lists the recipients and the attached files. The kind filter of List logs now accepts email.kind, outside the documented set (Enviado por e-mail). Whoever read that value now receives email.reprocessed_items: for each item sent, the invoice it ended up on (bill) and the item on it (item), which is another one when the destination invoice already had an equal item and both were added together. When all items leave and the invoice is deleted, the response is no longer 204 without a body: it is 200 with only reprocessed_items.id of an item that is added to an equal one, in Change the checked status or cost center of an invoice item: it ceases to exist, and the valid ids are those in items of the response. Nothing changes in the behavior of these actions.Idempotency-Key now returns the original response, with X-Idempotent-Replay: true, instead of 404. It applies to Remove items from the invoice or recalculate the due date and to Bill the invoice items separately. A new key on the deleted invoice still answers 404.overpayment_return in the agency Outros payment (payments[].agency.others), in Create sale and when adding a payment through Update sale: with true, the payment is the Return › Generate Account Payable of Monde (Devolução › Gerar Conta a Pagar), which gives back to the customer what was paid in excess. It is only accepted when some product has a negative customer balance before it. The amount of each product carries the sign of the customer balance of that product (negative on a product with a negative balance, positive on the others), and a sign that does not match is refused with 422. It writes an open bill, a debit when the sum is negative, with the customer payment and receipt categories. It does not accept description nor details. Also valid on an operator installation. It requires the same permission to edit sales.recurrence_scope, remove_settlement, undo_bank_reconciliation), Undo the settlement with confirmation (recurrence_scope, undo_bank_reconciliation), Delete refund with confirmation (remove_from_bill), Delete transfer with confirmation (undo_bank_reconciliation) and Delete category group with confirmation (delete_categories).204 without a body on success, 409 without the confirmation, 422 with a confirmation out of format. All of them require Idempotency-Key.409, and the message points to the POST to use. A recurrence_scope sent in the DELETE answers 422, pointing to the POST: ignored, it would make deleting or reopening a single entry look like the whole series. Without a confirmation, the DELETE stays the same.payer_id, or the one of the sale), the cost center and the amount of each product, with the sign of its customer balance. It answers 202: the items to invoice are recorded, and the automatic invoicing takes them to the customer invoice right after.reopen_sale and the permission "Reabrir venda" (reopen sale); a settled invoice only with remove_settlement; a closed invoice, reopened first.payments[].agency.to_invoice leaves the creation and the update of the sale and is now ignored, as an unknown field. On the update, the payments list neither keeps nor removes the to-invoice payment and the to-invoice return: they only change through the endpoints above.payments.agency.to_invoice when reading the sale is read only and changes shape. Each item is a to-invoice line that already entered a customer invoice, per invoice and cost center: bill, cost_center, amount (with the sign; negative is a to-invoice return) and products (sale_product and amount). Out go id, due_date, description, payer, bills and the id of the products: the payer and the due date are those of the invoice. A to-invoice payment that has not entered an invoice yet does not show. The to-invoice return, before only referenced by the invoice in payments.agency.bills, now shows in the line.visas[]) in Create a sale, Update a sale and Get sale by ID. It is a system product, like the Excursion: there is no need to inform the product, and it becomes active on its first sale. Own fields: visa_type (visa type, required, up to 50 characters, such as "Turismo") and destination_country (visa country, required, ISO 3166-1 alpha-2 code, such as "US"; a code outside the country list is rejected with 422).passengers[].fees, and the agency service fee in the product's agency_service_fee.kind filter of List sales and Products now accepts visa, and the product kind now returns visa.side: customer or vendor), the kind (kind), the sale product document (document), the issue date (issue_date) and the person (person). With them, a supplier invoice payment breaks down into each sale: what was paid to the supplier and what was received from the customer.date_field=movement_date and date_from/date_to.bill_id), account, person, side (side) and period (date_field = settlement_date, due_date or issue_date). With it, the breakdown of the month's payments comes in one query, without a call per invoice. Requires the "Visualizar" permission of accounts payable and receivable, already granted to whoever reads the entries.apportionments on a credit card invoice (credit_card_invoice), like the Rateios tab of Monde. The apportionments split the final amount of the invoice, which is the sum of the card purchases. Categories are still refused.date_from and date_to) and also filters by sale and product status, seller and company.sales_by_sellers.read_all) and "Consultar vendas de outros vendedores/intermediários" (sales_by_sellers.read_from_other_sellers), unchecked on existing credentials./64 network, not per address: every address in the same /64 network adds up to the same limit. Nothing changes over IPv4.balance_resolution: category now goes through the company's surcharge and discount block, as in Monde. Above the limit, the request is rejected with 422.sales_by_products.read_all), "Consultar vendas de outros vendedores/intermediários" (sales_by_products.read_from_other_sellers) and "Visualizar comissão, over e receitas" (sales_by_products.view_commission_columns), unchecked on existing credentials.search. The parameter is ignored and the list comes without it; to narrow the list, use the other filters of each one.undo_bank_reconciliation is now required only when the change alters the amount, date or account of a reconciled movement, like the Monde warning. A change that does not touch the reconciled movements (categories, apportionments, description and other data) is written without the confirmation and keeps the reconciliation. Requests that already send the confirmation keep working as before.external_id is no longer accepted on the sale products or on the products[] of the payments. A product is identified only by local_id (required, up to 50 characters and unique within the sale), and a payment points to the product by sale_product_local_id or sale_product_id. A product without local_id and a payment item without a product reference are rejected with 422.credit_card_invoice) in every agency, with the Monde locks. It no longer answers 409 for not having its edition released.details of guides accepts three blocks: highlight box, section with a background image, and two columns, as <div data-block>. The format is in the field description. Nothing changes for quotes.cover_kind (default, image, or color), cover_color, hide_cover_text, and cover_image_url.cover_kind, cover_color, and hide_cover_text. The cover image can only be chosen in Monde Web.subtitle is no longer required. On update, sending it as null removes the subtitle. Nothing changes for integrations that already send the subtitle.external_number, additional1 and additional2, with up to 20 characters each. Each agency gives these fields its own title (for example, "Nº Pedido").passenger_lists.read_all) and "Consultar passageiros de outros vendedores/intermediários" (passenger_lists.read_from_other_sellers), unchecked in the existing credentials.calculated_oncalculated_on can bring customer_refund, vendor_refund, agency_card_rate, supplier_fine and deleted_balance, when the plan is calculated over these values.use_sale_data, each sale payment takes the payment method and the check or card data of its own sale.422). Before, this applied only with multicurrency.409: deactivate the currency you do not use.404:/settings (the tabs, e-mail, e-Notas and the certificate, Blocks, Security, CVC, licenses, quote and guide settings, and the company registration in /settings/company, which Update person already covers) and /payment_method_details./integrations, /integration_vendors, the product and person links, /integration_credentials and /supplier_authorizations. Reading the integrations stays./commissions, /commission_closings and /commission_payments, and creating, updating and deleting commission plans. Reading the plans stays./cvc_statements and /cvc_master_statements, everything but the list and the detail; and the statement closings, /cvc_imports and /cvc_deposit_checks.currency), among the active ones, when Monde works with more than one: on a tour operator or with multicurrency. When omitted, it stays in Real. The movements of the settlement made on creation now accept exchange_rate and reference_exchange_rate, as the settlement does.currency).movements without id now adds a new movement to a settled entry, like Monde's Adicionar, with installments (installments) on a credit card account. Before, every movement needed the id.billing_account_id) and the bank slip demonstrative (billet_demonstrative), like Monde's Boleto tab. On an open client invoice, the billing account answers 409 until the request brings close_invoice as true, which closes the invoice along.close_invoice as true, which closes it first, as Monde does), and Download the bank slip PDF.sales.print_billet) and "Gerar boletos" (bills.generate_billet), unchecked on existing credentials.bills.close_invoice) and "Reabrir Fatura" (bills.reopen_invoice), unchecked on existing credentials.items in Get payable or receivable by ID now brings its id, which the actions below take.bills.change_card_fee), for correcting values, and "Alterar dados do produto em vendas fechadas" (sales.edit_product_closed_sale), when the correction changes the product of a closed sale.sale_standalone) and the commission (commission) are now settled and reopened like the standalone entry, as in Monde. Before, they answered 409. The permissions are the same as for the standalone entry.hotels, cruises and car_rentals now returns document, the passenger's identification in the product, such as the room or cabin number.document (up to 30 characters). Before, it was discarded. Attention: on update, a passenger sent without document is left without it, as in the other products; send back the value read to keep it.POST) and update (PATCH), empty text ("") now follows a single rule: on a text field it is saved as sent; on a required text field it is refused (422); on a field of any other type (object, list, number, boolean, date, option or reference by id) it is refused (422). To remove a value on an update, send null. The rule is in the introduction of this documentation."" varied by endpoint. On a create, it counted as a field not sent. On an update, depending on the field, it cleared the value like null, was ignored (including objects and lists, such as the sale seller and payer, which answered 200 without changing anything) or left the value as it was. An integration that sends "" expecting nothing to happen now saves the empty text or receives 422.cpf_cnpj field when the CPF/CNPJ stored on the person is not valid, whatever field is being changed, as in Monde, which checks the document on every save. To unlock it, send the corrected cpf_cnpj, or null to remove it. Previously the update raised an internal error (500).advance) or of the deposit (deposit) with the open vendor items of financial.vendor_items, each with the amount to generate, as the Generate Standalone Payment or Deposit and the Vendor Deposit of Monde. An amount smaller than the item splits the item, and the rest stays open. It answers 201 with the generated invoice. It requires the permission to edit sales, "Ver aba financeiro" (view the financial tab), except on deposit with product_id (the vendor deposit of the product), and "Gerar Fatura" (generate invoice) when the automatic vendor invoice is off or the sale is a CVC one.bills.generate_supplier_invoice) in the credential.financial.vendor_items: the vendor items of the sale, as in the Financial tab of Monde, each with id, kind, description, due_date, amount, currency, the product (sale_product), the vendor or representative (person), the entry it is in (bill) and the direct payment to the vendor that settles it (payment). It comes with "Ver aba financeiro" (view the financial tab), as the rest of financial.sale_id: it posts the account payable or receivable on the sale, like the button on the sale Financial tab in Monde. The entry is created as a sale standalone entry (kind equal to sale_standalone), in the sale company, and shows up in financial.standalone_bills of Get sale by ID. With sale_id, company_identifier may be omitted and, when sent, it must be the CNPJ of the sale company. It also requires the "View financial tab" permission on sales, in the sale company. A closed sale accepts the entry, and a deleted one answers 409. operation_id and recurrence_kind are rejected with 422 on a sale entry, and without account_id it has no forecast account, as in Monde.kind returns: sale_standalone, vendor_standalone and customer_invoice. The API did not change.attachment_ids: the attachments already uploaded to the task through Upload attachment are linked to the comment and show inside it in Monde. With attachments, the text is optional. An attachment of another task, deleted or already linked to another comment answers 422. It requires the same permission as commenting.history entry now returns its attachments in attachments. Attention: the text of a comment with an attachment made in Monde now comes without the (att:<id>) markup Monde stores in place of the file.next_bank_slip_number: the number of the next bank slip the checking account issues. It is null on other accounts.recalculate_open_invoices. With true, after saving the update, the due dates of open invoices that fall under the rules of the person are recalculated in the background, like the Monde "Recalcular vencimentos" button. Omitted or false, nothing changes: only the rule is saved. A value that is not a boolean answers 422.delete_categories: true. Without the confirmation, the response is still 409. If any category is used in a financial entry or in a Monde setting, nothing is deleted (409). A value other than true or false responds 422.passengers list of a product now changes the same passenger, as in Monde, instead of deleting and recreating the list. The passenger is identified by the person: an active passenger has that same passenger changed, a new person is added and an active passenger not sent is removed.person.id alone, as the sale get returns it, besides the person data with the external_id. The person pointed to by the id is not changed, and the id requires the permission to read people; without it, or with a legal person, the response is 422.id and the method it was added with is now changed, as in Monde, instead of refused. The payer, the due date, the description and the method data (card, check, details, observations and the cost_center of the to-invoice payment) change, and only what was sent; the payment id stays the same.products, the account and the settlement in a change are refused with 422, and so is another method. To change them, remove the payment from the list and add a new one, as before.cvc_original_data: the original data of the invoice imported from the CVC file, which Monde shows in the CVC tab of the invoice. It is null when the invoice did not come from that file. It also comes in every response that returns the invoice, such as the writes on /nfs and the invoice generation, and requires the same permission as reading invoices.agency, cash, check and others; in vendor, check (check paid directly to the vendor). Each check payment is one check, with a required check_number, bank_code and the CPF/CNPJ in document.details in its observations. The check paid to the vendor does not create a bill.resource_type travel and task. As in Monde, attaching asks Add attachments and the permission to edit the travel or the task, in its company.id stay the same records, the ones without id are added and the ones left out of the list are removed. A plan in use by someone in a role is not deleted (409).goals list of each person in people of Person roles, with the Edit permission of Roles. The person role query now brings the goals of each person.403.changed and deleted for ships, cabins, task categories and financial categories; currencies.changed (currencies only notify the update); the overdue task (tasks.overdue); and the completed import (integrations.import_completed and cvc_statements.import_completed).vendor_id and the credential user_id and integration_id, which do not change after creation, are ignored as well./settings/payment_blocks, to read and update the Blocks of Payables and receivables (surcharge and discount, movement and due days), with the Configurar bloqueios permission, the same as in Monde, which the Payables and receivables tab permission does not open. Every change goes to the company log, field by field./settings/security, which tells whether Monde asks for the e-mail code when signing in on a new computer (Settings - Security); and /settings/cvc, with the CVC features and the statements FTP, without the password (only ftp_password_configured), whose update is always refused (409), because in Monde only a user with full access changes the CVC tab (Settings - CVC).updated_since considers the parts of the saleupdated_since filter also brings the sale when one of its parts changes, not only the header: products, passengers, segments and seats, commissions, attachments, payments and the addition, cancellation or deletion of the linked bills. This applies to changes made in Monde, through the API or by any other means. Settling a bill only brings the sale back when it changes the agency card fee of the products or when it is partial and creates the balance bill. Attention: the sync starts receiving sales that used to be left out.status=opened,closed,canceled along.person_id) or the data sent in recipient; the amount is the sum of the items, and the taxes are calculated on save. Only an unissued invoice is edited or deleted (409 otherwise). On edit, the items list sent is the final one: an item with id stays, one without id is added and one not sent is removed. Each new item may carry a local_id, returned in the response next to the generated id.id of each item, used to keep the item on edit.recipient only applies with person_id sent as null, the explicit choice of a typed recipient, as in Monde; without it, it is ignored, and resending the body that was read does not unlink the person.created_by or canceled_by: it was written by the credential, recorded in the log.nf_generations.access), the same as in Monde, which lists and generates. As in Monde, it reaches the sales the credential itself created; the sales of the other sellers also require Consultar vendas de outros vendedores/intermediários in Sales.product, payer, supplier and representative as { "id": ... }, representative_scope, and the invoice of each recipient in payer_rule, supplier_rule and representative_rule, with recipient, revenues and discounts. The update changes only what was sent, and a list sent is the final list. The same application has only one rule and the same value goes into the invoice of only one recipient (422). An operator installation, which has no rule registration, answers 403 to writes.created_by null); the rule log tells which credential wrote it.revenues and discounts, refuse with 422 a list sent as text or object and an item that is a list or an object, like the other fields.representative_scope now comes as the Monde screen opens the rule: a rule saved without the representative mark and without a representative, which reaches no sale, comes as none (before, any), and one with the chosen representative comes as specific even without the mark (before, it could come as none).person_kind and person_id), and saving follows the same rules as the Monde screen. As in Monde, creating, updating and removing the rule of a person who has other rules require the Billing Rules Edit permission; deleting the last rule of a person, which also removes the rule set of that person, requires Delete. In the Automatic connection, writing and deleting billing rules is an exception granted by Monde on approval, because they apply to the whole agency.expense or revenue) does not change after creation, and a group with categories cannot be deleted (409). Uses the Categories permissions.Idempotency-Key, and a field the endpoint does not document is ignored, as in the rest of the API.POST /cvc_statements), Update a receipt (PATCH, an omitted field stays), Delete a receipt (logical deletion) and Restore a receipt. The receipt actions became sub-resources: link and unlink the sale by the receipt number, process the OPFAX settlement and close the sale. The permissions are Monde's: creating a receipt, linking the sale, processing OPFAX and closing the sale only require reading the CVC statement (the last two also the one to close sales); updating requires the new Edit records or Edit imported records, and deleting, restoring and unlinking the sale require Delete, Restore and Unlink Sale from Receipt, the company with the CVC store features turned on, and does not exist in an operator database.movement_kind) now also returns the CVC code (code), which is what the creation gives in movement_kind_code.company_identifier) and one period at a time: Get the closing summary, List the closing movements, each one with valid, Mark a movement as checked and Close the statement, which creates the vendor invoices and returns their id. To reopen, delete the generated invoice with Delete account payable or receivable./cvc_master_statement_closings.expected_total, the reviewed total amount, and is refused with 422 when the invoiced amount differs. The company must have the CVC store features enabled (or the master franchise agency, for Master); without them, the response is 403 telling what to enable.GET /cvc_deposit_checks and GET /cvc_deposit_checks/{id}, with each statement movement's deposit next to what was invoiced, retained and received from the client and the balance. Filters period_start, period_end and only_closed_sales (default true, as in Monde). Requires the new CVC Deposit Check permission.202, and the status tells when it finished. Requires the new Importação de Extratos (statement import) permission, as in Monde, where the same permission opens the screen and imports: it covers reading, importing and turning the automatic import on or off.POST (HMAC-SHA256) when records change: one notice per event, with up to 100 ids and the company of each. Endpoints to list, create, get, update (PATCH) and delete webhooks, the delivery history (GET /webhooks/{webhook_id}/deliveries) and the event catalog (GET /webhook_events): changed (created or updated) and deleted for each resource plus the sale and invoice business events. Delivery with retries and increasing waits, and deactivation after consecutive failures.additional_fields, and the query by ID now brings them, with a value only in the service address and the agency's identification; user, password, token, API keys and PIN are never returned (filled says whether they are filled). The query now also brings the vendor_id./integrations/{integration_id}/product_links and /integrations/{integration_id}/person_links, with query, creation, update and deletion. Since the link applies to every integration of the vendor, writing and deleting require the permission to create and edit integrations in each of them.password_filled says whether it is filled). Reading requires the new Ver Aba Usuário (User tab) permission in People, like the User tab of the person record in Monde; creating, updating and deleting also require Edit in People.active equal to false. There is no creation through the API.delivery, the delivery of the access to the partner on a connection started by the agency: pending, delivered or expired, as the Integrations screen shows.POST /oauth/connections with the client_id and the client_secret. The response carries the connections in data and the API pagination node. Each connection is delivered only once and waits for the poll for 72 hours; after that, the integration is deleted in the agency account. The partner is only listed for the agency after checking Connection started by the agency in the partner area. See step 7 of Automatic connection./settings/{tab} for General, Sales, Receivement, Payables and receivables, Commission, Goals, Customer invoice, Supplier invoice, Fiscal notes and Travel card export. An update writes only the fields sent, with the screen rules, and goes to the company log. Each tab requires the Monde permission for it (such as Configurações - Geral), which allows reading and updating the tab./settings/email, to read and update the server and the sender of the company e-mails, with the Monde permission Configurações - E-mail (Geral). The server password can only be set./settings/company, to read and update the company registration (name, legal name, registrations, contacts and address; the CNPJ does not change), and /settings/licenses, to read the licenses of the companies. They require the new Company registration and licenses permission./settings/enotas, to read and update the company NFS-e issuance through e-Notas (regime, rates, series and RPS, test environment and city hall access), and /settings/enotas/certificate, to send the digital certificate as multipart. Username, password, token and certificate can only be set: reading tells only whether they are configured and the certificate expiration. Requires the permission of the Fiscal notes tab, the NF configuration of Monde.name filter of List cities now also finds the city by its other names in Monde's city list: ?name=New York and ?name=Nova York find Nova Iorque, ?name=Asunción finds Assunção. It also finds by the start of the words, by the state and by the country, like Monde's City field. A part anywhere in the name still matches.name filter, the list is no longer in alphabetical order: the city whose name is the one sent comes first, then the one that has it among its other names, the one whose name starts with it, the one that contains it and, last, the others; within each group, the largest first. Without the filter, the order is still by name. The cursor of a search is only valid for the same name.'insurances passengers person name' did not say which insurance or which passenger; now it comes as 'insurances[0] passengers[2] person name'. It applies to the sale products, passengers, segments, seats, payments and their products, commissions, contacts, history and custom_fields. Two items with the same error now get one message each. Note: integrations that compare the message text need to account for the position.The 'movements[0] check' field must be a list or an object…. An item that is not an object is now pointed at by its position: The 'labels[1]' field must be an object….'credit_cards[1]': <sentence>, instead of being appended to the field name. It applies to the person's credit_cards, cost_centers and kandir_law.'commissions'), instead of one message per commission. An intermediary commission on a sale without an intermediary now answers on 'commissions[0]', with a message that reads as a continuation of the field name."contacts": [null] or [""]) now answers 422. Before, it was ignored, and the items after it shifted position. A whole list sent as null keeps working as before.birthplace) is no longer created. Without city_ibge, city_name is looked up among the agency's cities and the ones in Monde's city list (List cities), ignoring accents and case: in Brazil, in the state of state_code; abroad, in the country of country_code.state_code is first looked up as "Name, ST", the form in which the API used to register these cities, and then by name alone in the country.422 on city_name, and nothing is saved. Before, the city was created with the name sent.agency.credit_card) now records the card fee, as in Monde. Without a fee in the payload, the "Taxa cartão de crédito" Sales setting applies. To send another one, use card_rate_percentage (%) or card_rate (amount), one of the two. The fee is split into the agency_card_rate of the paid products and reduces the bill final amount in the company card fee category. Without that category set, a fee above zero answers 422. Note: integrations that already send this payment now get the company default fee when it is set; to keep the bill with no fee, send card_rate_percentage equal to 0.agency_card_rate of the products is recalculated from the payments that stay.passengers list, with the person (person.id) and the cancellation date of each passenger; the product is canceled when the list cancels the ones still missing. A product without passengers is canceled without the list, on the current date. The canceled product still adds to the sale total. Requires, in the company of the sale, the permission to edit sales and the "Cancel product" permission, new in the credential, as in Monde; existing credentials start without it.passengers list with the person of each passenger that comes back. Reactivating every canceled passenger brings back to the financial records what the cancellation had deleted; reactivating only some, the fine and the deleted balance stay. With the automatic supplier invoice, it answers 409 while the cancellation fine is still being posted to the invoice: repeat in a few seconds. Requires the same permissions as the cancellation.kind filter, by product kind: a sale is returned when it has a non-deleted product of one of the given kinds.airline_tickets) now accepts observations on create and update, and now rejects the cruise destination with 422: as in Monde, it is national or international. An airline ticket the API recorded earlier with cruise still comes that way when read, and can only be updated with the destination changed to national or international: cruise is rejected also when the destination is omitted.promoter) as Monde does: it is the promoter registered on the intermediary, copied when the sale is created and whenever the intermediary changes. The promoter is not sent in the payload.reservation_due_date field (reservation due date) on the sale products, tour operators only: stored by Create a sale and Update a sale and returned by the get. On a travel agency, it is rejected with 422 and returns null.operation and operation_id) is now rejected with 422, as in Monde, where it is exclusive to travel agencies.approver) sent with a value to Create a sale and Update a sale is now rejected with 422, as in Monde, where a tour operator sale has no approver. Sent as null on the update, it is removed from the sale.agency.credit (agency credit), agency.to_invoice (to invoice, with due date, cost center and description, which enters the customer invoice through automatic invoicing) and agency.retained_by_intermediary (retained by the intermediary, agency only and on a sale with an intermediary). Agency credit and retained by the intermediary respond 422 on an operator installation. Without payer, the to-invoice payment falls to the sale payer, on an operator installation too, as in Monde.vendor.credit) now check the payer's balance, adding up the credit payments of the request, and consume it when the sale is saved; without enough balance, the response is 422 with the available balance. When the update takes them out of the sale, the used credit goes back to the payer. As in Monde, a supplier credit payment uses the balance of a single supplier and representative for its whole amount: those of the first product of the payment, in alphabetical order of the representative and then of the supplier, even when the payment also pays products of another supplier.payments, giving the used credit back. Before, it could only be removed in Monde.payments.agency.to_invoice list, with an id of its own, and the invoices in bills. The customer invoice of the to-invoice payment no longer shows in payments.agency.bills, and its id no longer keeps the payment in the update: use the to-invoice id. A to-invoice payment not invoiced yet now shows up.products[]) gets the id of the item recorded for it. The update keeps the line by its id or by the id of any of those items: when an identical payment included later joins the same line and changes its id, the id stored before still works.payments.agency.retained_by_intermediary) gets an id, and both are now kept or removed by the update payments list: an update that sends payments without their id removes them, which it did not do before. A to-invoice payment in a closed or settled customer invoice is not removed.id, as in Monde. As in Monde, which only removes that part when the user deletes that line, the update does not remove it for being left out of payments while the list keeps another line of the same to-invoice payment (same payer, cost center and description); it is removed when no line of the payment stays in the list. To keep the whole payment after the split, send the id of each of its lines (or of each item in products).payer without taking them out of payments answers 422. Before, the payer changed and the items stayed in the name of the former payer.observations) are now accepted on create and update, also on a closed sale, as in Monde. The change goes to the sale log.customer) or with the vendor (vendor), with the rules of the Customer Refund and Vendor Refund actions in Monde: the refund goes to the invoice by the billing rules (invoice) or generates right away a separate invoice with it alone (bill), and goes into the product refund and the sale revenue. The customer refund exists only for agencies: on an operator base, it answers 403. As in Monde, recording a refund is editing the sale: requires the Edit permission on Sales (on a sale the credential did not create, also Edit sales of other sellers; on a sale with a printed receipt, also Change sales with a printed receipt, for both the customer and the vendor refund) and the Idempotency-Key.409, and so does a customer refund on a closed sale. A vendor refund that has already become an account payable/receivable (the account generated for it alone or, with the automatic vendor invoice off, any invoice) is deleted only with remove_from_bill as true, like the confirmation Monde asks for when deleting the account: without it, it answers 409; with it, the whole account is deleted, as in Monde: the refund leaves, and the other items of the account go back to pending, without an invoice. Requires the same permissions as recording (including Change sales with a printed receipt on a sale with a printed receipt), plus View financial tab on a vendor refund, and the Idempotency-Key. Deleting the whole account with remove_from_bill also requires Edit and Delete on Accounts Payable and Receivable over it (and, on another user's account, the access to the entries of other users), like deleting the entry in Monde; without them, 403.custom_fields.POST /bank_reconciliations, as multipart/form-data), read and discard the uploaded statements, run the automatic matching again, read the reconciliation lines with the situation of each one, read the candidates of a line, link the line (PATCH, with the final list of account movements and the open bills to settle on the line date), reject a suggestion and verify or undo the verification of each account movement.amount is in the currency of the entry; in an account in another currency, it goes in converted by the latest exchange rate, and without a registered rate the movement answers 422. Before, an entry outside BRL answered 422. Through a bank reconciliation link, an open bill in the currency of the checking account is settled as well.exchange_rate, which converts the entry currency into the account currency (only in an account in another currency; with it, a missing registered rate no longer answers 422), and reference_exchange_rate, the reference exchange rate of an account outside BRL. In a bank reconciliation link, each open bill in open_bills accepts reference_exchange_rate in a checking account outside BRL. Both are optional, greater than zero and saved with 6 decimal places; when omitted, the latest rates apply, and when sent where they do not apply they are ignored.conta_movimento) now asks for Visualizar Log of Transfers between Accounts, as in Monde, instead of reading the Account movements. Through the automatic connection, reading, editing, deleting and viewing the log of transfers is an exception granted by Monde on approval, highlighted on the consent screen: a transfer does not record who created it, so whoever reads or writes transfers also reaches the ones the agency recorded.company_identifier): color, social networks, general conditions, content template and logo. Update quote settings always answers 409, writing nothing: as in Monde, only the administrator changes the settings, on the Monde Web screen.updated_at, and the read by ID also the quote owner in user.person_id) when creating, updating or duplicating a quote requires the Read all people permission. Without it, the person is refused (422) with the same message as a person that does not exist.customer_id) when creating or updating a travel, and the person of a customer refund (person_id), also requires Read all people, with the same refusal.company_identifier): the footer of the public page of the guides. Update guide settings always answers 409, writing nothing: as in Monde, only the administrator changes the settings, on the Monde Web screen.company_identifier) without sending the owner (user_id) now answers 422 when the current owner has no access to the target company, asking for an owner that has. Before, the guide moved and kept an owner that cannot reach it. When the current owner has access to both companies, nothing changes.companies), the user groups with access (user_groups) and the billing setup of the checking account (billing_accounts, Monde Bancos and CobreBem). They require the new Edit and Delete permissions of Accounts and Cards, as in Monde.agency or initial_balance on a card, or billing_accounts outside a checking account) is ignored, like a field that does not exist: it is not saved and does not answer 422.initial_balance) reopens the closed cash of the account and also requires the new Reopen Cash permission of Accounts and Cards, as in Monde; without it, the response is 403 with the Monde message. Sending back the saved balance does not require the permission.registered is saved as the screen allows; on Monde Bancos, it comes from the chosen portfolio, and the value sent is ignored.invoice_company, user_groups and billing_accounts fields.balance_resolution as partial, on an entry with items (such as the sale payment), the item split between the paid entry and the balance now divides its agency card fee in proportion to the amount of each part. Before, the part that went to the balance took the whole fee of the item, and the agency card fee of the product was counted twice until the balance was settled.sale_payment), whose id comes in payments.agency.bills of the sale. The settlement uses the sale's payment method and data: payment_method_id becomes optional in the movement, and the card fee calculated in the sale moves to the movement without sending card_rate. As in every movement with a fee, amount is what the customer paid, and the account receives amount less the fee. On undoing it, the card fee stays on the entry.package_name), with the included services./ships/MSC%20Preziosa). Renaming carries the new name to the sale products that use the record, and a record used in a sale product is not deleted (409).409): deactivate it.201 when they record and 200 when the value equals the current exchange rate and nothing is recorded (an empty list, in the batch). For travel agencies, both answer 403.null is now removed from the record instead of counting as omitted. What the record cannot be without, sent as null, answers 422. A list sent as null counts as an empty list, and a custom_fields item with a null or empty value clears that field (a required one answers 422). Creation does not change. Update sale already followed this rule.address, birthplace, additional_data, airline, seller, promoter and the lists are cleared. name, person_kind, external_id, foreigner, charge_billet_fee, the withholdings, a Monde user's email, the required card data and the Kandir law percentages answer 422.title, assignee_id and completed answer 422.internal_observations is cleared; title, subtitle, details, active, user_id and company_identifier answer 422.apportionments empties the apportionments, and a null per_cost_center or per_company empties only that one; a null company_identifier answers 422.people removes every link; a null person or not_commissioned in a people item answers 422.422. The exceptions are kanban_position, accepted as null when the category leaves the board, and choices, where null counts as an empty list.POST /products, kinds others and operation), update (PATCH /products/{id}) and delete (DELETE /products/{id}). A CVC product cannot be changed, and a system product or one with related records cannot be deleted: both cases answer 409. They require the new Edit and Delete permissions on products./products/{product_id}/supplies and the representatives of each supplier at /products/{product_id}/supplies/{supply_id}/representations, with list, get by ID, create, update (PATCH) and delete. Reading uses the permission to read products; writing and deleting have their own permissions, as in Monde: Add supplier, Edit supplier, Delete supplier, Add representative, Edit representative and Delete representative.null is removed. A field that cannot be empty (such as name, active, supplier and the commission fields) sent as null answers 422.id of each supply and each representative.status: opened, as Monde does: the sale reopens before the rest of the request is applied, and the update applies as a whole or nothing changes. Reopening only changes the sale status; commissions and financial entries stay as they are. It requires the "Reopen sale" permission, new in the credential and checked in the company of the sale, as in Monde; "Close sale" does not reopen. A deleted sale still answers 409.credit_cards or kandir_law with some item, or removing the person's ones, now requires the "View financial tab" permission on people, as in Monde, where the cards and the Kandir law sit on the Financial tab of the person. Each card operation also asks its own permission: adding a card (item without id), "Register credit card"; changing a card (item with id and some field to change), "View credit card data" and "Edit credit card"; leaving out of the list a card the person has, "Remove credit card". Without the permission, the answer is 403 with the Monde message, and nothing is written.credit_cards and kandir_law only come with "View financial tab", and credit_cards, also with "View credit card data". Without the permission, the field does not come: it is left out, not sent as null.seller or promoter, on a person that has one) now requires "Change seller" or "Change promoter", as changing them already did.settlement_date of a settled entry to a date different from the stored one now also requires "Settle account payable" or "Settle account receivable", depending on the nature of the entry, as in Monde. Sending the same date again asks no permission.commissions with any commission now requires "View commissions tab" and "Add commissions". In Update a sale, sending commissions, even empty or null, now also requires "View commissions tab", besides "Add commissions" and "Delete commissions".cidade) now comes to whoever has the "View log" permission on cities, instead of whoever reads the cities.id and, in the sale, also the id and the local_id of the products and payments sent; the same applies to the settlement and the restoration of the entry and to the comment on the task. An update without any field does not serve as a get. The creation still returns the whole created record, with the protected fields hidden according to the field permissions. The attachment download follows the get of its owner record, with the same rule.balance_resolution says what to do with the difference: category posts it to a discount or surcharge category (the one in balance_category_id or the company's default), and partial settles what was paid and creates an open entry with the balance, which comes in generated_bills. It settles the standalone entry, the customer and supplier invoices and the credit card invoice with its edition released; the sale payment, the sale standalone entry and the commission answer 409. Requires an Idempotency-Key, the "Edit" permission on accounts payable and receivable and the "Settle account payable" or "Settle account receivable" one, according to the nature of the entry, the same as the creation already settled.undo_bank_reconciliation as true. Also requires the Edit settled entry permission. It does not require an Idempotency-Key.commissions, whose list always replaces the manual commissions. Commissions now require "Add commissions" and "Delete commissions", instead of "Close sale". Delete sale with a printed receipt now also requires "Change sales with a printed receipt". A credential that already existed keeps doing what it did: "Edit" also counts as the new permissions of the update, "Close sale" as the ones of the commissions, and "Delete" as the one of the printed receipt.payments and financial, with "View financial tab"; and commissions, with "View commissions tab". Without the permission, the field is left out. In the response of the creation and the update, without "View financial tab", payments brings only the id and the local_id of the payments sent.seller) now requires the "Change seller" permission, and the promoter (promoter), the "Change promoter" one, as in Monde; without it, the answer is 403. A credential that already existed keeps doing what it did: "Edit" also counts as those permissions.assignee_id. The check applies to every change, not only when the assignee or the company changes. A task without a company is not checked.card_rate, the card fee, with the rules of Monde: only on accounts receivable, in a checking account and with the credit or debit card payment method. amount is what the customer paid, the account receives amount less the fee, and the sum of the fees becomes the card fee category configured in the company, which lowers the final amount; without that category, the fee answers 422. On the update, changing only the fee keeps what the customer paid.Get account movement by ID now returns card_rate, the card fee of the movement.
New Restore a deleted account payable or receivable (POST /bills/{id}/restoration), with the rules of Restore in Monde: only the standalone entry comes back, open, and the settlement removed by the deletion does not come back. A sale's entry, an invoice and a commission answer 409. Requires the Restore and Edit permissions of accounts payable and receivable in the entry's company. Another user's entry also needs Access other users' data, as in the other actions.
Undo the settlement gets recurrence_scope, like the update and the deletion: on an entry of a series, this_and_following also undoes the settlement of the following settled entries, with the same refusals and the same permission for each one. If one of them cannot be reopened, no settlement is undone, and the 409 response says which one blocked it. The default is still to undo only the entry sent.
company_identifier value in writes) and whether the company is read only. Requires the new "Read all companies" permission, granted in each company that should be listed.409): deactivate it with active: false. They require the new seller permissions "Edit" and "Delete".id, when a person or invoice starts using it.city_ibge and the city name of the address and of the birthplace now also find the city of the list. When the name repeats, the larger city comes. Before, a city abroad the agency did not have was created again, unrelated to the one in the list. A city abroad sent with state_code is still looked up as "Name, UF" and, with no match, created with that name.choices) only on the list kind, and resource and kind fixed after creation. There is no deletion: a field no longer in use is deactivated with active: false. Requires the new Create and edit permission of custom fields.kanban, which says whether the category is a column of the task board, and kanban_position, the position of the column on the board (null off it).kanban_position takes it to another position, shifting the others. A category with tasks, including completed or deleted ones, is not deleted: the response is 409. They require the new Edit and Delete permissions of task categories.commissioned_over are logged on the role, under the credential.credit_cards (credit cards), cost_centers (cost centers of the corporate client) and kandir_law (Lei Kandir withholdings), in the same format as the get by ID. On update, the list sent replaces the current one, like contacts and labels: a card the person already has is cited by its id, a cost center by its name and a withholding by its product. The card number and security code are stored encrypted and never come back in the response, which shows only the last four digits. Cost centers and withholdings apply only to legal persons, and the withholding only to Airfare, Travel Insurance and Ground Transportation, with the total of each group computed as the sum of IR, CSLL, PIS and COFINS. Every addition, update and deletion is recorded in the history of the person.id of each card in credit_cards and the cost_centers list.birthday_from and birthday_to (YYYY-MM-DD, together, up to 366 days) return whoever has a birthday in the window, ignoring the year and crossing the turn of the year. It also gains the label_id filter, for the people of a label.POST /people/{person_id}/conversion), with the rules of Monde's conversion: it erases the data only the original kind has and refuses the system user and the system company. Requires the permission to edit people.photo (type and size of the photo, or null) and invoice_rules (the invoice rules that belong to the person) fields.email of another user now responds with 422 on email, and nothing is written. Before, the response was 500. The same goes for an already registered person cited in Create sale or in Update a sale who is a user without an email and would receive the one of another user. A person who is not a user still accepts any email, including the one of a user, and Create person does not change: the person created is not a user yet.assignee_id, created_by_id (who created it), person_id, category_id (or uncategorized, for tasks without a category), status (pending, completed and deleted, comma-separated), overdue, the period by date_field (due, created_at or completed_at) with date_from and date_to, and the link to a sale, travel and bill (sale_id, travel_id, bill_id). Without status, the list still leaves out deleted tasks. A filter with an invalid value answers 400.sale_id, travel_id and bill_id in Create task and Update task, and sale, travel and bill in Get task by ID. The links have no required relation to the task person; when sent together, they must match each other: the sale must belong to the travel sent, and the bill to the sale sent. On update, a link sent as null is removed, and a task person already filled in is not replaced while the task has a link; filling in the person of a task that has none is allowed.recurrence_scope set to this_and_following, each following entry of the series only receives the change when the credential could change it directly: with the "Edit" permission in its company, which cannot be read-only; for an entry of another user, also the access to the entries of other users (whole or in the slice of the entry); and, for an entry already settled, also "Edit settled entry". A following entry that does not meet this stays as it is, and the response is still 200.this_and_following, a following entry that was deleted (canceled set to true) stays as it is and no longer receives the change of the series.recurrence_scope set to this_and_following, each following entry of the series is only erased when the credential could delete it directly: with the "Delete" permission in its company, which cannot be read-only; on an entry of another user, also access to the other users' entries (whole or in the entry's slice); and, on a settled one, also "Edit settled entry". A following entry that does not meet this stays, out of the series, and the response is still 204.setec field. Monde did not use the SETEC code in any invoice issuing, and it was removed from the city registration.balance_resolution and balance_category_id in an entry created already settled, as the settlement does: with category, the difference between what was paid and the final amount goes to the category sent or, without it, to the company's default category; with partial, the balance becomes an open entry. partial_payment: true is still accepted and is the same as balance_resolution: partial; a partial_payment that contradicts balance_resolution is rejected with 422. balance_resolution cannot be combined with installments or recurrence.balance_resolution says what to do with the difference: category posts it to a discount or surcharge category (the one in balance_category_id or the company's default), and partial settles what was paid and creates an open entry with the balance, which comes in generated_bills. It settles the standalone entry, the customer and supplier invoices and the credit card invoice with its edition released; the sale payment, the sale standalone entry and the commission answer 409. Requires an Idempotency-Key and the permission to create and edit accounts payable and receivable, the same as the creation already settled.undo_bank_reconciliation as true. Also requires the Edit settled permission. It does not require an Idempotency-Key.canceled equal to true and stays in the query by ID. It deletes the standalone entry and the client and vendor invoice, whose items are invoiced again; an entry generated by a sale, a credit card invoice, a commission entry and an invoice generated by Monde with items answer 409 with the reason. A settled entry is only deleted with remove_settlement as true, which removes the settlement, and a reconciled one with undo_bank_reconciliation as true. On installments or recurrence, recurrence_scope with this_and_following also erases the following entries with no movement, like the "Delete this and following" option in Monde. It does not require Idempotency-Key.payments[].*.products[] now points to the product by sale_product_local_id (a product sent in the same request) or by sale_product_id (a product the sale already has, update only), instead of local_id, external_id and id. The amount allocated to the product is now called amount, instead of payment_amount, as in the sale get. For now, local_id, external_id and payment_amount are still accepted, so as not to break those who already send them: migrate to the new names. Since sale_product_local_id carries only the value, two products of the sale can no longer share the same key value, not even one in local_id and the other in external_id.payments item now has a single payment method: agency or vendor, with only one method inside. To pay with two methods, send two payments. This way each payment sent comes back with a single id.local_id is now required on each new payments item and unique among the new payments of the request; a payment without it is refused with 422. It comes back in the response, inside the payment, next to the generated id, which you use to keep the payment in the next update. A payment kept by its id does not need it.403 with "The company does not have an active Monde license. Contact our support team for more information.".403.403 with "This feature requires the Monde Pro license. Contact our support team for more information."; with a read-only Monde Pro license, guides are read, but not written. public_url is null when the company is read-only, does not have the Monde Pro license, or has a read-only Monde Pro license.403 with its own message, "The company is read-only: its records can be read through the API, but not written.", instead of "Your license does not grant access to this action.". It applies to every write: sales, tasks and their history, people, accounts payable and receivable, attachments and guides, also through the Automatic connection, and to moving a task or a guide to a read-only company. "Your license does not grant access to this action." remains only for the read-only Monde Pro license, on guides. Reads stay allowed.account_id) now accepts any active account linked to the company, including a credit card account on accounts receivable, as in Monde. The credit card account stays out of the movements of accounts receivable.operation_id).amount), categories, apportionments per cost center and per company, and the company of the entry (company_identifier). The categories and each apportionment sent replace the current ones; an amount sent without the categories follows the Monde rule: with a single category, it follows the new amount; with more than one, it must equal their sum. Moving the entry to another company requires the create and edit permission there too, and an entry with a registered or issued bank slip does not change company. In an installment or recurring series, recurrence_scope with this_and_following takes the change to the following entries of the series too, in the background, like the "Update this and next" option in Monde.settlement_date) and the movements it already has (movements, each one by its id) change too, without adding or removing movements, settling or unsettling. The movements must add up to the final amount, and the company of a settled entry does not change. Besides Create and edit, it requires the new Edit settled permission on Accounts Payable and Receivable, offered on the API credential. An entry with a reconciled movement answers 409, with the Monde warning, until the request brings undo_bank_reconciliation as true; with the confirmation, the reconciliation of the changed movement is undone.bill in resource_type: send the resource_id of the target account payable or receivable and the attachment is stored on it, showing up in the account query by ID and in the download. It requires, on Accounts Payable and Receivable, the Add attachments permission — now offered on the API credential — granted on the company of the account, which cannot be read-only. The rest of the upload is unchanged: one file per request, the same extensions, the same 12 MB limit and the same Idempotency-Key.exchange_rate and of the payment payment_amount in Create sale now explains how the exchange rate is applied: each amount is converted and rounded to 2 decimal places separately, and the product total is the sum of these amounts. The calculation did not change; summing in the origin currency and converting once may differ by cents and have the closing refused for pending balance.recurrence_kind: installment, with periodicity and the total of installments), recurrence (recurrence_kind: recurrent, for the next 5 years) and partial payment (partial_payment: true), where the balance becomes a new open entry. The series is generated in the background, as in Monde: the response brings recurrence_group_id, and the series entries are fetched by the new recurrence_group_id filter of List accounts payable and receivable. The partial payment's balance comes right away, in generated_bills.recurrence_status field: pending while the installment or recurrence series is not generated yet, generated once it is, and retrying when the last attempt failed and Monde will try again.operationId (for example listSales, createSale and getPerson), which SDK generators and AI agent tools use as the function name.x-badges): the notice repeated at the start of every description was removed.https://web.monde.com.br/api/v3/openapi.yaml, with Content-Type: application/yaml. The /api/v3/documentation/file address still works.details_format field: every quote has its details (details) in HTML, with the images in <img data-quote-image>.ValidationError: mark and with the date formatted (O caixa do dia "10/10/2026" da conta "Caixa" está fechado. instead of ValidationError: O caixa do dia "#Date(2026-10-10)#"…).company_identifier, the creation is rejected with 422 and the message names the company, as in Monde, which does not allow registering a sale outside a trip in that company. Before, the sale was created standalone. The API cannot yet create a sale within a trip; integrations using that company must turn the setting off or use another company.kind): expense or revenue, inherited from its group. In a financial entry, a revenue category adds to the amount of a credit entry (accounts receivable) and is deducted from a debit entry (accounts payable); an expense category does the opposite.POST /bills), open, with the rules of Monde's manual entry: the signed sum of the categories makes the final amount, the cost center apportionment stays between 0 and 100%, the split between companies totals 100%, and the company's due date and surcharge and discount locks always apply. Requires the new permission to create and edit accounts payable and receivable and the idempotency key.settlement_date and the movements: the movements add up to the final amount, the payment method follows the account kind, and the movement date lock and the closed cash day apply as in Monde. Partial settlement is not accepted yet. Without issue_date, the issue date is now today, or the due date or the settlement date when they are earlier, instead of rejecting a past due date. An error on a list item of the entry carries the item position, from 0, as in 'movements[1] account_id'."labels": { "0": { "id": "<id>" } } instead of "labels": [{ "id": "<id>" }]) now returns 422, naming the field, and nothing is saved. Before, it could return 500.commissions array now comes in the person object, with the same fields as the intermediary, instead of external_id. As with passengers, the person is looked up by external_id and, when not linked, by CPF/CNPJ; when not found, it is created. Previously the external_id had to be already linked to a person, and the commission created no one. As in Monde, kind does not restrict who receives it: a seller commission may go to any person. Without description, seller and intermediary record "Comissão Vendedor" and "Comissão Intermediário". A commission that still sends only external_id is rejected with 422.intermediary) is now required, whether the sale is open or closed, and it owes the customer invoice, for the customer total net of the intermediary commission. When the sale is deleted, the balance that becomes due again also stays with the intermediary, not with the payer. The amount owed to the supplier stays in the product's origin currency. Converted amounts are rounded to 2 decimal places. A payment to the supplier (payments.vendor) of a product whose origin currency is not BRL is rejected with 422. Nothing changes for travel agencies.commission_amount, over_amount, intermediary_commission_amount and intermediary_over_amount came in the product's origin currency, without any indication. They now come in the final currency of the sale, like the other amounts, and so does the sale revenue (totals.revenue). Nothing changes for travel agencies.commission_amount_origin_currency, over_amount_origin_currency, intermediary_commission_amount_origin_currency and intermediary_over_amount_origin_currency, the amount in the origin currency, as already happened with the service fee and the discount.sale_currency field (default BRL). As in Monde, currency is the origin currency, in which the supplier is paid, and exchange_rate converts the origin into the sale currency: with equal currencies the rate is 1, with different currencies it is required, even when the origin is BRL. The customer invoice and the payments (payments) are issued in the sale currency, and each payment only groups products with the same sale currency. A payment to the supplier (payments.vendor) is now rejected with 422 when the origin currency differs from the sale currency, instead of when it differs from BRL. On read, currency returns the product sale currency. For travel agencies, a sale currency other than BRL is rejected with 422.payments.agency) with settlement_date, the bank account may be in a currency other than the payment's, as in Monde. The settlement converts by the new settlement_exchange_rate field, from the payment currency to the account currency, or, when it is omitted, by the ratio between the latest rates of both currencies; without the rate of either one, the response is 422. Before, the amount entered the account unconverted. With the account in the payment currency, settlement_exchange_rate must be 1 or omitted. The bank slip (bank_slip) now only accepts products whose sale currency is BRL, with 422 for the others.DELETE /sales/{id}). As in Monde, the sale is not removed: its status becomes canceled, and Monde undoes right after what it generated in the finances. The same rules as in Monde prevent the deletion (closed sale, canceled product, settled financial entry, item already invoiced to the supplier, refund, closed client invoice), with a 409 response and the reason. A sale with a printed receipt is deleted. Requires the new permission to delete sales. In the automatic connection, a partner with the permission to delete own sales deletes only the sales the integration created.PATCH /sales/{id}). Updates an open sale: a field left out stays as it is, and each list sent replaces the current one (the products of each kind, the passengers and segments of each product sent, payments and commissions). A field sent as null is removed from the sale (intermediary, approver, requester, operation_id and operation; operation_id only goes away along with the own operation product that holds it), and a custom field sent blank is cleared, unless it is required. In a changed product, what the payload does not bring, including passengers and segments, stays as it is, and a passengers or segments list sent empty is refused. In ground transportation and train tickets, whose segments live in the included services text, segments sent again require included_services along with them, which is saved as sent. A list sent as null is the same as an empty list, with the same rules; in custom fields, which are not replaced, it changes nothing. This also applies to the lists inside an item: the seats of a segment sent can be left out, empty or null, and a new payment with products empty or null is refused. A product the sale already has is pointed to by the id of the get by ID; a product without id is added, and one left out of the list of its kind is removed. In payments, a payment sent with only its id stays as it is, one without id is added and one left out is removed; in a new payment, the paid product is pointed to by sale_product_local_id, for a product in the same request, or by sale_product_id, for a product the sale keeps. The totals are recalculated, and the payer balance and the amount to invoice to the supplier are adjusted by the difference. What was already reconciled in the financial module is not removed: removing a settled payment or one in a closed customer invoice answers 422, as does a supplier amount in a closed, settled or separate invoice and a paid commission. A deleted sale cannot be changed (409). In a closed sale, as in Monde, only the seller, the requester, the approver, the custom fields and the commissions change, and status only accepts closed (the rest answers 409). Commissions come in the same format as on creation, with the recipient in the person object. The sale can move to another company where the credential can also update sales, with the Monde locks. Each changed field goes to the sale log. Requires the "Create and edit" permission in the sale company, or "Create and edit own sales" for a sale the credential itself created.local_id it came with next to the generated id. A credential without read permission gets only these identifiers, in the same format as the sale, instead of only the sale id. In the sale get, the supplier payments and the agency payments in credit and legacy now bring their id.status filter sent as a list or a nested value (such as ?status[]=open) still answers 400, but the message now says the parameter does not accept lists or nested values, as in pagination. Before, the message only said the value was not valid. In sales and in accounts payable and receivable, to filter by more than one status, send the values separated by commas (such as ?status=open,overdue in accounts).passengers[].cost_center, up to 50 characters) in every product with passengers. As in Monde, when the payer is a legal person the cost center must be one of those registered for that payer, case-insensitive, and is stored with the name as registered; any other value returns 422 and nothing is saved. With an individual payer, or when the sales setting Enter the cost center as free text is on, any text is accepted. Before, the field was only returned when reading and was ignored on creation.airline_tickets[].segments[].seats. Each seat points to the passenger by the ticket_number, which must be the ticket of exactly one of the passengers of the product: a ticket that belongs to no passenger, or to more than one, returns 422 and nothing is recorded. The same passenger cannot have two seats on the same segment. The seat_number accepts up to 3 characters and is recorded in uppercase. Before, the field was only documented and was not processed by the API.segments[].seats), in the same format as the creation. A seat entered in Monde for a passenger who has no ticket yet comes with a null ticket_number. The passenger still has no seat.X-Idempotent-Replay: true) forever.company_identifier of a company where the credential has no permission at all is now answered as a CNPJ not found (422, with a field error), the same as a CNPJ that is not a company of the agency. It used to answer 403, which let any credential find out which CNPJs are active companies of the agency. In a company where the credential has some permission, but not the one for the operation, the answer is still 403.others field (a list; a sale can have several). The product is informed by product_id, among the Other products of the agency catalog (GET /products?kind=others). Depending on the product configuration, the values go through passengers or through quantity × unit_price (with unit_fee and the hidden service fee agency_fee). The supplier (supplier) is required and the representative (representative) is optional. It also accepts destination (national or international).unit_fee is now in Brazilian reais (BRL), as in Monde: the total fees are quantity × unit_fee, without applying the product exchange rate. Before, the unit fee was multiplied by the exchange rate. Products in BRL are not affected.operation.product_id and operation_id) must be active in the catalog, as in Monde, which only offers active products in a sale. An inactive product, listed in GET /products with active: false, is rejected with 422. Before, an inactive own operation was accepted.quantity accepts at most 2147483647. Above that the response is 422, with the field name, and nothing is saved. Before, such a quantity returned 500. The line total that the quantity produces is not checked yet, as with the other calculated values.agency_fee and agency_fee_origin_currency, the hidden service fee of the line, as in own operation products. They are null in the product with passengers, where the fee comes in each passenger.excursions array, one or more per sale. The excursion is a system product, so there is no need to inform which product is being sold. The document (up to 40 characters), the departure date (departure_date), the currency, the supplier and at least one passenger are required. The arrival date (arrival_date) is optional and cannot be earlier than the departure. The observations (observations), the included services, the representative and the product values (commission, intermediary commission, service fee, discount and exchange rate) are also accepted. The passenger takes amount, fees, RAV fee and its discount, hidden service fee and document. If the Excursion product is inactive in Monde, it is activated when the sale is created, as happens when it is sold through the system.Create a sale now accepts airline tickets in the airline_tickets array, with the flight legs in segments and the passengers. The airline is identified by its IATA/ICAO code in airline_code or by its CNPJ: when an airline with that code already exists it is reused, otherwise it is created. Each passenger's DU fee (du_fee), minus its discount (du_fee_discount), is included in the passenger and product totals. The DU discount can only be informed when du_fee is greater than zero, as in Monde. The CC DU and CC RAV fees (cc_du_fee, cc_rav_fee) are stored on the product and deducted from the agency revenue. Each leg's origin and destination must be a registered airport; an unknown IATA code is rejected. Spaces before or after airline and airport codes are discarded, and the maximum length applies to the code without them. flight_number accepts digits only, and emission_name accepts up to 50 characters. The seat per leg (segments[].seats), which points to the passenger by ticket_number, and the passenger original_ticket_number are only documented, since the system does not process them yet.
In the sale lookup, the airline ticket passenger no longer returns seat. The seat belongs to each leg, not to the passenger, and will be returned in the legs once the system stores it per leg.
In the sale lookup, the airline leg class no longer comes with a trailing space when the class has a single letter ("A" instead of "A ").
payer lacking the fields Monde requires to save the sale (full address, document, contact and, depending on the person kind, birthdate or legal name) is refused with 422, one error per missing field, and nothing is saved. The registration counts as it stands after the request, including what the request creates or completes. Before, the sale was created even with an incomplete registration. With the setting off, the default, nothing changes.attachments, with the task attachments, including the ones sent in comments. Each attachment has id, description, extension, content_type and download_url, in the same format as the sale. Create task, Update task and Comment on the task also return the field when they return the full task.attachments, with the travel attachments, in the same format as the sale. An attachment that also belongs to a task or to a sale is not listed, because its download requires the permission of that other record.download_url. It requires the read permission of the record that owns the attachment: "Read all tasks", "Read all sales", "Read all travels", "Read all accounts payable and receivable" or "Read all people".city_ibge of the address and of the birthplace (birthplace) now defines the city, which must already be registered. A code that matches no city responds 422 on city_ibge, even with name, state and country provided, and nothing is saved. Before, the response was a success: the person was left without the birthplace, or the city was created with the invalid code. To register a new city, send city_name, state_code and country_code without city_ibge: the city is created without an IBGE code.city_ibge, a state_code different from the state of the city responds 422 on state_code, and a country_code other than BR responds 422 on country_code. city_name is not checked.currency is the final currency of the sale (BRL in sales created by the API), and the amounts stay in it, unchanged. origin_currency was added with the currency in which the product is originally sold, and exchange_rate now brings the exchange rate stored in the product instead of a fixed 1._origin_currency suffix, in the origin currency: in the products (agency_service_fee, deductions, discount_amount), in totals and in the passengers (e.g. amount and amount_origin_currency). Commission, over and the intermediary amounts have no pair. This fixes the rule of the 2026-08-11 entry, where currency and exchange_rate always returned BRL and 1.agency_fee now comes in the final currency of the sale, like the other amounts, and got the agency_fee_origin_currency pair. Before, it came in the origin currency. Nothing changes on create: agency_fee is still provided in the origin currency.redirect_uri when the agency approves or refuses (with the state), and the errors of each step.POST /oauth/revoke, is now documented: it deletes the connection with the agency immediately.In Create a person, Update a person, Create a sale, Create task, Update task and Comment on the task, 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": ["<id>"] instead of "labels": [{ "id": "<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 and List cities, 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.
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.Update task 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 is now available: deletes the task, which no longer appears in List tasks 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 and Comment on the task respond 409.
Update task and Comment on the task 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.
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.Create task 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 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.
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.POST /sales response. Attachments only go to the sale the partner itself created.Idempotency-Key. It requires the "Delete" permission on People, now offered on the API credential, granted in a company whose API license allows writing.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 the person of these logs is still null, because the credential is not a person.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 a creation made through the API now brings one log less.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.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.Idempotency-Key: sending the same attachment again with the same key is processed again, instead of answering 409 indefinitely.Upload attachment 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 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.
Create a person 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, 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.
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. 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.
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.
In Create sale, 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.
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, 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.
Create a sale: 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.
?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.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.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.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.In Create sale, 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 and Get sale by ID, products no longer carry external_id. The product identifier on read is id.
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 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.client_secret is shown a single time and is no longer emailed. The page also includes the "Connect with Monde" button snippet.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 section.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.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.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.cpf_cnpj field. Previously the document conflict raised an internal error (500).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.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.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.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.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.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.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.List sales 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).
excursions array.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.totals.balance: sales created through Create sale 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.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.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.id; in Get account payable or receivable by ID, credit_card_items[].id gave way to the movement reference._summary suffix, and the plain name became the get by ID schema.registered_at was renamed to created_at in sales, accounts payable and receivable, invoices, invoice (NF) rules, tasks, travels, sellers, people, CVC statement and logs — the more common name for this concept across REST APIs.registered_by was renamed to created_by, for the same reason, in sales, accounts payable and receivable, invoices, invoice (NF) rules, tasks, travels, sellers, people and CVC statement.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.
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.birthplace, seller, promoter, registered_by, contacts, labels, custom_fields, attachments and credit_cards.id: they are data that only exist inside the person.masked_number became last_digits and now brings only the last four digits, without the mask.billet, check and card, which previously existed only in the get by ID. They are data of the entry itself.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.id. The item has no endpoint of its own, and the identifier resolved nothing.state and country left List cities and stayed in Get city by ID.group left List categories and stayed in Get category by ID.bank left List accounts and cards and stayed in Get account or card by ID.kind now declares its possible values: insertion, edition, deletion, custom and export. There are no others.person description now points to Get person by ID, the endpoint that resolves the reference.travel reference, resolved in Get travel by ID. The link existed only in the opposite direction.active, and Tasks, deleted.payer_rule, supplier_rule and representative_rule, recipient now comes before revenues and discounts.List sales 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 and Get custom field by ID. 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.
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.
financial node left the list and remain in Get sale by ID, 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 — 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.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.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 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 and Get refund by ID; 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.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.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.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.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.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. 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.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.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.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.kind, sale_separate and vendor_separate became sale_standalone and vendor_standalone. The kind filter takes the new values.custom_fields, each field now carries the id of the definition and no longer carries name, as on the sale.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.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.supplies: each one carries the supplier, the commission data and the representatives.commission_value became commission_amount, and commission_type now takes amount instead of value.history (comments and changes) and the custom fields.category is no longer text: it became a reference, resolved by Get task category by ID.client became customer, and seller now points to the sellers endpoint.seller now points to Get seller by ID.status was dropped: it is derivable from active and valid_until, both still in the response.attachment_id became id.person field.name, and the country gained code (ISO 3166-1 alpha-2) and code_3 (alpha-3).labels reference on the person and the category reference on the task.Create sale now accepts custom fields in the custom_fields field (an array of {id, value}). The id is the same returned by List custom fields; 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 or from List custom fields, so the consumer always reads the reference and not a projected value that can become stale.
Create sale 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 and Get sale by ID), 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 and Get log by ID. 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.
The items of Get account payable or receivable by ID 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.
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.
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.
New read endpoints for the CVC statement: Query CVC statement and Query CVC statement by ID. 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 and Query invoices by ID. 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 and Query refunds by ID. 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.
attachments field: each attachment carries id, description, extension, content_type and download_url, with the content accessible through a temporary download link.operation field (an object with id and name); previously only the identifier was returned in operation_id.commissions field: the split per person and role (seller, intermediary and others), with commission amount, retained amount and remaining balance.financial field: financial notes, vendor payouts, and the accounts payable and receivable entries linked to the sale. Besides the credential generated by the agency, a partner approved by Monde can access the v3 API on behalf of a travel agency, via OAuth 2.0 (Authorization Code + PKCE), without the agency sharing a credential password. What the partner can do is set by Monde on approval, and the agency sees and approves that list when it authorizes.
redirect_uri with a code.code for a token and uses the token to call the API on behalf of that agency.id_token and no user data.https://web.monde.com.br. https://web.monde.com.br/partners/signup and confirm the email. Monde reviews the signup, sets the permissions and approves it.client_id and client_secret show up on that page; the secret is displayed a single time, so store it right away. If you need to see it again, ask Monde to regenerate it.client_secret on your backend only. It never goes to the browser or to the user's app.https://web.monde.com.br/partners/integration), fill in the redirect_uri and the privacy policy URL, which the agency sees when it authorizes. The connection is enabled as soon as the signup is approved and both are filled in, with no other step. While either one is missing, authorization does not work. redirect_uri, and it must use https. It must be identical, character by character, on the authorization and on the token exchange (a trailing slash already counts as a difference). http addresses are not accepted, localhost and 127.0.0.1 included.state and a new code_verifier on your backend and keep both in the user's session. The code_verifier is a random string of 43 to 128 characters; the code_challenge is BASE64URL(SHA256(code_verifier)), without the trailing =. PKCE is required and only S256 is accepted: it is what keeps another system from exchanging an intercepted code. code_verifier=$(openssl rand -base64 64 | tr -d '=+/\n' | cut -c1-64) code_challenge=$(printf '%s' "$code_verifier" | openssl dgst -sha256 -binary | openssl base64 | tr '+/' '-_' | tr -d '=\n')Redirect the agency user to the authorization URL, with URL-encoded values:
GET https://web.monde.com.br/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256
scope: what the partner can do are the permissions set on approval.client_id is not an active, approved partner, if the connection is not enabled yet (the redirect_uri or the privacy policy is missing), if the redirect_uri is not the registered one, or if the code_challenge is missing or the code_challenge_method is not S256, Monde answers 400 on its own page and does not go back to the redirect_uri.redirect_uri with the code and the same state you sent: YOUR_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATEWhen the agency refuses (the
error_description is always in Portuguese): YOUR_REDIRECT_URI?error=access_denied&error_description=O+dono+do+recurso+ou+o+servidor+de+autoriza%C3%A7%C3%A3o+negou+a+requisi%C3%A7%C3%A3o.&state=STATE
state with the one in the session. If it differs or is missing, discard the response.code is opaque. Use the URL-decoded value as it came, without trimming or replacing characters. It is valid for 10 minutes and can be exchanged only once.redirect_uri when the signed-in user is not an agency administrator. In that case the user sees the explanation on a Monde page. The consent offers every active company of the agency, and none is refused for license.href points to the authorization URL you build on your backend on each access, with a fresh PKCE code_challenge (step 2 above), never a static link. The Monde symbol is hosted by us: https://web.monde.com.br/logo-monde-conectar.svg (colored, for light backgrounds) and https://web.monde.com.br/logo-monde-conectar-branco.svg (white, for the blue background). Three variations: <a href="AUTHORIZATION_URL" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0 20px 0 14px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar-branco.svg" alt="Monde" style="height:22px"> Connect with Monde</a>
<a href="AUTHORIZATION_URL" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0 20px 0 14px;background:#fff;color:#344050;border:1px solid #d8e2ef;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar.svg" alt="Monde" style="height:22px"> Connect with Monde</a>
<a href="AUTHORIZATION_URL" style="display:inline-flex;align-items:center;height:40px;padding:0 20px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none">Connect with Monde</a>
application/x-www-form-urlencoded; the same body as JSON (application/json) is also accepted. curl -X POST https://web.monde.com.br/oauth/token -H "Content-Type: application/x-www-form-urlencoded" --data-urlencode "grant_type=authorization_code" --data-urlencode "code=CODE" --data-urlencode "redirect_uri=YOUR_REDIRECT_URI" --data-urlencode "client_id=YOUR_CLIENT_ID" --data-urlencode "client_secret=YOUR_CLIENT_SECRET" --data-urlencode "code_verifier=CODE_VERIFIER"
200 response: { "access_token": "YWdlbmNpYXw2ZjFj...", "token_type": "Bearer", "scope": "full_access", "created_at": 1790602784 } The access_token does not expire and no refresh_token is returned. Store it on your backend, one per connected agency, and treat it as a password. 400 with {"error":"invalid_grant","error_description":"..."}: code expired or already exchanged, code_verifier that does not match the code_challenge, or a redirect_uri different from the one used on the authorization. Start again from the authorization.400 with {"error":"invalid_request","error_description":"..."}: the code_verifier was not sent.401 with {"error":"invalid_client","error_description":"..."}: wrong client_id or client_secret.404 with an empty body: the code arrived altered.https://web.monde.com.br/api/v3 with the token in the Authorization header (the token already carries the agency). Authorization: Bearer YOUR_ACCESS_TOKENTo confirm the connection works without creating data, call
GET /api/v3/sales with the token: curl https://web.monde.com.br/api/v3/sales -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json"
200 with the list of the sales the partner reaches (the ones it created and, when Monde granted access to other origins on approval, the others too; without that exception, the list comes empty on a new connection): the token is valid and the integration is ready.403 with {"errors":["Você não tem permissão para executar essa ação."]}: the token is valid, but the partner does not have the "View" permission on sales in the company.401 with {"errors":["Credenciais de acesso não são válidas."]}: the token is invalid or the connection was deleted. Start again from the authorization.POST /sales response.401.curl -X POST https://web.monde.com.br/oauth/revoke --data-urlencode "token=YOUR_ACCESS_TOKEN" --data-urlencode "client_id=YOUR_CLIENT_ID" --data-urlencode "client_secret=YOUR_CLIENT_SECRET"The response is
200 with {}. The connection with the agency is deleted immediately and the token stops working. To connect again, start over from the authorization. 403 with {"error":"unauthorized_client",...}: wrong client_id or client_secret, or the token does not belong to this client_id. Nothing is revoked.redirect_uri: your backend polls the new connections and receives each one already with its token, with nobody copying a key. https://web.monde.com.br/partners/integration), only after the polling below is implemented. The automatic connection must be enabled (step 1).client_id and the client_secret in HTTP Basic: curl -X POST https://web.monde.com.br/oauth/connections -u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET"The
client_id and the client_secret can also go in the body, as in the token exchange, but never in the URL: in the query string they are ignored and the response is 401. Response 200: { "data": [ { "id": "5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11", "access_token": "YWdlbmNpYXw2ZjFj...", "token_type": "Bearer", "company": { "name": "Example Agency", "cnpj": "12345678000190" }, "authorized_at": "2026-10-19T14:32:05.000-03:00" } ], "pagination": { "size": 50, "has_next_page": false, "next_cursor": null } } access_token in your backend before anything else: it does not come back in a later poll. If it is lost, the agency deletes the integration and connects again. Use the id to avoid processing the same connection twice on your side.access_token is the same as in step 4: it does not expire, has no refresh_token, is used in the v3 API the same way (step 5) and revoked the same way (step 6).company is the agency company that was connected. Use the CNPJ to link the connection to the right customer on your platform.data node. The pagination node has the format of the API pagination, but the queue uses no cursor: when has_next_page is true, poll again right away, without parameters, and next_cursor is always null. With no new connection, the list is empty. With two polls at the same time, one of them may come with an empty list and has_next_page as true: poll again.Cache-Control: no-store: do not keep it in a cache or a log, because it carries the tokens.401 with {"error":"invalid_client","error_description":"..."}: wrong client_id or client_secret, or the automatic connection is not enabled. Nothing is delivered.