# Atualiza as configurações do terminal Atualiza as configurações do terminal. Endpoint: PATCH /api/v3/settings/terminal Version: 3.0.0 Security: OAuth2 ## Header parameters: - `CPlug-Company-Id` (number, required) Id da Empresa (Company). Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas. Example: 12 - `Idempotency-Key` (string, required) UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro. ## Request fields (application/json): - `pos_settings` (object) Configurações gerais do terminal. - `pos_settings.stock` (object) Configurações gerais do estoque. - `pos_settings.stock.is_allowed_notify_negative_stock` (boolean) Notificações de estoque negativo. Example: true - `pos_settings.stock.is_allowed_block_sale_zero_or_negative_stock` (boolean) Bloqueia a venda de itens com estoque zero ou negativo. Example: true - `pos_settings.security` (object) Configurações gerais de segurança. - `pos_settings.security.cancellation` (object) Representa as configurações de cancelamento. - `pos_settings.security.cancellation.is_password_required` (boolean) Requer senha para o cancelamento. Example: true - `pos_settings.security.abandonment` (object) Representa as configurações de abandono. - `pos_settings.security.abandonment.is_enabled_to_record` (boolean) Permite gravar abandono de venda no relatório. Example: true - `pos_settings.security.abandonment.is_reason_required` (boolean) Permite exigir motivo de abandono de venda. Example: true - `pos_settings.security.password` (string) Senha para cancelamento de venda ou abandono de venda ou abertura de gaveta. Example: "123456" - `pos_settings.customer_credit` (object) Configurações do crédito de cliente. - `pos_settings.customer_credit.is_allowed_credit` (boolean) Permite o uso de crédito de clientes. Example: true - `pos_settings.customer_credit.is_allowed_negative_credit` (boolean) Permite crédito negativo para clientes. Example: true - `pos_settings.customer_credit.is_allowed_print_customer_credit_coupon` (boolean) Imprimir cupom ao adicionar/remover crédito de cliente. Example: true - `pos_settings.cash_closing` (object) Configurações do fechamento de caixa. - `pos_settings.cash_closing.transfer_auto` (object) Representa as configurações de transferência automática ao fechar. - `pos_settings.cash_closing.transfer_auto.is_enabled` (boolean) Ativa transferência automática ao fechar. Example: true - `pos_settings.cash_closing.transfer_auto.bank_account_id` (integer) Identificador único da conta bancária Você pode localizar os IDs das contas bancária no _endpoint_ de [lista de conta bancária](#tag/BankAccounts/operation/get-bank-accounts). Example: 1 - `pos_settings.cash_closing.transfer_auto.min_value_in_cash` (object) Valor que deve permanecer no caixa. - `pos_settings.cash_closing.transfer_auto.min_value_in_cash.amount` (number, required) Valor expresso como um número decimal das principais unidades monetárias Example: 99.95 - `pos_settings.cash_closing.transfer_auto.min_value_in_cash.currency` (string, required) Código de moeda de 3 letras conforme definido pela ISO-4217 Example: "BRL" - `pos_settings.cash_closing.is_approval_required` (boolean) Exige aprovação para fechamento. Example: true - `pos_settings.cash_closing.is_allowed_auto_print_cash_closing_report` (boolean) Imprimir fechamento de caixa automaticamente. Example: true - `pos_settings.discount` (object) Configurações de desconto. - `pos_settings.discount.is_enabled` (boolean) Permite descontos no PDV. Example: true - `pos_settings.discount.type` (string) Define o tipo de desconto.: - fixed: Desconto fixo - open: Desconto aberto para alteração Enum: "fixed", "open" - `pos_settings.discount.value_type` (string) Tipo de valor de desconto: - monetary: Desconto em valor - percent: Desconto em porcentagem Enum: "monetary", "percent" - `pos_settings.discount.is_password_required` (boolean) Requisitar usuário/senha de gerente para desconto. Example: true - `pos_settings.discount.max_value` (object) Representa as configurações do valor do desconto máximo. - `pos_settings.discount.max_value.is_enabled` (boolean) Habilita valor máximo. Example: true - `pos_settings.discount.max_value.sales` (number) Valor máximo na Venda, podendo ser em porcentagem ou valor absoluto, de acordo com o campo value_type. Example: 10.5 - `pos_settings.discount.max_value.product` (number) Valor máximo no Produto, podendo ser em porcentagem ou valor absoluto, de acordo com o campo value_type. Example: 11.5 - `pos_settings.sale` (object) Configurações de venda. - `pos_settings.sale.is_allowed_show_customers_latest_sales` (boolean) Mostra as últimas vendas dos clientes. Example: true - `pos_settings.sale.is_card_auth_required` (boolean) Exige autenticação de cartão para vendas. Example: true - `pos_settings.sale.is_seller_first_required` (boolean) Exige identificação do vendedor antes da venda. Example: true - `pos_settings.sale.qty_last_sales_to_show` (integer) Define a quantidade de vendas passadas a serem exibidas. Example: 50 - `pos_settings.sale.is_allowed_to_edit_product_value` (boolean) Permite a edição de valores de produtos. Example: true - `pos_settings.sale.additional_information` (string) Informações adicionais no relatório de gerencial. Example: "mais informações" - `pos_settings.sale.is_allowed_edit_amount` (boolean) Permitir edição de quantidade de produtos na venda. Example: true - `pos_settings.sale.is_allowed_open_attendance_in_cashier` (boolean) Permitir abrir comanda ao iniciar venda balcão. Example: true - `pos_settings.sale.is_require_customer_name` (boolean) Exigir nome do cliente ao finalizar a venda. Example: true - `pos_settings.sale.is_allowed_bind_customer_to_sale_by_cpf` (boolean) Vincular cliente à venda atual ao adicionar CPF na nota. Example: true - `pos_settings.sale.is_allowed_service_fee_for_cashier_sales` (boolean) Utilizar taxa de serviço para vendas no balcão. Example: true - `pos_settings.sale.is_allowed_use_barcode_generated_by_scale` (boolean) Utilizar código de barras gerado pela balança. Example: true - `pos_settings.sale.is_allowed_use_default_city_uf` (boolean) Utilizar cidade e UF padrão para venda. Ao cadastrar um cliente usar Cidade e UF da empresa como padrão! Example: true - `pos_settings.pick_up` (object) Configurações de sangria ou de reforço. - `pos_settings.pick_up.is_enabled` (boolean) Habilita o recurso de sangria ou reforço de caixa. Example: true - `pos_settings.pick_up.value` (object) Valor de alerta de sangria ou bloqueio do PDV. - `pos_settings.pick_up.is_allowed_block_pdv` (boolean) Bloquear PDV ao atingir valor máximo de dinheiro no caixa. Example: true - `pos_settings.pick_up.is_allowed_print_receipt` (boolean) Impressão automática de sangria em cada realização. Example: true - `pos_settings.cash_drawer` (object) Configurações da gaveta de dinheiro. - `pos_settings.cash_drawer.is_password_required_to_open` (boolean) Exige senha para abrir a gaveta. Example: true - `pos_settings.cash_drawer.auto_open_type` (string) Tipo de abertura automática: - all: Ao finalizar uma venda (qualquer método de pagamento) - only_cash_payment: Ao finalizar uma venda com método de pagamento igual a dinheiro Enum: "all", "only_cash_payment" - `pos_settings.cash_drawer.is_enabled_open_drawer_button` (boolean) Habilita o botão de abertura da gaveta. Example: true - `pos_settings.cash_drawer.when_auto_open` (array) Quando abrir automaticamente Enum: "pick_up", "customer_credit", "customer_billing" - `pos_settings.print` (object) Configurações gerais de impressão. - `pos_settings.print.is_allowed_auto_print_danfe_ce` (boolean) Impressão automática de NFCE-e/CF-e. Example: true - `pos_settings.print.is_allowed_print_company_info_on_header` (boolean) Imprimir as informações da empresa no cabeçalho. Example: true - `pos_settings.print.is_allowed_print_sales_number_invoice` (boolean) Imprimir o número da venda na nota fiscal. Example: true - `pos_settings.print.fractional_printing_type` (string) Tipo de impressão fracionada: - fractioned: Imprimir atributos múltiplos de forma fracionada - grouped: Imprimir atributos múltiplos de forma agrupada - dynamic: Imprimir atributos múltiplos dependendo da configuração do atributo Enum: "fractioned", "grouped", "dynamic" - `pos_settings.print.is_allowed_auto_print_at_closing_sale` (boolean) Impressão automática no fechamento de vendas. Example: true - `pos_settings.print.report_font_size` (string) Tamanho da letra na impressão do relatório gerencial. Enum: "small", "medium", "large" - `pos_settings.return_exchange` (object) Configurações relacionadas à devolução e troca de produtos. - `pos_settings.return_exchange.is_allowed_return` (boolean) Permite devolução de produtos. Example: true - `pos_settings.return_exchange.is_allowed_exchange` (boolean) Permite troca de produtos. Example: true - `pos_settings.return_exchange.coupon` (object) Representa as configurações do cupom de troca. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. - `pos_settings.return_exchange.coupon.is_allowed_auto_print` (boolean) Permite imprimir automaticamente a cada venda. Example: true - `pos_settings.return_exchange.coupon.is_allowed_print_per_product` (boolean) Permite imprimir um cupom por produto. Example: true - `pos_settings.return_exchange.coupon.notes` (string) Informação adicional do rodapé do Cupom de Troca. Example: "Não aceita produto sem a embalagem original" - `pos_settings.return_exchange.is_allowed_auto_print_returning_receipt` (boolean) Permite a impressão automática de comprovante de devolução. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. Example: true - `pos_settings.return_exchange.is_allowed_auto_issue_returning_invoice` (boolean) Emitir automaticamente a nota da devolução. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. Example: true - `pos_settings.installment_plan` (object) Configurações do módulo de crediário. - `pos_settings.installment_plan.is_enabled` (boolean, required) Habilita ou desabilita o crediário. Example: true - `pos_settings.installment_plan.settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `pos_settings.installment_plan.settings.customer_has_limit` (boolean, required) Habilita ou desabilita limite para o cliente. Ao selecionar essa opção, será disponibilizada uma nova área no cadastro do cliente, permitindo a configuração de um limite de crédito para o método de pagamento faturamento. Example: true - `pos_settings.installment_plan.settings.limit_settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `pos_settings.installment_plan.settings.limit_settings.credit_limit` (object) Limite de crediário padrão. - `pos_settings.installment_plan.settings.limit_settings.standard_max_installments` (integer) Limite de número de parcelas padrão. Example: 15 - `pos_settings.installment_plan.is_print_coupon_allowed` (boolean) Permite a impressão de cupons de crediário. Example: true - `pos_settings.installment_plan.carne_settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `pos_settings.installment_plan.carne_settings.late_fee_value` (number) Porcentagem da multa de atraso. Example: 1.2 - `pos_settings.installment_plan.carne_settings.interest` (number) Porcentagem de juros. Example: 3.5 - `pos_settings.installment_plan.carne_settings.description` (string) Texto que vai aparecer no carne ao ser impresso. Example: "Crediário com multa de atraso e juros" - `pos_settings.installment_plan.carne_settings.charge_from` (integer) Número de dias para aplicar a multa de atraso e juros. Example: 1 - `pos_settings.consigned` (object) Configurações relacionadas ao módulo de consignado. - `pos_settings.consigned.is_enabled` (boolean) Habilita o módulo de consignado. Example: true - `pos_settings.consigned.print` (object) Representa as configurações de impressão. - `pos_settings.consigned.print.is_allowed_auto_print_proof_when_closing_order` (boolean) Permite imprimir automaticamente comprovante ao finalizar uma Ordem. Example: true - `pos_settings.consigned.print.default_message` (string) Mensagem padrão da impressão. Example: "Mensagem padrão" - `pos_settings.consigned.print.printer_id` (integer) Identificador único da impressora. Permite impressão do Pedido de Consignado (A4). Example: 1 - `pos_settings.consigned.qty_day_to_return` (integer) Define a quantidade de dias para devolução de consignados. Example: 7 - `pos_settings.delivery` (object) Configurações relacionadas a entregas. - `pos_settings.delivery.is_enabled` (boolean) Habilita o módulo de delivery. Example: true - `pos_settings.delivery.time_limits` (object) Representa as configurações do limites de tempo produção e entrega. - `pos_settings.delivery.time_limits.qty_minutes_before_start_delivery` (integer) Quantidade em minutos para início da entrega. Example: 5 - `pos_settings.delivery.time_limits.qty_minutes_to_close_delivery` (integer) Quantidade em minutos para finalização da venda delivery. Example: 10 - `pos_settings.delivery.time_limits.qty_minutes_to_takeaway` (integer) Quantidade em minutos para finalização da venda para retirada. Example: 15 - `pos_settings.delivery.is_allowed_separate_sales_numbering` (boolean) Numeração de venda separada entre vendas delivery e vendas balcão. Example: true - `pos_settings.delivery.notes_setting` (object) Representa as configurações relacionadas a notas de entrega.. - `pos_settings.delivery.notes_setting.is_enabled` (boolean) Permite habilitar observações para clientes. Example: true - `pos_settings.delivery.notes_setting.is_enabled_notes_before_close_sale` (boolean) Permite habilitar observações do Delivery antes de finalizar a venda. Example: true - `pos_settings.delivery.delivery_area` (object) Representa as configurações da taxa de entrega padrão. - `pos_settings.delivery.delivery_area.delivery_price_type` (string, required) Tipo de taxa de entrega. - fixed: Taxa fixa - neighborhood: Taxa por bairro Enum: "fixed", "neighborhood" - `pos_settings.delivery.delivery_area.price` (object) Valor da taxa de entrega fixa. Importante: Este campo é obrigatório quando o delivery_price_type = fixed e proibido caso contrário. - `pos_settings.delivery.delivery_area.charge_type_when_not_configured` (string) Tipo de cobrança quando não existir taxa configurada para o bairro. - custom: Customizado - greater_value: Maior valor Importante: Este campo é obrigatório quando o delivery_price_type = neighborhood e proibido caso contrário. Enum: "custom", "greater_value" - `pos_settings.delivery.delivery_area.custom_rate` (object) Valor personalizado. Importante: Este campo é obrigatório quando o charge_type_when_not_configured = custom e proibido caso contrário. - `pos_settings.delivery.panel` (object) Representa as configurações do painel de delivery. - `pos_settings.delivery.panel.qty_days` (integer) Limite de dias para exibição de vendas delivery. Example: 3 - `pos_settings.delivery.panel.qty_hours_before_scheduled_orders` (integer) Aviso de Impressão de Pedidos Agendados (horas). Example: 3 - `pos_settings.delivery.default_ddd` (integer) DDD que será preenchido automaticamente no delivery. Example: 41 - `pos_settings.delivery.is_carrier_required` (boolean) Exigir seleção de entregador ao mover pedido para status de "Em entrega" Ao mover o pedido para o status "Saiu para entrega", exige selecionar um entregador Example: true - `pos_settings.delivery.is_enable_option_complete_sale_after_delivery` (boolean) Habilita a opção de finalizar a venda após a entrega. Example: true - `service_settings` (object) Configurações relacionadas ao atendimento e pré-venda. - `service_settings.service` (object) Configurações gerais de atendimento e pré-venda. - `service_settings.service.is_enabled` (boolean) Habilita o atendimento e Pré-venda. Example: true - `service_settings.service.is_allowed_use_barcode_in_service` (boolean) Permite usar código de barras no atendimento. Example: true - `service_settings.service.waiter_selection_mode` (string) Define o modo de seleção de garçom: - keyboard: Teclado para digitar senha - listing: Busca e listagem Enum: "keyboard", "listing" - `service_settings.service.initial_home_screen` (string) Tela padrão de início: - bar_tab: Comanda - table: Mesa Enum: "bar_tab", "table" - `service_settings.service.is_reason_for_cancel_item_required` (boolean) Exige motivo para cancelamento de item. Example: true - `service_settings.service.is_allowed_print_summary_when_closing_check` (boolean) Imprimir resumo ao fechar conta. Example: true - `service_settings.service.print_order_type` (string) Tipo de impressão dos Pedidos. - all: Imprimir todos os produtos do pedido - only_with_printer: Imprimir apenas produtos com impressora Enum: "all", "only_with_printer" - `service_settings.service.is_allowed_print_product_with_reset_values` (boolean) Imprimir produtos com valor zerado nos pedidos. Example: true - `service_settings.service.is_enabled_status_table_awaiting_release` (boolean) Habilitar status "Mesa aguardando liberação". Example: true - `service_settings.service.is_customer_required_to_initiate` (boolean) É obrigatório selecionar cliente ao iniciar atendimento. Example: true - `service_settings.service.is_reason_for_cancel_bar_tab_required` (boolean) Exige motivo para cancelamento de comanda. Example: true - `service_settings.service.printer_id` (integer) Identificador único da impressora. Example: 1 - `service_settings.service.scale_id` (integer) Identificador único da balança. Example: 1 - `service_settings.service.is_allowed_use_product_code_in_service` (boolean) Permite usar código de produto no atendimento. Example: true - `service_settings.service.is_allowed_ask_for_waiter_code` (boolean) Permite solicitar código de garçom. Example: true - `service_settings.service_fee` (object) Configurações gerais da taxa de atendimento. - `service_settings.service_fee.is_enabled` (boolean) Habilita a taxa de atendimento. Example: true - `service_settings.service_fee.is_password_required_to_edit` (boolean) Permite solicitar senha para alterar taxa de serviço. Example: true - `service_settings.service_fee.fee_value_in_percent` (number) Define o valor da taxa em porcentagem. Example: 10.5 - `kds_settings` (object) Configurações do monitor de cozinha (KDS). - `kds_settings.kds` (object) Representa as configurações do monitor de cozinha (KDS). - `kds_settings.kds.is_enabled` (boolean) Habilita o monitor de cozinha. Example: true - `kds_settings.kds.is_allowed_show_start_button` (boolean) Permite a exibição do botão de início no KDS. Example: true - `kds_settings.kds.is_allowed_show_customer_name` (boolean) Exibe o nome do cliente no monitor. Example: true - `kds_settings.kds.is_allowed_start_order_item_by_item` (boolean) Permite iniciar pedido item a item. Example: true - `kds_settings.kds.is_allowed_close_order_item_by_item` (boolean) Permite fechar pedidos item por item. Example: true ## Response 200 fields (application/json): - `data` (object) Representa uma configurações gerais do terminal. - `data.pos_settings` (object) Configurações gerais do terminal. - `data.pos_settings.stock` (object) Configurações gerais do estoque. - `data.pos_settings.stock.is_allowed_notify_negative_stock` (boolean) Notificações de estoque negativo. Example: true - `data.pos_settings.stock.is_allowed_block_sale_zero_or_negative_stock` (boolean) Bloqueia a venda de itens com estoque zero ou negativo. Example: true - `data.pos_settings.security` (object) Configurações gerais de segurança. - `data.pos_settings.security.cancellation` (object) Representa as configurações de cancelamento. - `data.pos_settings.security.cancellation.is_password_required` (boolean) Requer senha para o cancelamento. Example: true - `data.pos_settings.security.abandonment` (object) Representa as configurações de abandono. - `data.pos_settings.security.abandonment.is_enabled_to_record` (boolean) Permite gravar abandono de venda no relatório. Example: true - `data.pos_settings.security.abandonment.is_reason_required` (boolean) Permite exigir motivo de abandono de venda. Example: true - `data.pos_settings.security.password` (string) Senha para cancelamento de venda ou abandono de venda ou abertura de gaveta. Example: "123456" - `data.pos_settings.customer_credit` (object) Configurações do crédito de cliente. - `data.pos_settings.customer_credit.is_allowed_credit` (boolean) Permite o uso de crédito de clientes. Example: true - `data.pos_settings.customer_credit.is_allowed_negative_credit` (boolean) Permite crédito negativo para clientes. Example: true - `data.pos_settings.customer_credit.is_allowed_print_customer_credit_coupon` (boolean) Imprimir cupom ao adicionar/remover crédito de cliente. Example: true - `data.pos_settings.cash_closing` (object) Configurações do fechamento de caixa. - `data.pos_settings.cash_closing.transfer_auto` (object) Representa as configurações de transferência automática ao fechar. - `data.pos_settings.cash_closing.transfer_auto.is_enabled` (boolean) Ativa transferência automática ao fechar. Example: true - `data.pos_settings.cash_closing.transfer_auto.bank_account` (object) Conta bancária. - `data.pos_settings.cash_closing.transfer_auto.bank_account.id` (integer) Identificador único da conta bancária. Example: 123 - `data.pos_settings.cash_closing.transfer_auto.bank_account.name` (string) Nome da conta bancária Example: "ConnectPlug Bank" - `data.pos_settings.cash_closing.transfer_auto.bank_account.initial_date` (string) Data. Example: "2025-01-30" - `data.pos_settings.cash_closing.transfer_auto.bank_account.initial_value` (object) Valor inicial da conta bancária - `data.pos_settings.cash_closing.transfer_auto.bank_account.initial_value.amount` (number, required) Valor expresso como um número decimal das principais unidades monetárias Example: 99.95 - `data.pos_settings.cash_closing.transfer_auto.bank_account.initial_value.currency` (string, required) Código de moeda de 3 letras conforme definido pela ISO-4217 Example: "BRL" - `data.pos_settings.cash_closing.transfer_auto.bank_account.bank` (object) Representa um banco. - `data.pos_settings.cash_closing.transfer_auto.bank_account.bank.id` (integer) Identificador único do banco. Example: 123 - `data.pos_settings.cash_closing.transfer_auto.bank_account.bank.code` (integer) Código do banco Example: 10 - `data.pos_settings.cash_closing.transfer_auto.bank_account.bank.image` (string) URL da imagem do banco Example: "https://connectplug.com.br/images/banks/10.png" - `data.pos_settings.cash_closing.transfer_auto.bank_account.deleted` (boolean) Indica se está apagado ou não. - `data.pos_settings.cash_closing.transfer_auto.bank_account.companies` (array) Lista de empresas que permite visualizar. - `data.pos_settings.cash_closing.transfer_auto.bank_account.companies.id` (integer) Identificador único da empresa Example: 1234 - `data.pos_settings.cash_closing.transfer_auto.bank_account.companies.name` (string) Nome fantasia da empresa. Example: "CPlug" - `data.pos_settings.cash_closing.transfer_auto.bank_account.companies.company_name` (string,null) Razão social da empresa. Example: "CPlug Tecnologia da Informação" - `data.pos_settings.cash_closing.transfer_auto.bank_account.first_transaction_date` (string) Data da primeira transação na conta bancária. Example: "2025-01-30" - `data.pos_settings.cash_closing.transfer_auto.bank_account.created_at` (string) Data da última criação. Example: "2020-01-01T09:00:00-03:00" - `data.pos_settings.cash_closing.transfer_auto.bank_account.updated_at` (string) Data da última atualização. Example: "2020-01-01T09:00:00-03:00" - `data.pos_settings.cash_closing.transfer_auto.min_value_in_cash` (object) Valor que deve permanecer no caixa. - `data.pos_settings.cash_closing.is_approval_required` (boolean) Exige aprovação para fechamento. Example: true - `data.pos_settings.cash_closing.is_allowed_auto_print_cash_closing_report` (boolean) Imprimir fechamento de caixa automaticamente. Example: true - `data.pos_settings.discount` (object) Configurações de desconto. - `data.pos_settings.discount.is_enabled` (boolean) Permite descontos no PDV. Example: true - `data.pos_settings.discount.type` (string) Define o tipo de desconto.: - fixed: Desconto fixo - open: Desconto aberto para alteração Enum: "fixed", "open" - `data.pos_settings.discount.value_type` (string) Tipo de valor de desconto: - monetary: Desconto em valor - percent: Desconto em porcentagem Enum: "monetary", "percent" - `data.pos_settings.discount.is_password_required` (boolean) Requisitar usuário/senha de gerente para desconto. Example: true - `data.pos_settings.discount.max_value` (object) Representa as configurações do valor do desconto máximo. - `data.pos_settings.discount.max_value.is_enabled` (boolean) Habilita valor máximo. Example: true - `data.pos_settings.discount.max_value.sales` (number) Valor máximo na Venda, podendo ser em porcentagem ou valor absoluto, de acordo com o campo value_type. Example: 10.5 - `data.pos_settings.discount.max_value.product` (number) Valor máximo no Produto, podendo ser em porcentagem ou valor absoluto, de acordo com o campo value_type. Example: 11.5 - `data.pos_settings.sale` (object) Configurações de venda. - `data.pos_settings.sale.is_allowed_show_customers_latest_sales` (boolean) Mostra as últimas vendas dos clientes. Example: true - `data.pos_settings.sale.is_card_auth_required` (boolean) Exige autenticação de cartão para vendas. Example: true - `data.pos_settings.sale.is_seller_first_required` (boolean) Exige identificação do vendedor antes da venda. Example: true - `data.pos_settings.sale.qty_last_sales_to_show` (integer) Define a quantidade de vendas passadas a serem exibidas. Example: 50 - `data.pos_settings.sale.is_allowed_to_edit_product_value` (boolean) Permite a edição de valores de produtos. Example: true - `data.pos_settings.sale.additional_information` (string) Informações adicionais no relatório de gerencial. Example: "mais informações" - `data.pos_settings.sale.is_allowed_edit_amount` (boolean) Permitir edição de quantidade de produtos na venda. Example: true - `data.pos_settings.sale.is_allowed_open_attendance_in_cashier` (boolean) Permitir abrir comanda ao iniciar venda balcão. Example: true - `data.pos_settings.sale.is_require_customer_name` (boolean) Exigir nome do cliente ao finalizar a venda. Example: true - `data.pos_settings.sale.is_allowed_bind_customer_to_sale_by_cpf` (boolean) Vincular cliente à venda atual ao adicionar CPF na nota. Example: true - `data.pos_settings.sale.is_allowed_service_fee_for_cashier_sales` (boolean) Utilizar taxa de serviço para vendas no balcão. Example: true - `data.pos_settings.sale.is_allowed_use_barcode_generated_by_scale` (boolean) Utilizar código de barras gerado pela balança. Example: true - `data.pos_settings.sale.is_allowed_use_default_city_uf` (boolean) Utilizar cidade e UF padrão para venda. Ao cadastrar um cliente usar Cidade e UF da empresa como padrão! Example: true - `data.pos_settings.pick_up` (object) Configurações de sangria ou de reforço. - `data.pos_settings.pick_up.is_enabled` (boolean) Habilita o recurso de sangria ou reforço de caixa. Example: true - `data.pos_settings.pick_up.value` (object) Valor de alerta de sangria ou bloqueio do PDV. - `data.pos_settings.pick_up.is_allowed_block_pdv` (boolean) Bloquear PDV ao atingir valor máximo de dinheiro no caixa. Example: true - `data.pos_settings.pick_up.is_allowed_print_receipt` (boolean) Impressão automática de sangria em cada realização. Example: true - `data.pos_settings.cash_drawer` (object) Configurações da gaveta de dinheiro. - `data.pos_settings.cash_drawer.is_password_required_to_open` (boolean) Exige senha para abrir a gaveta. Example: true - `data.pos_settings.cash_drawer.auto_open_type` (string) Tipo de abertura automática: - all: Ao finalizar uma venda (qualquer método de pagamento) - only_cash_payment: Ao finalizar uma venda com método de pagamento igual a dinheiro Enum: "all", "only_cash_payment" - `data.pos_settings.cash_drawer.is_enabled_open_drawer_button` (boolean) Habilita o botão de abertura da gaveta. Example: true - `data.pos_settings.cash_drawer.when_auto_open` (array) Quando abrir automaticamente Enum: "pick_up", "customer_credit", "customer_billing" - `data.pos_settings.print` (object) Configurações gerais de impressão. - `data.pos_settings.print.is_allowed_auto_print_danfe_ce` (boolean) Impressão automática de NFCE-e/CF-e. Example: true - `data.pos_settings.print.is_allowed_print_company_info_on_header` (boolean) Imprimir as informações da empresa no cabeçalho. Example: true - `data.pos_settings.print.is_allowed_print_sales_number_invoice` (boolean) Imprimir o número da venda na nota fiscal. Example: true - `data.pos_settings.print.fractional_printing_type` (string) Tipo de impressão fracionada: - fractioned: Imprimir atributos múltiplos de forma fracionada - grouped: Imprimir atributos múltiplos de forma agrupada - dynamic: Imprimir atributos múltiplos dependendo da configuração do atributo Enum: "fractioned", "grouped", "dynamic" - `data.pos_settings.print.is_allowed_auto_print_at_closing_sale` (boolean) Impressão automática no fechamento de vendas. Example: true - `data.pos_settings.print.report_font_size` (string) Tamanho da letra na impressão do relatório gerencial. Enum: "small", "medium", "large" - `data.pos_settings.return_exchange` (object) Configurações relacionadas à devolução e troca de produtos. - `data.pos_settings.return_exchange.is_allowed_return` (boolean) Permite devolução de produtos. Example: true - `data.pos_settings.return_exchange.is_allowed_exchange` (boolean) Permite troca de produtos. Example: true - `data.pos_settings.return_exchange.coupon` (object) Representa as configurações do cupom de troca. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. - `data.pos_settings.return_exchange.coupon.is_allowed_auto_print` (boolean) Permite imprimir automaticamente a cada venda. Example: true - `data.pos_settings.return_exchange.coupon.is_allowed_print_per_product` (boolean) Permite imprimir um cupom por produto. Example: true - `data.pos_settings.return_exchange.coupon.notes` (string) Informação adicional do rodapé do Cupom de Troca. Example: "Não aceita produto sem a embalagem original" - `data.pos_settings.return_exchange.is_allowed_auto_print_returning_receipt` (boolean) Permite a impressão automática de comprovante de devolução. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. Example: true - `data.pos_settings.return_exchange.is_allowed_auto_issue_returning_invoice` (boolean) Emitir automaticamente a nota da devolução. Não enviar este campo quando os campos is_allowed_return = false e is_allowed_exchange = false. Example: true - `data.pos_settings.installment_plan` (object) Configurações do módulo de crediário. - `data.pos_settings.installment_plan.is_enabled` (boolean, required) Habilita ou desabilita o crediário. Example: true - `data.pos_settings.installment_plan.settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `data.pos_settings.installment_plan.settings.customer_has_limit` (boolean, required) Habilita ou desabilita limite para o cliente. Ao selecionar essa opção, será disponibilizada uma nova área no cadastro do cliente, permitindo a configuração de um limite de crédito para o método de pagamento faturamento. Example: true - `data.pos_settings.installment_plan.settings.limit_settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `data.pos_settings.installment_plan.settings.limit_settings.credit_limit` (object) Limite de crediário padrão. - `data.pos_settings.installment_plan.settings.limit_settings.standard_max_installments` (integer) Limite de número de parcelas padrão. Example: 15 - `data.pos_settings.installment_plan.is_print_coupon_allowed` (boolean) Permite a impressão de cupons de crediário. Example: true - `data.pos_settings.installment_plan.carne_settings` (object) Representa uma configurações do crediário. Este campo dever ser enviado quando o crediário está habilitado. - `data.pos_settings.installment_plan.carne_settings.late_fee_value` (number) Porcentagem da multa de atraso. Example: 1.2 - `data.pos_settings.installment_plan.carne_settings.interest` (number) Porcentagem de juros. Example: 3.5 - `data.pos_settings.installment_plan.carne_settings.description` (string) Texto que vai aparecer no carne ao ser impresso. Example: "Crediário com multa de atraso e juros" - `data.pos_settings.installment_plan.carne_settings.charge_from` (integer) Número de dias para aplicar a multa de atraso e juros. Example: 1 - `data.pos_settings.consigned` (object) Configurações relacionadas ao módulo de consignado. - `data.pos_settings.consigned.is_enabled` (boolean) Habilita o módulo de consignado. Example: true - `data.pos_settings.consigned.print` (object) Representa as configurações de impressão. - `data.pos_settings.consigned.print.is_allowed_auto_print_proof_when_closing_order` (boolean) Permite imprimir automaticamente comprovante ao finalizar uma Ordem. Example: true - `data.pos_settings.consigned.print.default_message` (string) Mensagem padrão da impressão. Example: "Mensagem padrão" - `data.pos_settings.consigned.print.printer` (object) Impressora. - `data.pos_settings.consigned.print.printer.id` (integer) Identificador único da impressora Example: 1234 - `data.pos_settings.consigned.print.printer.name` (string) Nome da impressora. Example: "Cozinha" - `data.pos_settings.consigned.print.printer.model` (string) Modelo da impressora. Example: "Epson TM-20" - `data.pos_settings.consigned.qty_day_to_return` (integer) Define a quantidade de dias para devolução de consignados. Example: 7 - `data.pos_settings.delivery` (object) Configurações relacionadas a entregas. - `data.pos_settings.delivery.is_enabled` (boolean) Habilita o módulo de delivery. Example: true - `data.pos_settings.delivery.time_limits` (object) Representa as configurações do limites de tempo produção e entrega. - `data.pos_settings.delivery.time_limits.qty_minutes_before_start_delivery` (integer) Quantidade em minutos para início da entrega. Example: 5 - `data.pos_settings.delivery.time_limits.qty_minutes_to_close_delivery` (integer) Quantidade em minutos para finalização da venda delivery. Example: 10 - `data.pos_settings.delivery.time_limits.qty_minutes_to_takeaway` (integer) Quantidade em minutos para finalização da venda para retirada. Example: 15 - `data.pos_settings.delivery.is_allowed_separate_sales_numbering` (boolean) Numeração de venda separada entre vendas delivery e vendas balcão. Example: true - `data.pos_settings.delivery.notes_setting` (object) Representa as configurações relacionadas a notas de entrega.. - `data.pos_settings.delivery.notes_setting.is_enabled` (boolean) Permite habilitar observações para clientes. Example: true - `data.pos_settings.delivery.notes_setting.is_enabled_notes_before_close_sale` (boolean) Permite habilitar observações do Delivery antes de finalizar a venda. Example: true - `data.pos_settings.delivery.delivery_area` (object) Representa as configurações da taxa de entrega padrão. - `data.pos_settings.delivery.delivery_area.delivery_price_type` (string, required) Tipo de taxa de entrega. - fixed: Taxa fixa - neighborhood: Taxa por bairro Enum: "fixed", "neighborhood" - `data.pos_settings.delivery.delivery_area.price` (object) Valor da taxa de entrega fixa. Importante: Este campo é obrigatório quando o delivery_price_type = fixed e proibido caso contrário. - `data.pos_settings.delivery.delivery_area.charge_type_when_not_configured` (string) Tipo de cobrança quando não existir taxa configurada para o bairro. - custom: Customizado - greater_value: Maior valor Importante: Este campo é obrigatório quando o delivery_price_type = neighborhood e proibido caso contrário. Enum: "custom", "greater_value" - `data.pos_settings.delivery.delivery_area.custom_rate` (object) Valor personalizado. Importante: Este campo é obrigatório quando o charge_type_when_not_configured = custom e proibido caso contrário. - `data.pos_settings.delivery.panel` (object) Representa as configurações do painel de delivery. - `data.pos_settings.delivery.panel.qty_days` (integer) Limite de dias para exibição de vendas delivery. Example: 3 - `data.pos_settings.delivery.panel.qty_hours_before_scheduled_orders` (integer) Aviso de Impressão de Pedidos Agendados (horas). Example: 3 - `data.pos_settings.delivery.default_ddd` (integer) DDD que será preenchido automaticamente no delivery. Example: 41 - `data.pos_settings.delivery.is_carrier_required` (boolean) Exigir seleção de entregador ao mover pedido para status de "Em entrega" Ao mover o pedido para o status "Saiu para entrega", exige selecionar um entregador Example: true - `data.pos_settings.delivery.is_enable_option_complete_sale_after_delivery` (boolean) Habilita a opção de finalizar a venda após a entrega. Example: true - `data.service_settings` (object) Configurações relacionadas ao atendimento e pré-venda. - `data.service_settings.service` (object) Configurações gerais de atendimento e pré-venda. - `data.service_settings.service.is_enabled` (boolean) Habilita o atendimento e Pré-venda. Example: true - `data.service_settings.service.is_allowed_use_barcode_in_service` (boolean) Permite usar código de barras no atendimento. Example: true - `data.service_settings.service.waiter_selection_mode` (string) Define o modo de seleção de garçom: - keyboard: Teclado para digitar senha - listing: Busca e listagem Enum: "keyboard", "listing" - `data.service_settings.service.initial_home_screen` (string) Tela padrão de início: - bar_tab: Comanda - table: Mesa Enum: "bar_tab", "table" - `data.service_settings.service.is_reason_for_cancel_item_required` (boolean) Exige motivo para cancelamento de item. Example: true - `data.service_settings.service.is_allowed_print_summary_when_closing_check` (boolean) Imprimir resumo ao fechar conta. Example: true - `data.service_settings.service.print_order_type` (string) Tipo de impressão dos Pedidos. - all: Imprimir todos os produtos do pedido - only_with_printer: Imprimir apenas produtos com impressora Enum: "all", "only_with_printer" - `data.service_settings.service.is_allowed_print_product_with_reset_values` (boolean) Imprimir produtos com valor zerado nos pedidos. Example: true - `data.service_settings.service.is_enabled_status_table_awaiting_release` (boolean) Habilitar status "Mesa aguardando liberação". Example: true - `data.service_settings.service.is_customer_required_to_initiate` (boolean) É obrigatório selecionar cliente ao iniciar atendimento. Example: true - `data.service_settings.service.is_reason_for_cancel_bar_tab_required` (boolean) Exige motivo para cancelamento de comanda. Example: true - `data.service_settings.service.scale` (object) Balança. - `data.service_settings.service.scale.id` (integer) Identificador único da impressora ou balança. Example: 1234 - `data.service_settings.service.scale.name` (string) Nome da impressora ou balança. Example: "Cozinha" - `data.service_settings.service.scale.device_name` (string) Nome do dispositivo. Example: "Epson TM-20" - `data.service_settings.service.is_allowed_use_product_code_in_service` (boolean) Permite usar código de produto no atendimento. Example: true - `data.service_settings.service.is_allowed_ask_for_waiter_code` (boolean) Permite solicitar código de garçom. Example: true - `data.service_settings.service_fee` (object) Configurações gerais da taxa de atendimento. - `data.service_settings.service_fee.is_enabled` (boolean) Habilita a taxa de atendimento. Example: true - `data.service_settings.service_fee.is_password_required_to_edit` (boolean) Permite solicitar senha para alterar taxa de serviço. Example: true - `data.service_settings.service_fee.fee_value_in_percent` (number) Define o valor da taxa em porcentagem. Example: 10.5 - `data.kds_settings` (object) Configurações do monitor de cozinha (KDS). - `data.kds_settings.kds` (object) Representa as configurações do monitor de cozinha (KDS). - `data.kds_settings.kds.is_enabled` (boolean) Habilita o monitor de cozinha. Example: true - `data.kds_settings.kds.is_allowed_show_start_button` (boolean) Permite a exibição do botão de início no KDS. Example: true - `data.kds_settings.kds.is_allowed_show_customer_name` (boolean) Exibe o nome do cliente no monitor. Example: true - `data.kds_settings.kds.is_allowed_start_order_item_by_item` (boolean) Permite iniciar pedido item a item. Example: true - `data.kds_settings.kds.is_allowed_close_order_item_by_item` (boolean) Permite fechar pedidos item por item. Example: true ## Response 400 fields (application/json): - `code` (string, required) Código de erro. Example: "missing_headers" - `message` (string) Descrição do erro. Example: "error message" - `meta` (array) Dados adicionais sobre o erro. ## Response 422 fields (application/json): - `code` (string, required) Código de erro. Example: "uneditable_entity" - `message` (string) Descrição do erro. Example: "description error" - `meta` (array) Dados adicionais sobre o erro. - `meta.field` (string, required) Nome do campo no qual existe um erro de validação. Example: "name" - `meta.validations` (array) - `meta.validations.type` (string, required) Tipo da validação aplicada. Example: "Required" - `meta.validations.value` (array) Tipo de valor aplicável (esse campo pode ser vazio). ## Response 401 fields ## Response 404 fields