### Get Accounting Closing Summary Source: https://developer.omie.com.br/service-list Retrieves a summary of the accounting closing process. ```APIDOC ## GET /v1/accounting-closing/summary ### Description Provides a summary of the accounting closing process. ### Method GET ### Endpoint /v1/accounting-closing/summary ### Parameters #### Query Parameters - **period** (string) - Optional - Filters the summary for a specific accounting period (e.g., '2023-10'). ### Request Example None ### Response #### Success Response (200) - **summary** (object) - An object containing the accounting closing summary. - **totalRevenue** (number) - The total revenue for the period. - **totalExpenses** (number) - The total expenses for the period. - **netProfit** (number) - The net profit for the period. - **closingDate** (string) - The date the closing was completed. #### Response Example ```json { "summary": { "totalRevenue": 150000.50, "totalExpenses": 80000.75, "netProfit": 69999.75, "closingDate": "2023-10-26" } } ``` ``` -------------------------------- ### Consulta Estoque Consolidado Source: https://developer.omie.com.br/service-list Retrieves the consolidated stock of a product. ```APIDOC ## GET /v1/estoque/consolidado ### Description Retrieves the consolidated stock of a product. ### Method GET ### Endpoint /v1/estoque/consolidado ### Parameters #### Query Parameters - **produto_id** (integer) - Required - The ID of the product. ### Response #### Success Response (200) - **produto_id** (integer) - The ID of the product. - **saldo_atual** (number) - The current stock balance. - **localizacao** (string) - The stock location. #### Response Example ```json { "produto_id": 50, "saldo_atual": 150.75, "localizacao": "Warehouse A" } ``` ``` -------------------------------- ### List Usage Types Source: https://developer.omie.com.br/service-list Retrieves a list of all usage types for services. ```APIDOC ## GET /v1/usage-types ### Description Lists the different types of service utilization. ### Method GET ### Endpoint /v1/usage-types ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **usageTypes** (array) - A list of usage type objects. - **id** (integer) - The unique identifier for the usage type. - **name** (string) - The name of the usage type. #### Response Example ```json { "usageTypes": [ { "id": 101, "name": "Type A" }, { "id": 102, "name": "Type B" } ] } ``` ``` -------------------------------- ### List Billing Stages Source: https://developer.omie.com.br/service-list Retrieves a list of all billing stages available in the system. ```APIDOC ## GET /v1/billing-stages ### Description Lists the available billing stages for financial processing. ### Method GET ### Endpoint /v1/billing-stages ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **stages** (array) - A list of billing stage objects. - **id** (integer) - The unique identifier for the billing stage. - **name** (string) - The name of the billing stage. #### Response Example ```json { "stages": [ { "id": 1, "name": "Stage One" }, { "id": 2, "name": "Stage Two" } ] } ``` ``` -------------------------------- ### Lista Formas de Pagamento de Compra Source: https://developer.omie.com.br/service-list Lists the payment methods for a purchase. ```APIDOC ## GET /v1/compras/formas-pagamento ### Description Lists the payment methods for a purchase. ### Method GET ### Endpoint /v1/compras/formas-pagamento ### Response #### Success Response (200) - **formas_pagamento** (array) - A list of payment methods. - **codigo** (integer) - The code of the payment method. - **descricao** (string) - The description of the payment method. #### Response Example ```json { "formas_pagamento": [ { "codigo": 1, "descricao": "Boleto Bancário" }, { "codigo": 2, "descricao": "Cartão de Crédito" } ] } ``` ``` -------------------------------- ### Lista Relação Produto x Fornecedor Source: https://developer.omie.com.br/service-list Lists the relationship between products and suppliers. ```APIDOC ## GET /v1/cadastro/produto-fornecedor ### Description Lists the relationship between products and suppliers. ### Method GET ### Endpoint /v1/cadastro/produto-fornecedor ### Parameters #### Query Parameters - **produto_id** (integer) - Optional - Filter by product ID. - **fornecedor_id** (integer) - Optional - Filter by supplier ID. ### Response #### Success Response (200) - **relacionamentos** (array) - A list of product-supplier relationships. - **produto_id** (integer) - The ID of the product. - **produto_nome** (string) - The name of the product. - **fornecedor_id** (integer) - The ID of the supplier. - **fornecedor_nome** (string) - The name of the supplier. #### Response Example ```json { "relacionamentos": [ { "produto_id": 50, "produto_nome": "Laptop", "fornecedor_id": 201, "fornecedor_nome": "Tech Supplies Inc." } ] } ``` ``` -------------------------------- ### Lista Cenários de Impostos Source: https://developer.omie.com.br/service-list Lists the available tax scenarios. ```APIDOC ## GET /v1/cadastro/cenario-impostos ### Description Lists the available tax scenarios. ### Method GET ### Endpoint /v1/cadastro/cenario-impostos ### Response #### Success Response (200) - **cenarios** (array) - A list of tax scenarios. - **codigo** (integer) - The code of the tax scenario. - **descricao** (string) - The description of the tax scenario. #### Response Example ```json { "cenarios": [ { "codigo": 1, "descricao": "Simples Nacional" }, { "codigo": 2, "descricao": "Lucro Presumido" } ] } ``` ``` -------------------------------- ### Resumo do Estoque de um Produto Source: https://developer.omie.com.br/service-list Provides a summary of the stock for a specific product. ```APIDOC ## GET /v1/estoque/resumo ### Description Provides a summary of the stock for a specific product. ### Method GET ### Endpoint /v1/estoque/resumo ### Parameters #### Query Parameters - **produto_id** (integer) - Required - The ID of the product. ### Response #### Success Response (200) - **produto_id** (integer) - The ID of the product. - **nome_produto** (string) - The name of the product. - **estoque_total** (number) - The total stock quantity. - **estoque_reservado** (number) - The reserved stock quantity. - **estoque_disponivel** (number) - The available stock quantity. #### Response Example ```json { "produto_id": 50, "nome_produto": "Laptop", "estoque_total": 150.75, "estoque_reservado": 10.0, "estoque_disponivel": 140.75 } ``` ``` -------------------------------- ### Gerenciamento de Famílias de Produto Source: https://developer.omie.com.br/service-list Creates, edits, and consults product families. ```APIDOC ## POST /v1/produtos/familias ### Description Creates a new product family. ### Method POST ### Endpoint /v1/produtos/familias ### Parameters #### Request Body - **nome** (string) - Required - The name of the product family. - **descricao** (string) - Optional - A description for the product family. ### Response #### Success Response (200) - **id** (integer) - The ID of the newly created product family. - **message** (string) - Confirmation message. #### Response Example ```json { "id": 101, "message": "Product family created successfully." } ``` ## PUT /v1/produtos/familias/{id} ### Description Edits an existing product family. ### Method PUT ### Endpoint /v1/produtos/familias/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the product family to edit. #### Request Body - **nome** (string) - Optional - The new name for the product family. - **descricao** (string) - Optional - The new description for the product family. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Product family updated successfully." } ``` ## GET /v1/produtos/familias/{id} ### Description Consults a specific product family. ### Method GET ### Endpoint /v1/produtos/familias/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the product family to consult. ### Response #### Success Response (200) - **id** (integer) - The ID of the product family. - **nome** (string) - The name of the product family. - **descricao** (string) - The description of the product family. #### Response Example ```json { "id": 101, "nome": "Eletrônicos", "descricao": "Produtos da categoria eletrônicos." } ``` ## GET /v1/produtos/familias ### Description Lists all product families. ### Method GET ### Endpoint /v1/produtos/familias ### Response #### Success Response (200) - **familias** (array) - A list of product families. - **id** (integer) - The ID of the product family. - **nome** (string) - The name of the product family. #### Response Example ```json { "familias": [ { "id": 101, "nome": "Eletrônicos" }, { "id": 102, "nome": "Roupas" } ] } ``` ``` -------------------------------- ### Consulta Etapas de Pedido Source: https://developer.omie.com.br/service-list Retrieves the stages or steps of a sales order. ```APIDOC ## GET /v1/vendas/pedidos/etapas ### Description Retrieves the stages or steps of a sales order. ### Method GET ### Endpoint /v1/vendas/pedidos/etapas ### Parameters #### Query Parameters - **pedido_id** (integer) - Optional - Filter by sales order ID. ### Response #### Success Response (200) - **etapas** (array) - A list of order stages. - **id** (integer) - The ID of the stage. - **descricao** (string) - The description of the stage. - **data_conclusao** (string) - The completion date (YYYY-MM-DD HH:MM:SS) or null if not completed. #### Response Example ```json { "etapas": [ { "id": 1, "descricao": "Pedido Recebido", "data_conclusao": "2023-10-26 09:00:00" }, { "id": 2, "descricao": "Em Separação", "data_conclusao": null } ] } ``` ``` -------------------------------- ### Resumo de Compras Source: https://developer.omie.com.br/service-list Provides a summary of purchases. ```APIDOC ## GET /v1/compras/resumo ### Description Provides a summary of purchases. ### Method GET ### Endpoint /v1/compras/resumo ### Parameters #### Query Parameters - **periodo** (string) - Optional - The period for the summary (e.g., 'month', 'year'). ### Response #### Success Response (200) - **total_compras** (number) - The total value of purchases. - **quantidade_compras** (integer) - The total number of purchases. #### Response Example ```json { "total_compras": 15000.50, "quantidade_compras": 120 } ``` ``` -------------------------------- ### Gerenciamento de Ajustes de Estoque Source: https://developer.omie.com.br/service-list Creates and deletes inventory stock movements. ```APIDOC ## POST /v1/estoque/ajustes ### Description Creates an inventory stock movement. ### Method POST ### Endpoint /v1/estoque/ajustes ### Parameters #### Request Body - **produto_id** (integer) - Required - The ID of the product. - **quantidade** (number) - Required - The quantity to adjust (positive for addition, negative for subtraction). - **motivo** (string) - Required - The reason for the stock adjustment. ### Response #### Success Response (200) - **id_movimentacao** (integer) - The ID of the stock movement. - **message** (string) - Confirmation message. #### Response Example ```json { "id_movimentacao": 5001, "message": "Stock adjustment created successfully." } ``` ## DELETE /v1/estoque/ajustes/{id_movimentacao} ### Description Deletes an inventory stock movement. ### Method DELETE ### Endpoint /v1/estoque/ajustes/{id_movimentacao} ### Parameters #### Path Parameters - **id_movimentacao** (integer) - Required - The ID of the stock movement to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Stock adjustment deleted successfully." } ``` ``` -------------------------------- ### Consulta Compradores Cadastrados Source: https://developer.omie.com.br/service-list Retrieves a list of registered buyers. ```APIDOC ## GET /v1/cadastro/compradores ### Description Retrieves a list of registered buyers. ### Method GET ### Endpoint /v1/cadastro/compradores ### Response #### Success Response (200) - **compradores** (array) - A list of buyers. - **codigo** (integer) - The code of the buyer. - **nome** (string) - The name of the buyer. #### Response Example ```json { "compradores": [ { "codigo": 1, "nome": "João Silva" }, { "codigo": 2, "nome": "Maria Oliveira" } ] } ``` ``` -------------------------------- ### Adiciona Pedidos e Itens de Venda Source: https://developer.omie.com.br/service-list Adds sales orders and their corresponding items. ```APIDOC ## POST /v1/vendas/pedidos/resumido ### Description Adds sales orders and their corresponding items. ### Method POST ### Endpoint /v1/vendas/pedidos/resumido ### Parameters #### Request Body - **pedido** (object) - Required - The sales order details. - **cliente_id** (integer) - Required - The ID of the customer. - **data_pedido** (string) - Optional - The date of the order (YYYY-MM-DD). - **itens** (array) - Required - A list of order items. - **produto_id** (integer) - Required - The ID of the product. - **quantidade** (number) - Required - The quantity of the product. - **preco_unitario** (number) - Required - The unit price. ### Response #### Success Response (200) - **id_pedido** (integer) - The ID of the created sales order. - **message** (string) - Confirmation message. #### Response Example ```json { "id_pedido": 1001, "message": "Sales order added successfully." } ``` ``` -------------------------------- ### Cria/Edita Remessa de Produto Source: https://developer.omie.com.br/service-list Creates or edits a product shipment invoice. ```APIDOC ## POST /v1/nf-e/remessa ### Description Creates a new product shipment invoice. ### Method POST ### Endpoint /v1/nf-e/remessa ### Parameters #### Request Body - **dados_remessa** (object) - Required - Data for the shipment invoice. - **cliente_id** (integer) - Required - Customer ID. - **data_emissao** (string) - Required - Emission date (YYYY-MM-DD). - **itens** (array) - Required - List of items. - **produto_id** (integer) - Required - Product ID. - **quantidade** (number) - Required - Quantity. ### Response #### Success Response (200) - **id_nf_remessa** (integer) - The ID of the created ``` -------------------------------- ### Listagem de Locais de Estoque Source: https://developer.omie.com.br/service-list Retrieves a list of available stock locations. ```APIDOC ## GET /v1/estoque/locais ### Description Retrieves a list of available stock locations. ### Method GET ### Endpoint /v1/estoque/locais ### Response #### Success Response (200) - **locais** (array) - A list of stock locations. - **id** (integer) - The ID of the location. - **nome** (string) - The name of the location. #### Response Example ```json { "locais": [ { "id": 1, "nome": "Armazém Principal" }, { "id": 2, "nome": "Loja Filial" } ] } ``` ``` -------------------------------- ### Consulta Unidades de Medida Source: https://developer.omie.com.br/service-list Retrieves a list of available units of measure. ```APIDOC ## GET /v1/cadastro/unidades ### Description Retrieves a list of available units of measure. ### Method GET ### Endpoint /v1/cadastro/unidades ### Response #### Success Response (200) - **unidades** (array) - A list of units of measure. - **codigo** (string) - The code for the unit of measure. - **descricao** (string) - The description of the unit of measure. #### Response Example ```json { "unidades": [ { "codigo": "UN", "descricao": "Unidade" }, { "codigo": "KG", "descricao": "Quilograma" } ] } ``` ``` -------------------------------- ### Gerenciamento de Pedidos e Orçamentos Source: https://developer.omie.com.br/service-list Creates, edits, and consults sales orders and quotes. ```APIDOC ## POST /v1/vendas/pedidos ### Description Creates a new sales order or quote. ### Method POST ### Endpoint /v1/vendas/pedidos ### Parameters #### Request Body - **tipo** (string) - Required - Type of document ('pedido' or 'orcamento'). - **cliente_id** (integer) - Required - The ID of the customer. - **data_emissao** (string) - Required - Emission date (YYYY-MM-DD). - **itens** (array) - Required - List of items. - **produto_id** (integer) - Required - Product ID. - **quantidade** (number) - Required - Quantity. - **valor_unitario** (number) - Required - Unit value. ### Response #### Success Response (200) - **id** (integer) - ID of the created order/quote. - **message** (string) - Confirmation message. #### Response Example ```json { "id": 1002, "message": "Order created successfully." } ``` ## PUT /v1/vendas/pedidos/{id} ### Description Edits an existing sales order or quote. ### Method PUT ### Endpoint /v1/vendas/pedidos/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - ID of the order/quote to edit. #### Request Body - **status** (string) - Optional - New status of the order/quote. - **itens** (array) - Optional - Updated list of items. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Order updated successfully." } ``` ## GET /v1/vendas/pedidos/{id} ### Description Consults a specific sales order or quote. ### Method GET ### Endpoint /v1/vendas/pedidos/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - ID of the order/quote to consult. ### Response #### Success Response (200) - **id** (integer) - ID of the order/quote. - **cliente_id** (integer) - Customer ID. - **data_emissao** (string) - Emission date. - **status** (string) - Current status. - **itens** (array) - List of items. #### Response Example ```json { "id": 1002, "cliente_id": 301, "data_emissao": "2023-10-26", "status": "Aberto", "itens": [ { "produto_id": 50, "quantidade": 2, "valor_unitario": 1200.00 } ] } ``` ``` -------------------------------- ### List Fiscal Documents Source: https://developer.omie.com.br/service-list Retrieves a list of fiscal documents, including NF-e, NFC-e, CF-e SAT, and NFS-e. ```APIDOC ## GET /v1/fiscal-documents ### Description Lists all fiscal documents such as NF-e, NFC-e, CF-e SAT, and NFS-e. ### Method GET ### Endpoint /v1/fiscal-documents ### Parameters #### Query Parameters - **type** (string) - Optional - Filters documents by type (e.g., 'NF-e', 'NFC-e', 'CF-e SAT', 'NFS-e'). - **startDate** (string) - Optional - Filters documents from a specific start date (YYYY-MM-DD). - **endDate** (string) - Optional - Filters documents up to a specific end date (YYYY-MM-DD). ### Request Example None ### Response #### Success Response (200) - **documents** (array) - A list of fiscal document objects. - **id** (string) - The unique identifier for the fiscal document. - **type** (string) - The type of fiscal document. - **issueDate** (string) - The date the document was issued. - **xmlContent** (string) - The XML content of the document. #### Response Example ```json { "documents": [ { "id": "doc-12345", "type": "NF-e", "issueDate": "2023-10-27", "xmlContent": "..." } ] } ``` ``` -------------------------------- ### List Service Classifications Source: https://developer.omie.com.br/service-list Retrieves a list of all service classifications. ```APIDOC ## GET /v1/service-classifications ### Description Lists the classifications applicable to services. ### Method GET ### Endpoint /v1/service-classifications ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **classifications** (array) - A list of service classification objects. - **id** (integer) - The unique identifier for the classification. - **name** (string) - The name of the service classification. #### Response Example ```json { "classifications": [ { "id": 201, "name": "Classification X" }, { "id": 202, "name": "Classification Y" } ] } ``` ``` -------------------------------- ### Operações de Faturamento de Pedido Source: https://developer.omie.com.br/service-list Handles billing operations for sales orders. ```APIDOC ## POST /v1/vendas/pedidos/faturamento ### Description Performs billing operations for a sales order. ### Method POST ### Endpoint /v1/vendas/pedidos/faturamento ### Parameters #### Request Body - **pedido_id** (integer) - Required - The ID of the sales order to be billed. - **data_faturamento** (string) - Optional - The billing date (YYYY-MM-DD). ### Response #### Success Response (200) - **nf_numero** (string) - The invoice number generated. - **message** (string) - Confirmation message. #### Response Example ```json { "nf_numero": "NF123456789", "message": "Order billed successfully." } ``` ``` -------------------------------- ### Lista Movimentos de Estoque Source: https://developer.omie.com.br/service-list Lists stock movements (entries/exits) within a specified period. ```APIDOC ## GET /v1/estoque/movimentos ### Description Lists stock movements (entries/exits) within a specified period. ### Method GET ### Endpoint /v1/estoque/movimentos ### Parameters #### Query Parameters - **produto_id** (integer) - Optional - Filter by product ID. - **data_inicio** (string) - Optional - Start date for the period (YYYY-MM-DD). - **data_fim** (string) - Optional - End date for the period (YYYY-MM-DD). ### Response #### Success Response (200) - **movimentos** (array) - A list of stock movements. - **id_movimentacao** (integer) - The ID of the movement. - **produto_id** (integer) - The ID of the product. - **tipo** (string) - Type of movement ('entrada' or 'saida'). - **quantidade** (number) - The quantity moved. - **data** (string) - The date of the movement (YYYY-MM-DD HH:MM:SS). - **motivo** (string) - The reason for the movement. #### Response Example ```json { "movimentos": [ { "id_movimentacao": 5001, "produto_id": 50, "tipo": "entrada", "quantidade": 10.0, "data": "2023-10-26 10:00:00", "motivo": "Recebimento de fornecedor" }, { "id_movimentacao": 5002, "produto_id": 50, "tipo": "saida", "quantidade": 5.0, "data": "2023-10-26 11:30:00", "motivo": "Venda ao cliente" } ] } ``` ``` -------------------------------- ### Adiciona/Cancela Conhecimento de Transporte Source: https://developer.omie.com.br/service-list Adds or cancels a transport document (CT-e or CT-e OS). ```APIDOC ## POST /v1/transportes/cte ### Description Adds a new transport document (CT-e or CT-e OS). ### Method POST ### Endpoint /v1/transportes/cte ### Parameters #### Request Body - **dados_cte** (object) - Required - The data for the transport document. - **remetente** (object) - Required - Sender information. - **destinatario** (object) - Required - Receiver information. - **carga** (object) - Required - Cargo details. - **valor_total_carga** (number) - Required - Total value of the cargo. ### Response #### Success Response (200) - **id_cte** (integer) - The ID of the created CT-e. - **numero_cte** (string) - The CT-e number. - **message** (string) - Confirmation message. #### Response Example ```json { "id_cte": 7001, "numero_cte": "CT123456789", "message": "Transport document added successfully." } ``` ## DELETE /v1/transportes/cte/{id_cte} ### Description Cancels an existing transport document. ### Method DELETE ### Endpoint /v1/transportes/cte/{id_cte} ### Parameters #### Path Parameters - **id_cte** (integer) - Required - The ID of the CT-e to cancel. #### Query Parameters - **motivo_cancelamento** (string) - Required - Reason for cancellation. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Transport document cancelled successfully." } ``` ``` -------------------------------- ### Lista/Consulta Códigos NCM Source: https://developer.omie.com.br/service-list Lists and allows consultation of NCM (Mercosul Common Nomenclature) codes. ```APIDOC ## GET /v1/cadastro/ncm ### Description Lists and allows consultation of NCM (Mercosul Common Nomenclature) codes. ### Method GET ### Endpoint /v1/cadastro/ncm ### Parameters #### Query Parameters - **codigo** (string) - Optional - Filter by NCM code. - **descricao** (string) - Optional - Filter by NCM description. ### Response #### Success Response (200) - **ncms** (array) - A list of NCM codes. - **codigo** (string) - The NCM code. - **descricao** (string) - The description of the NCM code. #### Response Example ```json { "ncms": [ { "codigo": "0101.10", "descricao": "Cavalos, asininos e muares, vivos" } ] } ``` ``` -------------------------------- ### Recebimento de Nota Fiscal Source: https://developer.omie.com.br/service-list Edits the receipt data of an e-invoice. ```APIDOC ## POST /v1/nf-e/recebimento ### Description Edits the receipt data of an e-invoice. ### Method POST ### Endpoint /v1/nf-e/recebimento ### Parameters #### Request Body - **data** (object) - Required - The receipt data to be edited. ### Request Example ```json { "data": { "campo1": "valor1", "campo2": "valor2" } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **message** (string) - A message describing the result of the operation. #### Response Example ```json { "status": "success", "message": "Receipt data updated successfully." } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.