CPlug (ConnectPlug)

Avança etapa da ordem de produção (POST /api/v3/production-orders/{productionOrderId}/advance). [write]

Deleta empresas em massa (POST /api/v3/companies/batch-delete). [write]

Deleta clientes em massa (POST /api/v3/customers/batch-delete). [write]

Cancela uma ordem de produção (POST /api/v3/production-orders/{productionOrderId}/cancel). [write]

Fechar caixa (POST /api/v3/pos/{posId}/drawer-close). [write]

Criar caixa registradora (POST /api/v3/cash-registers). [write]

Cria um envio automático (POST /api/v3/nfes/emitted-documents/schedules). [write]

Cria um novo ícone (POST /api/v3/icons). [write]

Cria uma ordem de produção (POST /api/v3/production-orders). [write]

Apaga uma categoria de produto do aplicativo (DELETE /api/v3/apps/{appId}/categories/{categoryId}). [write]

Apaga um aplicativo (DELETE /api/v3/apps/{appId}). [write]

Desvincular contrato de cartão (DELETE /api/v3/apps/{appId}/card-contracts/{cardContractId}). [write]

Apaga uma grade de preço de um produto (DELETE /api/v3/apps/{appId}/items/{productId}/grids/{gridId}). [write]

Apaga uma opção de um produto (DELETE /api/v3/apps/{appId}/items/{productId}/options/{optionId}). [write]

Apaga um atributo (DELETE /api/v3/attributes/{attributeId}). [write]

Apaga uma opção (DELETE /api/v3/attributes/{attributeId}/options/{optionId}). [write]

Apaga uma conta bancária (DELETE /api/v3/bank-accounts/{bankAccountId}). [write]

Apaga atributos em massa (DELETE /api/v3/attributes/batch-delete). [write]

Apaga um lote (DELETE /api/v3/bulks/{kind}/destroy). [write]

Apaga um contrato de cartão (DELETE /api/v3/cards/contracts/{cardContractId}). [write]

Apaga uma transportadora (DELETE /api/v3/carriers/{carrierId}). [write]

Excluir caixa registradora (DELETE /api/v3/cash-registers/{cashRegisterId}). [write]

Apaga uma categoria (DELETE /api/v3/categories/{categoryId}). [write]

Apaga uma série de comanda (DELETE /api/v3/command-series/{commandSeriesId}). [write]

Apaga uma empresa (DELETE /api/v3/companies/{companyId}). [write]

Apaga um centro de custo (DELETE /api/v3/cost-centers/{costCenterId}). [write]

Apaga uma categoria de cliente (DELETE /api/v3/customer-categories/{customerCategoryId}). [write]

Apaga um cliente (DELETE /api/v3/customers/{customerId}). [write]

Apaga um endereço (DELETE /api/v3/customers/{customerId}/addresses/{addressId}). [write]

Apaga um documento (DELETE /api/v3/customers/{customerId}/documents/{documentType}). [write]

Apaga uma customização (DELETE /api/v3/customizations/{customizationId}). [write]

Apaga uma mídia de uma customização (DELETE /api/v3/customizations/{customizationId}/media/{mediaId}). [write]

Apaga uma área de entrega (DELETE /api/v3/delivery-areas/{deliveryAreaId}). [write]

Apaga um registro (DELETE /api/v3/nfes/emitted-documents/schedules/{id}). [write]

Apaga um filtro (DELETE /api/v3/filters/{filterId}). [write]

Apaga um plano de contas (DELETE /api/v3/financial/account-plans/{accountPlanId}). [write]

Apaga um grupo financeiro (DELETE /api/v3/financial/groups/{groupId}). [write]

Apaga uma transação financeira (DELETE /api/v3/financial/transactions/{transactionId}). [write]

Apaga um anexo (DELETE /api/v3/financial/transactions/{transactionId}/files/{fileId}). [write]

Apaga um ícone (DELETE /api/v3/icons/{iconId}). [write]

Apaga uma integração (DELETE /api/v3/integrations/{integrationId}). [write]

Apagar exportação de produtos (DELETE /api/v3/integrations/tray/export-products). [write]

Apagar importação de produtos (DELETE /api/v3/integrations/tray/import-products). [write]

Apaga um KDS (DELETE /api/v3/kds/{kdsId}). [write]

Apaga uma etiqueta (DELETE /api/v3/labels/{labelId}). [write]

Apaga método de pagamento (DELETE /api/v3/payments/{paymentId}). [write]

Desassociar um produto de um periférico (DELETE /api/v3/peripherals/{peripheralId}/products/{productId}). [write]

Apaga um periférico (DELETE /api/v3/peripherals/{peripheralId}). [write]

Apaga uma lista de preço (DELETE /api/v3/price-lists/{priceListId}). [write]

Apaga um aplicativo de um produto (DELETE /api/v3/products/{productId}/apps/{appId}). [write]

Apaga todos os horário de um produto no aplicativo (DELETE /api/v3/products/{productId}/apps/{appId}/shifts). [write]

Remove uma grade de preços (DELETE /api/v3/products/{productId}/grids/{gridId}). [write]

Apaga um produto (DELETE /api/v3/products/{productId}). [write]

Apaga atributo (DELETE /api/v3/products/{productId}/attributes/{attributeId}). [write]

Apaga uma composição (DELETE /api/v3/products/{productId}/compositions/{componentId}). [write]

Apaga fornecedor (DELETE /api/v3/products/{productId}/suppliers/{productSupplierId}). [write]

Apaga um perfil (DELETE /api/v3/profiles/{profileId}). [write]

Apaga uma promoção (DELETE /api/v3/promotions/{promotionId}). [write]

Apaga uma compra (DELETE /api/v3/purchases/{purchaseId}). [write]

Apaga um anexo (DELETE /api/v3/purchases/{purchaseId}/files/{fileId}). [write]

Apaga um item do XML (DELETE /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}). [write]

Apaga XML (DELETE /api/v3/purchase-invoices/{purchaseInvoiceId}). [write]

Apaga uma conciliação bancária (DELETE /api/v3/reconciliations/{reconciliationId}). [write]

Apaga uma transação de uma conciliação bancária (DELETE /api/v3/reconciliations/{reconciliationId}/transactions/{transactionId}). [write]

Apaga um pedido de venda (DELETE /api/v3/sale-orders/{saleOrderId}). [write]

Cancela uma venda (DELETE /api/v3/sales/{saleId}). [write]

Apaga um bairro customizado (DELETE /api/v3/settings/districts/{id}). [write]

Apaga canal de venda (DELETE /api/v3/sources/{sourceId}). [write]

Deleta uma observação padrão (DELETE /api/v3/standard-observations/{standardObservationId}). [write]

Apaga um inventário (DELETE /api/v3/stocks/{stockId}/inventories/{inventoryId}). [write]

Apaga uma categoria de movimentação de estoque (DELETE /api/v3/stocks/movements/categories/{stockMovementCategoryId}). [write]

Apaga uma movimentação de um produto (PATCH /api/v3/stocks/{stockId}/products/{productId}/movements/{stockMovementId}). [write]

Apaga uma transferência entre estoques (DELETE /api/v3/stock-transfers/{transferId}). [write]

Apaga um estoque (DELETE /api/v3/stocks/{stockId}). [write]

Revogar Access Token (DELETE /api/v1/store/oauth/token). [write]

Apaga um endereço do cliente na loja (DELETE /api/v1/store/accounts/addresses/{addressId}). [write]

Apaga um fornecedor (DELETE /api/v3/suppliers/{supplierId}). [write]

Apaga uma mesa (DELETE /api/v3/tables/{tableId}). [write]

Apaga uma informação adicional da NF-e (DELETE /api/v3/tax-settings/nfe-additional-infos/{id}). [write]

Apaga um grupo de ICMS (DELETE /api/v3/tax-settings/icms/{id}). [write]

Apaga uma série de nota fiscal (DELETE /api/v3/tax-settings/invoice-series/{id}). [write]

Apaga um grupo de IPI (DELETE /api/v3/tax-settings/ipi/{id}). [write]

Apaga um grupo de ISSQN (DELETE /api/v3/tax-settings/issqns/{id}). [write]

Apaga uma natureza de operação (DELETE /api/v3/tax-settings/nature-operations/{id}). [write]

Apaga um grupo de PIS/COFINS (DELETE /api/v3/tax-settings/pis-cofins/{id}). [write]

Apaga uma unidade de medida (DELETE /api/v3/units/{unitId}). [write]

Apaga um usuário (DELETE /api/v3/users/{userId}). [write]

Resumo financeiro do período (DRE já calculado): receita_total, cmv, despesas_total, resultado, margem_pct, lista de grupos e as maiores_despesas. Responde 'qual minha margem de lucro', 'qual o CMV',

Finaliza uma ordem de produção (POST /api/v3/production-orders/{productionOrderId}/finish). [write]

Lista métodos de pagamento (GET /api/v3/apps/{appId}/payment-methods).

Lista os produtos (GET /api/v3/apps/{appId}/items).

Lista as categorias de produto (GET /api/v3/apps/{appId}/categories).

Lista de aplicativos (GET /api/v3/apps).

Obtém credenciais do aplicativo (GET /api/v3/apps/{appId}/credentials).

Lista de aplicativos por canal de venda (GET /api/v3/apps/grouped-by-source).

Obtém um aplicativo (GET /api/v3/apps/{appId}).

Lista as grades de preço de um produto (GET /api/v3/apps/{appId}/items/{productId}/grids).

Lista as opções de um produto (GET /api/v3/apps/{appId}/items/{productId}/options).

Lista de atributos (GET /api/v3/attributes).

Obtém um atributo (GET /api/v3/attributes/{attributeId}).

Lista opções (GET /api/v3/attributes/{attributeId}/options).

Obtém uma conta bancária (GET /api/v3/bank-accounts/{bankAccountId}).

Obtém o histórico de uma conta bancária (GET /api/v3/bank-accounts/{bankAccountId}/history).

Obtém as movimentações de uma conta bancária (GET /api/v3/bank-accounts/{bankAccountId}/transactions).

Lista de contas bancárias (GET /api/v3/bank-accounts).

Lista de bancos (GET /api/v3/banks).

Gera códigos de barras (GET /api/v3/products/barcodes).

Obtém os dados de um lote da empresa (GET /api/v3/bulks/{bulkId}).

Obtém o status do lote (GET /api/v3/bulks/{kind}/status).

Lista os lotes da empresa (GET /api/v3/bulks).

Lista de bandeiras de cartões (GET /api/v3/cards/brands).

Lista de contratos de cartão (GET /api/v3/cards/contracts).

Lista de provedores de cartão (GET /api/v3/cards/providers).

Obtém uma transportadora (GET /api/v3/carriers/{carrierId}).

Lista de transportadoras (GET /api/v3/carriers).

Obter caixa registradora (GET /api/v3/cash-registers/{cashRegisterId}).

Lista de categorias (GET /api/v3/categories).

Obtém uma categoria (GET /api/v3/categories/{categoryId}).

Lista de CEST (GET /api/v3/products/cest).

Lista de CFOP (GET /api/v3/products/cfop).

Verifica quais os termos legais que foram ou não aceitos (GET /api/v1/store/accounts/legal-terms).

Lista de cidades (GET /api/v3/cities).

Lista de CNAEs (GET /api/v3/cnaes).

Lista de séries de comanda (GET /api/v3/command-series).

Obtém uma série de comanda (GET /api/v3/command-series/{commandSeriesId}).

Lista de empresas (GET /api/v3/companies).

Obtém dados de cobrança da empresa (GET /api/v3/companies/{companyId}/billing).

Obtém uma empresa (GET /api/v3/companies/{companyId}).

Obtém definições de uso da empresa (GET /api/v3/companies/{companyId}/use-definitions).

Lista dos centros de custos (GET /api/v3/cost-centers).

Obtém um centro de custo (GET /api/v3/cost-centers/{costCenterId}).

Lista de categorias de clientes (GET /api/v3/customer-categories).

Obtém uma categoria de cliente (GET /api/v3/customer-categories/{customerCategoryId}).

Lista de clientes (GET /api/v3/customers).

Obtém um cliente (GET /api/v3/customers/{customerId}).

Lista os endereços do cliente (GET /api/v3/customers/{customerId}/addresses).

Lista os documentos do cliente (GET /api/v3/customers/{customerId}/documents).

Obtém uma customização (GET /api/v3/customizations/{customizationId}).

Lista de customizações (GET /api/v3/customizations).

Obtém uma área de entrega (GET /api/v3/delivery-areas/{deliveryAreaId}).

Lista de áreas de entrega (GET /api/v3/delivery-areas).

Download PDF da transferência de estoque (GET /api/v3/stock-transfers/{transferId}/download-pdf).

Download do arquivo de uma conciliação bancária (GET /api/v3/reconciliations/{reconciliationId}/download).

Listar fechamentos de caixa (GET /api/v3/pos/drawer-list).

Listar vendas de um fechamento de caixa (GET /api/v3/pos/drawer-list/{drawerListId}/sales).

DRE (Demonstrativo de Resultado): receitas e despesas por conta contábil no período. query: {"date_start":"AAAA-MM-DD","date_end":"AAAA-MM-DD"} (máx 60 dias; sem datas = mês atual). Use para margem de

Exportar DRE em Excel (GET /api/v3/dre/excel).

Exportar DRE em PDF (GET /api/v3/dre/pdf).

Lista os envios automáticos (GET /api/v3/nfes/emitted-documents/schedules).

Exporta planilha de produtos para inventário (GET /api/v3/products/export-inventory).

Obtém uma lista produtos em CSV (GET /api/v3/price-lists/{priceListId}/items/export).

Download de Arquivo (GET /api/v3/files/{hash}/download).

Lista de filtros (GET /api/v3/filters).

Obtém um filtro (GET /api/v3/filters/{filterId}).

Lista de plano de contas (GET /api/v3/financial/account-plans).

Lista de grupos financeiros (GET /api/v3/financial/groups).

Obtém uma transação financeira (GET /api/v3/financial/transactions/{transactionId}).

Lista de lançamentos financeiros (entradas/saídas). Útil para detalhar despesas. query aceita filtros do módulo financeiro (ex.: {"type":"expense"}) + paginação {"page":1}. (GET /api/v3/financial/tran

Transações financeiras de um agrupamento (GET /api/v3/financial/transactions/{transactionId}/groupings).

Obtém um ícone (GET /api/v3/icons/{iconId}).

Lista de ícones (GET /api/v3/icons).

Obtém uma integração (GET /api/v3/integrations/{integrationId}).

Lista de integrações (GET /api/v3/integrations).

Lista produtos da integração Tray (GET /api/v3/integrations/tray/products).

Verifica situação da exportação (GET /api/v3/integrations/tray/export-products/status).

Verifica situação da importação (GET /api/v3/integrations/tray/import-products/status).

Lista os KDS (GET /api/v3/kds).

Obtém um KDS (GET /api/v3/kds/{kdsId}).

Visualiza uma etiqueta (GET /api/v3/labels/{labelId}).

Lista de etiquetas (GET /api/v3/labels).

Lista de termos legais padrão do sistema (GET /api/v3/legal-terms).

Lista de termos legais de um aplicativo (GET /api/v3/legal-terms/apps/{appId}).

Obtém as permissões do usuário autenticado (GET /api/v3/users/me/permissions).

Lista de NCM (GET /api/v3/products/ncm).

Obtém estatísticas da importação (GET /api/v3/nfes/received-documents/statistics).

Lista documentos fiscais eletrônicos emitidos (GET /api/v3/nfes/emitted-documents).

Lista histórico de envios de NFe por e-mail (GET /api/v3/nfes/emitted-documents/sending-history).

Lista os documentos fiscais eletrônicos recebidos (GET /api/v3/nfes/received-documents).

Lista os eventos de um documento fiscal eletrônico recebido (GET /api/v3/nfes/received-documents/{nfeInId}/events).

Lista de escopos (GET /api/v3/oauth/scopes).

Lista de horários de funcionamento (GET /api/v3/opening-hours).

Lista de ICMS de Origem (GET /api/v3/products/origin).

Lista as configurações do painel de senha (GET /api/v3/settings/password-panel).

Lista de formas de pagamentos (GET /api/v3/payments).

Obtém método de pagamento (GET /api/v3/payments/{paymentId}).

Lista as permissões de PDV (GET /api/v3/pdv-permissions).

Lista de produtos relacionados ao periférico (GET /api/v3/peripherals/{peripheralId}/products).

Lista de periféricos (GET /api/v3/peripherals).

Obtém um periférico (GET /api/v3/peripherals/{peripheralId}).

Lista de fabricantes de periféricos (GET /api/v3/peripherals/manufacturers).

Lista as permissões (GET /api/v3/permissions).

Obtém uma lista de preço (GET /api/v3/price-lists/{priceListId}).

Histórico de modificações de uma lista de preço (GET /api/v3/price-lists/{priceListId}/logs).

Lista as grades de preço de um produto (GET /api/v3/price-lists/{priceListId}/items/{productId}/grids).

Obtém histórico de modificações do preço de um produto (GET /api/v3/price-lists/{priceListId}/items/{productId}/logs).

Obtém as opções de um produto (GET /api/v3/price-lists/{priceListId}/items/{productId}/options).

Obtém a lista de produtos (GET /api/v3/price-lists/{priceListId}/items).

Lista de Listas de preços (GET /api/v3/price-lists).

Lista os aplicativos (GET /api/v3/products/{productId}/apps).

Obtém um aplicativo (GET /api/v3/products/{productId}/apps/{appId}).

Obtém os lotes de entrada de um produto (GET /api/v3/stocks/{stockId}/products/{productId}/batches).

Lista produtos que utilizam este componente (GET /api/v3/products/{productId}/composes).

Lista as composições (GET /api/v3/products/{productId}/compositions).

Lista as configurações de fichas de consumo de produtos (GET /api/v3/products/consumption-coupons).

Lista as grades de preço (GET /api/v3/products/{productId}/grids).

Obtém informações tributárias de um produto (GET /api/v3/products/{productId}/tax-settings).

Obtém uma ordem de produção (GET /api/v3/production-orders/{productionOrderId}).

Lista de ordens de produção (GET /api/v3/production-orders).

Lista de produtos (GET /api/v3/products).

Lista os atributos (GET /api/v3/products/{productId}/attributes).

Obtém um produto (GET /api/v3/products/{productId}).

Obtém custo de um produto (GET /api/v3/products/{productId}/cost-history).

Obtém saldo em estoque (GET /api/v3/products/{productId}/balance).

Lista integrações de um produto (GET /api/v3/products/{productId}/integrations).

Lista fornecedores (GET /api/v3/products/{productId}/suppliers).

Obtém fornecedor (GET /api/v3/products/{productId}/suppliers/{productSupplierId}).

Lista informações tributárias dos produtos (GET /api/v3/products/tax-settings).

Obtém um perfil (GET /api/v3/profiles/{profileId}).

Obtém as permissões de PDV do perfil (GET /api/v3/profiles/{profileId}/pdv-permissions).

Obtém as permissões do perfil (GET /api/v3/profiles/{profileId}/permissions).

Lista os perfis (GET /api/v3/profiles).

Obtém os limites de desconto dos perfis (GET /api/v3/profiles/discount-limits).

Obtém uma promoção (GET /api/v3/promotions/{promotionId}).

Lista de Promoções (GET /api/v3/promotions).

Lista os vouchers de uma promoção (GET /api/v3/promotions/{promotionId}/vouchers).

Exporta os vouchers de uma promoção (GET /api/v3/promotions/{promotionId}/vouchers/export).

Obtém uma compra (GET /api/v3/purchases/{purchaseId}).

Download do XML da NF-e (GET /api/v3/purchase-invoices/{purchaseInvoiceId}/download).

Obtém informações sobre o XML (GET /api/v3/purchase-invoices/{purchaseInvoiceId}/info).

Lista os itens do XML (GET /api/v3/purchase-invoices/{purchaseInvoiceId}/items).

Lista os XMLs de entrada (GET /api/v3/purchase-invoices).

Lista os produtos de uma compra (GET /api/v3/purchases/{purchaseId}/items).

Download PDF de uma compra (GET /api/v3/purchases/{purchaseId}/download-pdf).

Lista de compras (GET /api/v3/purchases).

Obtém uma conciliação bancária (GET /api/v3/reconciliations/{reconciliationId}).

Lista de conciliações bancárias (GET /api/v3/reconciliations).

Lista de transações de uma conciliação bancária (GET /api/v3/reconciliations/{reconciliationId}/transactions).

Lista de sugestões de transações de uma conciliação bancária (GET /api/v3/reconciliations/{reconciliationId}/transactions/{transactionId}/suggestions).

Obter relatório de vendas (GET /api/v3/reports/sales).

Download PDF de uma venda (GET /api/v3/sales/{saleId}/download-pdf).

Lista recebimentos de uma venda (GET /api/v3/sales/{saleId}/incomes).

Download PDF de um pedido de venda (GET /api/v3/sale-orders/{saleOrderId}/download-pdf).

Imprimir um pedido de venda (GET /api/v3/sale-orders/{saleOrderId}/print).

Lista de pedidos de venda (GET /api/v3/sale-orders).

Obtém um pedido de venda (GET /api/v3/sale-orders/{saleOrderId}).

Imprimir uma venda (GET /api/v3/sales/{saleId}/print).

Lista de vendas com os itens (produtos) de cada venda. query: filtros como {"start_date_time":"AAAA-MM-DDThh:mm:ss-03:00","end_date_time":"...","status":"closed","page":1}. Para ranking de produtos ma

Obtém uma venda (GET /api/v3/sales/{saleId}).

Lista os bairros de uma cidade (GET /api/v3/settings/districts).

Lista as configurações do ERP (GET /api/v3/settings/erp).

Lista as configurações do terminal (GET /api/v3/settings/terminal).

Obtém um contrato de cartão (GET /api/v3/cards/contracts/{cardContractId}).

Obtém um termo legal (GET /api/v3/legal-terms/{legalTermId}).

Obtém uma categoria de movimentação de estoque (GET /api/v3/stocks/movements/categories/{stockMovementCategoryId}).

Obtém um estoque (GET /api/v3/stocks/{stockId}).

Obtém um termo legal da loja (GET /api/v1/store/legal-terms/{legalTermType}).

Lista de canais de vendas (GET /api/v3/sources).

Obtém uma observação padrão (GET /api/v3/standard-observations/{standardObservationId}).

Lista as observações padrão (GET /api/v3/standard-observations).

Lista de estados (GET /api/v3/states).

Valor AGREGADO do período: faturamento total ou ticket médio. query: {"data_source":"sale","metric":"total_amount"|"ticket_avg","begin_date":"AAAA-MM-DD","until_date":"AAAA-MM-DD"}. NÃO agrupa por pro

Série TEMPORAL de faturamento ou ticket médio (por dia/mês/ano). query: {"data_source":"sale","metric":"total_amount","begin_date":"...","until_date":"...","group_type":"day"|"month"|"year"}. Só agrup

Lista de status (GET /api/v3/status).

Lista de detalhes do status (GET /api/v3/status/{statusId}/details).

Lista os inventários (GET /api/v3/stocks/{stockId}/inventories).

Obtém um inventário (GET /api/v3/stocks/{stockId}/inventories/{inventoryId}).

Lista os itens de um inventário (GET /api/v3/stocks/{stockId}/inventories/{inventoryId}/items).

Lista de categorias de movimentação de estoque (GET /api/v3/stocks/movements/categories).

Obtém situação da remoção de movimentações (GET /api/v3/stocks/{stockId}/reset-status).

Lista transferências entre estoques (GET /api/v3/stock-transfers).

Lista de estoques (GET /api/v3/stocks).

Lista os produtos de um estoque (GET /api/v3/stocks/{stockId}/products).

Obtém o balanço do produto no estoque (GET /api/v3/stocks/{stockId}/products/{productId}/balance).

Lista as movimentações de um produto (GET /api/v3/stocks/{stockId}/products/{productId}/movements).

Obtém detalhes de uma movimentação (GET /api/v3/stocks/{stockId}/movements/{stockMovementId}/composition).

Informações da Loja (GET /api/v1/store).

Obtém informações da conta do cliente logado (GET /api/v1/store/accounts).

Lista de escopos (GET /api/v1/store/oauth/scopes).

Lista de termos legais da loja (GET /api/v1/store/legal-terms).

Horário de funcionamento (GET /api/v1/store/opening-hours).

Métodos de pagamentos (GET /api/v1/store/payments).

Obter um endereço de do cliente na loja (GET /api/v1/store/accounts/addresses/{addressId}).

Lista de endereços do cliente na loja (GET /api/v1/store/accounts/addresses).

Lista de pedidos de venda do cliente na loja (GET /api/v1/store/orders).

Obter um pedido de venda de um cliente na loja (GET /api/v1/store/orders/{orderUuid}).

Obtém um fornecedor (GET /api/v3/suppliers/{supplierId}).

Lista de fornecedores (GET /api/v3/suppliers).

Obtém uma mesa (GET /api/v3/tables/{tableId}).

Lista de mesas (GET /api/v3/tables).

Lista informações adicionais da NF-e (GET /api/v3/tax-settings/nfe-additional-infos).

Obtém uma informação adicional da NF-e (GET /api/v3/tax-settings/nfe-additional-infos/{id}).

Obtém as configurações fiscais padrão (GET /api/v3/tax-settings/defaults).

Obtém as configurações gerais da NFe (GET /api/v3/tax-settings/general-settings).

Lista os grupos de ICMS (GET /api/v3/tax-settings/icms).

Lista motivos de desoneração (GET /api/v3/tax-settings/icms/exemptions).

Obtém um grupo de ICMS (GET /api/v3/tax-settings/icms/{id}).

Lista os grupos tributários (GET /api/v3/tax-settings/icms/tributary-groups).

Lista séries de notas fiscais (GET /api/v3/tax-settings/invoice-series).

Obtém uma série de nota fiscal (GET /api/v3/tax-settings/invoice-series/{id}).

Lista os grupos de IPI (GET /api/v3/tax-settings/ipi).

Obtém um grupo de IPI (GET /api/v3/tax-settings/ipi/{id}).

Lista as classificações legais de IPI (GET /api/v3/tax-settings/ipi/legal-classifications).

Lista os grupos tributários de IPI (GET /api/v3/tax-settings/ipi/tributary-groups).

Lista os grupos de ISSQN (GET /api/v3/tax-settings/issqns).

Obtém um grupo de ISSQN (GET /api/v3/tax-settings/issqns/{id}).

Lista naturezas de operações (GET /api/v3/tax-settings/nature-operations).

Obtém uma natureza de operação (GET /api/v3/tax-settings/nature-operations/{id}).

Lista os grupos de PIS/COFINS (GET /api/v3/tax-settings/pis-cofins).

Obtém um grupo de PIS/COFINS (GET /api/v3/tax-settings/pis-cofins/{id}).

Lista os grupos tributários de PIS/COFINS (GET /api/v3/tax-settings/pis-cofins/tributary-groups).

Obtém o tipo de nota emitida pelo PDV (GET /api/v3/tax-settings/type-invoice-pdv).

Lista as configurações do Totem (GET /api/v3/settings/totem).

Lista os tipos de negócio (GET /api/v3/types-of-business).

Lista de unidades de medidas (GET /api/v3/units).

Obtém uma unidade de medida (GET /api/v3/units/{unitId}).

Lista de usuários (GET /api/v3/users).

Obtém um usuário (GET /api/v3/users/{userId}).

Obtém o usuário autenticado (GET /api/v3/users/me).

Obtém as sessões ativas dos usuários (GET /api/v3/users/sessions).

Configurações do whitelabel (GET /api/v3/whitelabel/settings).

Obter informações de um CEP (GET /api/v3/zip-codes/{zipCode}).

Importa documentos fiscais eletrônicos (POST /api/v3/nfes/received-documents/import). [write]

Lista as conexões (logins) CPlug vinculadas a este install — id, label.

Lista todos os itens de todos os processos em massa (GET /api/v3/bulks/{bulkId}/items).

Lista caixas registradoras (GET /api/v3/cash-registers).

Abrir caixa (POST /api/v3/pos/{posId}/drawer-open). [write]

Vincular contrato de cartão (PATCH /api/v3/apps/{appId}/card-contracts/{cardContractId}). [write]

Associa produtos a um periférico (PATCH /api/v3/peripherals/{peripheralId}/products). [write]

Cria ou atualiza produtos (PATCH /api/v3/price-lists/{priceListId}/items). [write]

Atualiza tipo de balança e códigos de barras (PATCH /api/v3/products/{productId}/weight-scale). [write]

Atualiza as configurações do ERP (PATCH /api/v3/settings/erp). [write]

Atualiza as configurações gerais da NFe (PATCH /api/v3/tax-settings/general-settings). [write]

Sincroniza métodos de pagamento (PUT /api/v3/apps/{appId}/payment-methods/sync). [write]

Cria novo aplicativo (POST /api/v3/apps). [write]

Duplicar aplicativo (POST /api/v3/apps/{appId}/duplicate). [write]

Revogar licença (POST /api/v3/apps/{appId}/revoke-license). [write]

Atualiza logo do aplicativo (POST /api/v3/apps/{appId}/image). [write]

Enviar sincronização para aplicativos (POST /api/v3/apps/syncs). [write]

Gerenciar configurações da VPN (POST /api/v3/apps/{appId}/tefs/{action}). [write]

Cria novo atributo (POST /api/v3/attributes). [write]

Duplica um atributo (POST /api/v3/attributes/{attributeId}/duplicate). [write]

Cria uma nova opção (POST /api/v3/attributes/{attributeId}/options). [write]

Atualiza imagem da opção (POST /api/v3/attributes/{attributeId}/options/{optionId}/image). [write]

Cria nova conta bancária (POST /api/v3/bank-accounts). [write]

Finaliza um lote (POST /api/v3/bulks/finish). [write]

Adiciona itens ao lote (POST /api/v3/bulks/items-add). [write]

Adiciona itens ao lote por filtro (POST /api/v3/bulks/items-add-by-filter). [write]

Remove itens do lote (POST /api/v3/bulks/items-remove). [write]

Criar um novo contrato de cartão (POST /api/v3/cards/contracts). [write]

Cria uma nova transportadora (POST /api/v3/carriers). [write]

Cria nova categoria (POST /api/v3/categories). [write]

Cria nova série de comanda (POST /api/v3/command-series). [write]

Cria uma nova empresa (POST /api/v3/companies). [write]

Obtém token de API (POST /api/v3/companies/{companyId}/get-api-token). [write]

Enviar logotipo da empresa (POST /api/v3/companies/{companyId}/image). [write]

Revoga licença (POST /api/v3/companies/{companyId}/revoke-api-token). [write]

Upload de certificado (POST /api/v3/companies/{companyId}/upload-certificate). [write]

Cria um centro de custo (POST /api/v3/cost-centers). [write]

Cria uma nova categoria de cliente (POST /api/v3/customer-categories). [write]

Cria um novo cliente (POST /api/v3/customers). [write]

Cria ou atualiza endereços (POST /api/v3/customers/{customerId}/addresses). [write]

Salva lista de documentos (POST /api/v3/customers/{customerId}/documents). [write]

Adiciona uma mídia em uma customização (POST /api/v3/customizations/{customizationId}/media). [write]

Cria uma nova customização (POST /api/v3/customizations). [write]

Cria uma área de entrega (POST /api/v3/delivery-areas). [write]

Cria um filtro (POST /api/v3/filters). [write]

Cria um plano de contas (POST /api/v3/financial/account-plans). [write]

Cria um grupo financeiro (POST /api/v3/financial/groups). [write]

Cria uma transação financeira (POST /api/v3/financial/transactions). [write]

Adiciona um anexo (POST /api/v3/financial/transactions/{transactionId}/files). [write]

Restaura uma integração (POST /api/v3/integrations/{integrationId}/restore). [write]

Exportar produtos da integração Tray (POST /api/v3/integrations/tray/export-products). [write]

Importar produtos da integração Tray (POST /api/v3/integrations/tray/import-products). [write]

Cria um novo KDS (POST /api/v3/kds). [write]

Cria uma nova etiqueta (POST /api/v3/labels). [write]

Gera PDF de etiquetas (POST /api/v3/labels/download). [write]

Prepara etiquetas para impressão (POST /api/v3/labels/print). [write]

Login legado (POST /api/v3/legacy/login). [write]

Envia NFe emitidas por e-mail (POST /api/v3/nfes/emitted-documents/send-email). [write]

Realiza a manifestação de um documento fiscal eletrônico recebido (POST /api/v3/nfes/received-documents/manifest). [write]

Cria novo método de pagamento (POST /api/v3/payments). [write]

Associa um produto a um periférico (POST /api/v3/peripherals/{peripheralId}/products/{productId}). [write]

Cria um novo periférico (POST /api/v3/peripherals). [write]

Cria uma nova lista de preço (POST /api/v3/price-lists). [write]

Duplica uma lista de preços (POST /api/v3/price-lists/{priceListId}/duplicate). [write]

Cria ou atualiza uma grade de preço de um produto (POST /api/v3/price-lists/{priceListId}/items/{productId}/grids). [write]

Cria ou atualiza uma opção de um produto (POST /api/v3/price-lists/{priceListId}/items/{productId}/options). [write]

Apaga produtos em massa (POST /api/v3/price-lists/{priceListId}/items). [write]

Atualiza a ordem das listas de preços (POST /api/v3/price-lists/update-order). [write]

Cria novo produto (POST /api/v3/products). [write]

Atualiza imagem de uma grade de preço (POST /api/v3/products/{productId}/grids/{gridId}/image). [write]

Duplica um produto (POST /api/v3/products/{productId}/duplicate). [write]

Restaura um produto (POST /api/v3/products/{productId}/restore). [write]

Atualiza imagem do produto (POST /api/v3/products/{productId}/image). [write]

Adiciona fornecedor (POST /api/v3/products/{productId}/suppliers). [write]

Cria um novo perfil (POST /api/v3/profiles). [write]

Cria uma nova promoção (POST /api/v3/promotions). [write]

Cria uma nova compra (POST /api/v3/purchases). [write]

Adiciona anexo a uma compra (POST /api/v3/purchases/{purchaseId}/files). [write]

Upload de XML (POST /api/v3/purchase-invoices). [write]

Marca todos os itens da compra como entregues (POST /api/v3/purchases/{purchaseId}/mark-all-items-delivered). [write]

Envia email de uma compra (POST /api/v3/purchases/{purchaseId}/send-email). [write]

Upload de um arquivo de conciliação bancária (POST /api/v3/reconciliations/import). [write]

Concilia uma transação bancária (POST /api/v3/reconciliations/{reconciliationId}/transactions/reconcile). [write]

Restaura uma transação bancária (POST /api/v3/reconciliations/{reconciliationId}/transactions/restore). [write]

Desconcilia uma transação bancária (POST /api/v3/reconciliations/{reconciliationId}/transactions/unreconcile). [write]

Registra uma nova movimentação (POST /api/v3/stocks/{stockId}/movements). [write]

Restaura uma transportadora (POST /api/v3/carriers/{carrierId}/restore). [write]

Restaura um fornecedor (POST /api/v3/suppliers/{supplierId}/restore). [write]

Cria uma nova venda (POST /api/v3/sales). [write]

Cria um novo pedido de venda (POST /api/v3/sale-orders). [write]

Converte um pedido de venda em uma venda (POST /api/v3/sale-orders/convert-to-sale). [write]

Envia o recibo de pedido de venda por e-mail (POST /api/v3/sale-orders/{saleOrderId}/send-receipt-by-email). [write]

Envia o recibo de venda por e-mail (POST /api/v3/sales/{saleId}/send-receipt-by-email). [write]

Cria um bairro customizado (POST /api/v3/settings/districts). [write]

Cria novo canal de venda (POST /api/v3/sources). [write]

Cria nova observação padrão (POST /api/v3/standard-observations). [write]

Cria nova categoria de movimentação de estoque (POST /api/v3/stocks/movements/categories). [write]

Cria uma nova transferência entre estoques (POST /api/v3/stock-transfers). [write]

Cria novo estoque (POST /api/v3/stocks). [write]

Cria novo inventário (POST /api/v3/stocks/{stockId}/inventories). [write]

Finaliza um inventário (POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/finalize). [write]

Importação de uma planilha de inventário (POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/import). [write]

Upload de uma planilha de inventário (POST /api/v3/stocks/{stockId}/inventories/{inventoryId}/upload). [write]

Apaga a conta do cliente na loja (POST /api/v1/store/accounts/delete). [write]

Cria uma nova conta do cliente na loja (POST /api/v1/store/signup). [write]

Solicita Access Token (POST /api/v1/store/oauth/token). [write]

Solicitação de recuperação de senha (POST /api/v1/store/accounts/password-reset). [write]

Alteração da senha da conta (POST /api/v1/store/accounts/password-reset/reset). [write]

Social Signin (POST /api/v1/store/auth/{socialType}/callback). [write]

Cria novo termo legal (POST /api/v3/legal-terms). [write]

Cria/Atualiza os endereços de um cliente da Loja (PUT /api/v1/store/accounts/addresses). [write]

Cria um novo pedido de venda para um cliente de uma loja (POST /api/v1/store/orders). [write]

Cria um novo fornecedor (POST /api/v3/suppliers). [write]

Restaura uma mesa excluída (POST /api/v3/tables/{tableId}/restore). [write]

Cria uma nova mesa (POST /api/v3/tables). [write]

Cria novas mesas em massa (POST /api/v3/tables/batch). [write]

Cria uma informação adicional da NF-e (POST /api/v3/tax-settings/nfe-additional-infos). [write]

Cria um grupo de ICMS (POST /api/v3/tax-settings/icms). [write]

Define um grupo de ICMS como padrão (PUT /api/v3/tax-settings/icms/{id}/set-default). [write]

Cria uma série de nota fiscal (POST /api/v3/tax-settings/invoice-series). [write]

Cria um grupo de IPI (POST /api/v3/tax-settings/ipi). [write]

Define um grupo de IPI como padrão (PUT /api/v3/tax-settings/ipi/{id}/set-default). [write]

Cria um grupo de ISSQN (POST /api/v3/tax-settings/issqns). [write]

Cria uma natureza de operação (POST /api/v3/tax-settings/nature-operations). [write]

Cria um grupo de PIS/COFINS (POST /api/v3/tax-settings/pis-cofins). [write]

Define um grupo de PIS/COFINS como padrão (PUT /api/v3/tax-settings/pis-cofins/{id}/set-default). [write]

Cria nova unidade de medida (POST /api/v3/units). [write]

Cria um novo usuário (POST /api/v3/users). [write]

Cria ou atualiza produtos (PUT /api/v3/apps/{appId}/items). [write]

Cria ou atualiza categorias de produto (PUT /api/v3/apps/{appId}/categories). [write]

Atualiza um aplicativo (PUT /api/v3/apps/{appId}). [write]

Restaurar um aplicativo (PUT /api/v3/apps/{appId}/restore). [write]

Cria ou atualiza as grades de preço de um produto (PUT /api/v3/apps/{appId}/items/{productId}/grids). [write]

Cria ou atualiza as opções do produto (PUT /api/v3/apps/{appId}/items/{productId}/options). [write]

Confirmar sincronização de aplicativos (PUT /api/v3/apps/syncs/{notificationId}/confirm). [write]

Atualiza um atributo (PUT /api/v3/attributes/{attributeId}). [write]

Atualiza uma opção (PUT /api/v3/attributes/{attributeId}/options/{optionId}). [write]

Atualiza uma conta bancária (PUT /api/v3/bank-accounts/{bankAccountId}). [write]

Atualiza um contrato de cartão (PUT /api/v3/cards/contracts/{cardContractId}). [write]

Atualiza uma transportadora (PUT /api/v3/carriers/{carrierId}). [write]

Atualiza uma categoria (PUT /api/v3/categories/{categoryId}). [write]

Atualiza uma série de comanda (PUT /api/v3/command-series/{commandSeriesId}). [write]

Atualiza uma empresa (PUT /api/v3/companies/{companyId}). [write]

Atualiza dados de cobrança da empresa (PUT /api/v3/companies/{companyId}/billing). [write]

Atualiza definições de uso da empresa (PUT /api/v3/companies/{companyId}/use-definitions). [write]

Atualiza um centro de custo (PUT /api/v3/cost-centers/{costCenterId}). [write]

Atualiza uma categoria de cliente (PUT /api/v3/customer-categories/{customerCategoryId}). [write]

Atualiza um cliente (PUT /api/v3/customers/{customerId}). [write]

Atualiza uma customização (PUT /api/v3/customizations/{customizationId}). [write]

Atualiza uma área de entrega (PUT /api/v3/delivery-areas/{deliveryAreaId}). [write]

Atualiza um filtro (PUT /api/v3/filters/{filterId}). [write]

Atualiza um plano de contas (PUT /api/v3/financial/account-plans/{accountPlanId}). [write]

Atualiza um grupo financeiro (PUT /api/v3/financial/groups/{groupId}). [write]

Atualiza uma transação financeira (PUT /api/v3/financial/transactions/{transactionId}). [write]

Atualiza uma integração (PUT /api/v3/integrations/{integrationId}). [write]

Conciliar produtos da integração Tray (PUT /api/v3/integrations/tray/products/{productId}/conciliation). [write]

Atualiza um KDS (PUT /api/v3/kds/{kdsId}). [write]

Atualiza uma etiqueta (PUT /api/v3/labels/{labelId}). [write]

Atualiza as configurações do painel de senha (PUT /api/v3/settings/password-panel). [write]

Atualiza método de pagamento (PUT /api/v3/payments/{paymentId}). [write]

Atualiza um periférico (PUT /api/v3/peripherals/{peripheralId}). [write]

Atualiza uma lista de preço (PUT /api/v3/price-lists/{priceListId}). [write]

Atualiza os preços dos produtos em massa (PUT /api/v3/price-lists/{priceListId}/items/update-prices). [write]

Cria ou atualiza aplicativos (PUT /api/v3/products/{productId}/apps). [write]

Atualiza um aplicativo (PUT /api/v3/products/{productId}/apps/{appId}). [write]

Atualiza as configurações de fichas de consumo de produtos (PUT /api/v3/products/consumption-coupons). [write]

Cria ou atualiza as grades de preços (PUT /api/v3/products/{productId}/grids). [write]

Cria ou atualiza informações tributárias (PUT /api/v3/products/{productId}/tax-settings). [write]

Atualiza um produto (PUT /api/v3/products/{productId}). [write]

Atualiza os atributos (PUT /api/v3/products/{productId}/attributes). [write]

Atualiza fornecedor (PUT /api/v3/products/{productId}/suppliers/{productSupplierId}). [write]

Atualiza um perfil (PUT /api/v3/profiles/{profileId}). [write]

Sincroniza os limites de desconto dos perfis (PUT /api/v3/profiles/discount-limits/sync). [write]

Atualiza uma promoção (PUT /api/v3/promotions/{promotionId}). [write]

Atualiza uma compra (PUT /api/v3/purchases/{purchaseId}). [write]

Finalizar importação (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/import). [write]

Reverte alterações de itens (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/rollback-items). [write]

Atualiza o preço de venda em massa (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/update-all-unitary-sale-price). [write]

Sincroniza itens com produtos do fornecedor (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/update-linked-items). [write]

Pré-processa os itens da nota (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/prepare-items). [write]

Reverte uma alteração de um item (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}/revert). [write]

Salva os itens em massa (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items). [write]

Salva um item do XML (PUT /api/v3/purchase-invoices/{purchaseInvoiceId}/items/{purchaseInvoiceItemId}). [write]

Atualiza um pedido de venda (PUT /api/v3/sale-orders/{saleOrderId}). [write]

Atualiza um status de pedido de venda (PUT /api/v3/sale-orders/{saleOrderId}/status). [write]

Atualiza um bairro customizado (PUT /api/v3/settings/districts/{id}). [write]

Atualiza as configurações do terminal (PATCH /api/v3/settings/terminal). [write]

Atualiza canal de venda (PUT /api/v3/sources/{sourceId}). [write]

Atualiza uma observação padrão (PUT /api/v3/standard-observations/{standardObservationId}). [write]

Sincroniza detalhes dos status (PUT /api/v3/status/sync-details). [write]

Atualiza uma categoria de movimentação de estoque (PUT /api/v3/stocks/movements/categories/{stockMovementCategoryId}). [write]

Atualiza um estoque (PUT /api/v3/stocks/{stockId}). [write]

Atualiza um inventário (PUT /api/v3/stocks/{stockId}/inventories/{inventoryId}). [write]

Cria, atualiza e remove itens de um inventário (PUT /api/v3/stocks/{stockId}/inventories/{inventoryId}/items). [write]

Atualiza os dados da conta do cliente logado (PUT /api/v1/store/accounts). [write]

Aceita os termos legais (PUT /api/v1/store/accounts/legal-terms). [write]

Atualiza um endereço do cliente na loja (PUT /api/v1/store/accounts/addresses/{addressId}). [write]

Atualiza um fornecedor (PUT /api/v3/suppliers/{supplierId}). [write]

Atualiza uma mesa (PUT /api/v3/tables/{tableId}). [write]

Atualiza uma informação adicional da NF-e (PUT /api/v3/tax-settings/nfe-additional-infos/{id}). [write]

Atualiza as configurações fiscais padrão (PUT /api/v3/tax-settings/defaults). [write]

Atualiza um grupo de ICMS (PUT /api/v3/tax-settings/icms/{id}). [write]

Atualiza uma série de nota fiscal (PUT /api/v3/tax-settings/invoice-series/{id}). [write]

Atualiza um grupo de IPI (PUT /api/v3/tax-settings/ipi/{id}). [write]

Atualiza um grupo de ISSQN (PUT /api/v3/tax-settings/issqns/{id}). [write]

Define um grupo de ISSQN como padrão (PUT /api/v3/tax-settings/issqns/{id}/set-default). [write]

Atualiza uma natureza de operação (PUT /api/v3/tax-settings/nature-operations/{id}). [write]

Atualiza um grupo de PIS/COFINS (PUT /api/v3/tax-settings/pis-cofins/{id}). [write]

Atualiza o tipo de nota emitida pelo PDV (PUT /api/v3/tax-settings/type-invoice-pdv). [write]

Atualiza as configurações do Totem (PUT /api/v3/settings/totem). [write]

Atualiza uma unidade de medida (PUT /api/v3/units/{unitId}). [write]

Atualiza um usuário (PUT /api/v3/users/{userId}). [write]

Atualiza o usuário autenticado (PUT /api/v3/users/me). [write]

Reordena as categorias (PUT /api/v3/categories/reorder). [write]

Apaga movimentações de um estoque (DELETE /api/v3/stocks/{stockId}/reset). [write]

Restaura um usuário (POST /api/v3/users/{userId}). [write]

Revogar uma sessão de acesso (PUT /api/v3/users/sessions/{accessTokenId}). [write]

Apaga todas as movimentações de um produto (DELETE /api/v3/stocks/{stockId}/products/{productId}/reset). [write]

Sincroniza horários de funcionamento (PUT /api/v3/opening-hours). [write]

Ranking dos produtos e categorias mais vendidos no período: top_produtos, top_categorias e top_por_categoria (mais vendido dentro de cada categoria). Responde 'prato mais vendido da casa', 'categoria

Atualizar caixa registradora (PUT /api/v3/cash-registers/{cashRegisterId}). [write]

Atualiza um ícone (PUT /api/v3/icons/{iconId}). [write]

Atualiza uma ordem de produção (PUT /api/v3/production-orders/{productionOrderId}). [write]

Cria ou atualiza composições (PUT /api/v3/products/{productId}/compositions). [write]