{"openapi":"3.0.3","info":{"title":"automcp · Gateway de leitura","version":"v1","description":"Consultas HTTPS com respostas JSON. Use uma chave de consumidor emitida para uma empresa e para as áreas autorizadas. A empresa é determinada pelo gateway a partir da chave.\n\nEnvie os filtros na query e mantenha o corpo do pedido vazio. Indique apenas os parâmetros documentados e, quando presentes, um único valor por nome. Todos os caminhos publicados começam por `/api/v1/`. Os relatórios paginados, como `/api/v1/artigos`, devolvem `offset`, `limite` e `dados`. Nas restantes operações, consulte os parâmetros e o formato de resposta de cada GET.\n\nNum caminho desconhecido, uma chave válida recebe HTTP 404 (`recurso_desconhecido`). Um método diferente de GET num recurso conhecido devolve HTTP 405 (`metodo_nao_permitido`) com o cabeçalho `Allow: GET`."},"servers":[{"url":"https://automcp.cboxclub.com:8443","description":"Gateway de leitura"}],"tags":[{"name":"Artigos","description":"Catálogo, custos e preços de venda."},{"name":"Stocks","description":"Existências por armazém, movimentos e rotação física."},{"name":"Vendas","description":"Faturação, documentos de venda e margens."},{"name":"Compras","description":"Compras, documentos individuais e fornecedores."},{"name":"Clientes","description":"Fichas de clientes e respetivo histórico comercial."},{"name":"Financeiro","description":"Contas a receber e a pagar, pendentes e liquidações."},{"name":"Serviço","description":"Versão do gateway."}],"security":[{"ChaveDeLeitura":[]}],"paths":{"/api/v1/artigos":{"get":{"tags":["Artigos"],"operationId":"listarArtigos","summary":"Listar artigos","description":"Requer a área `artigos`. Devolve as fichas ordenadas por referência, com nome em português (PTG), unidades, moeda e custos. O filtro `artigo` permite procurar uma referência específica.","parameters":[{"$ref":"#/components/parameters/Artigo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Consulta concluída. Uma referência inexistente ou um deslocamento além do fim devolvem uma página com uma lista vazia em `dados`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginaArtigos"},"examples":{"artigo":{"summary":"Ficha de um artigo de demonstração","value":{"offset":0,"limite":50,"dados":[{"ItemID":"PILOTO-001","Description":"Artigo Beta","ShortDescription":"Piloto Beta","ItemType":0,"FamilyID":1,"BarCode":"000000002","Discontinued":false,"StockManagement":true,"UnitOfSaleID":"UN","DefaultStockUnit":"UN","DefaultSellingUnit":"UN","UnitConversion":1,"CurrencyID":"EUR","CurrencyFactor":1,"CurrencyExchange":1,"AverageCostPrice":21.9876,"AverageCostStockValue":439.752,"LastCostStockValue":439.752}]}},"paginaVazia":{"summary":"Pesquisa sem correspondências ou fim da paginação","value":{"offset":0,"limite":50,"dados":[]}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/precos":{"get":{"tags":["Artigos"],"operationId":"listarPrecos","summary":"Listar preços de venda","description":"Requer a área `artigos`. Uma linha por artigo, variante, unidade e linha de preço. UnitPrice e TaxIncludedPrice indicam o preço sem e com imposto.","parameters":[{"$ref":"#/components/parameters/Artigo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Preco"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/rotacao":{"get":{"tags":["Stocks"],"operationId":"consultarRotacao","summary":"Consultar a rotação de stock","description":"Requer a área `stocks`. Devolve uma linha por artigo, ordenada por referência. O intervalo inclui `inicio` e termina antes de `fimExclusivo`. Por exemplo, de `2026-09-01` a `2026-10-01` abrange todo o mês de setembro. Verifique `Estado` antes de utilizar as medidas para análise.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Artigo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Consulta concluída. Uma referência inexistente ou um deslocamento além do fim devolvem uma página com uma lista vazia em `dados`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginaRotacao"},"examples":{"conciliada":{"summary":"Setembro de 2026 com histórico conciliado","value":{"offset":0,"limite":50,"dados":[{"ItemID":"PILOTO-001","DefaultStockUnit":"UN","Estado":"ok","UnidadesSaidasVenda":20,"StockMedioUnidades":30,"RotacaoPeriodo":0.6666666666666666}]}},"semAbertura":{"summary":"Artigo sem saldo de abertura","value":{"offset":0,"limite":50,"dados":[{"ItemID":"PILOTO-SEM-HIST","DefaultStockUnit":"UN","Estado":"sem_saldo_anterior","UnidadesSaidasVenda":null,"StockMedioUnidades":null,"RotacaoPeriodo":null}]}},"paginaVazia":{"summary":"Pesquisa sem correspondências ou fim da paginação","value":{"offset":0,"limite":50,"dados":[]}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/stocks":{"get":{"tags":["Stocks"],"operationId":"listarStocks","summary":"Consultar stock por armazém","description":"Requer a área `stocks`. Quantidades físicas e disponíveis, encomendas, consignações e valores de custo por artigo, variante e armazém.","parameters":[{"$ref":"#/components/parameters/Artigo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Stock"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/movimentos-stock":{"get":{"tags":["Stocks"],"operationId":"listarMovimentosStock","summary":"Listar movimentos de stock","description":"Requer a área `stocks`. Movimentos no período da entrega efetiva (ActualDeliveryDate). Inclui o documento, unidades recebidas e saídas, saldo e custos.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Artigo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/MovimentoStock"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/vendas":{"get":{"tags":["Vendas"],"operationId":"listarVendas","summary":"Consultar faturação por mês","description":"Requer a área `vendas`. Documentos definitivos agrupados por mês de emissão, moeda, tipo e sinal. Os montantes somam os documentos com o sinal definido no mapa de vendas.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/VendaMensal"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/documentos-venda":{"get":{"tags":["Vendas"],"operationId":"listarDocumentosVenda","summary":"Listar documentos de venda","description":"Requer a área `vendas`. Uma linha por cabeçalho que entra no mapa de vendas. Inclui o estado e os valores originais de base, imposto e total. Use anulado e sinal_mapa ao comparar com a faturação agregada.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/DocumentoVenda"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/margens":{"get":{"tags":["Vendas"],"operationId":"consultarMargens","summary":"Consultar margens por artigo","description":"Requer a área `vendas`. Agrupa as linhas de venda por artigo, moeda e cobertura. O custo médio histórico e a margem em valor são calculados para a cobertura apurada. A percentagem exige também receita positiva.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Margem"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/compras":{"get":{"tags":["Compras"],"operationId":"listarCompras","summary":"Consultar compras por fornecedor e mês","description":"Requer a área `compras`. Totais de documentos definitivos por fornecedor, mês, moeda, tipo e sinal do mapa de compras.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/CompraMensal"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/documentos-compra":{"get":{"tags":["Compras"],"operationId":"listarDocumentosCompra","summary":"Listar documentos de compra","description":"Requer a área `compras`. Uma linha por cabeçalho que entra no mapa de compras, com estado e montantes originais de base, imposto e total.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/DocumentoCompra"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/fornecedores":{"get":{"tags":["Compras"],"operationId":"listarFornecedores","summary":"Listar fornecedores","description":"Requer a área `compras`. Ficha de cada fornecedor por ordem de identificador, com nome e indicadores de atividade e bloqueio.","parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Fornecedor"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/clientes":{"get":{"tags":["Clientes"],"operationId":"listarClientes","summary":"Listar clientes","description":"Requer a área `clientes`. Ficha comercial por CustomerID, com nome, estado, condições de pagamento, linha de preço e vendedor.","parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Cliente"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/historico-cliente":{"get":{"tags":["Clientes"],"operationId":"consultarHistoricoCliente","summary":"Consultar histórico de um cliente","description":"Requer a área `clientes`. Eventos do cliente por data de emissão, do mais recente para o mais antigo. TipoEvento distingue linhas de venda, vendas sem linha e documentos de conta-corrente. O total do documento repete-se quando há várias linhas.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Cliente"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/EventoCliente"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/financeiro-clientes":{"get":{"tags":["Financeiro"],"operationId":"consultarFinanceiroClientes","summary":"Consultar contas a receber","description":"Requer a área `financeiro`. Prestações de clientes emitidas no período, com vencimento, débitos, créditos e pendente atual. TotalLiquidacoes conta todos os vínculos e Liquidacoes inclui até 20, do mais recente para o mais antigo.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/LancamentoCliente"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/financeiro-fornecedores":{"get":{"tags":["Financeiro"],"operationId":"consultarFinanceiroFornecedores","summary":"Consultar contas a pagar","description":"Requer a área `financeiro`. Prestações de fornecedores emitidas no período, com vencimento, débitos, créditos e pendente atual. TotalLiquidacoes conta todos os vínculos e Liquidacoes inclui até 20, do mais recente para o mais antigo.","parameters":[{"$ref":"#/components/parameters/Inicio"},{"$ref":"#/components/parameters/FimExclusivo"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limite"}],"responses":{"200":{"description":"Página de resultados. A lista dados vem vazia quando não há registos nessa página.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Paginacao"},{"type":"object","required":["dados"],"properties":{"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/LancamentoFornecedor"}}}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"}}}},"/api/v1/carrier":{"get":{"tags":["Vendas"],"operationId":"referencia_carrier","summary":"Obter Transportes","description":"Áreas necessárias: vendas. Sem fonte SQL confirmada para ExtendedProperties.","parameters":[{"name":"CarrierID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CarrierID":{"type":"integer","format":"int64","nullable":true},"CarrierKey":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"DefaultSaleFreightCharge":{"type":"number","nullable":true},"SaleFreightChargeLimit":{"type":"number","nullable":true},"CurrencyID":{"type":"string","nullable":true},"CurrencyExchange":{"type":"number","nullable":true},"CurrencyFactor":{"type":"number","nullable":true},"TaxableGroupID":{"type":"integer","format":"int64","nullable":true},"ModeOfTransportID":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/colors":{"get":{"tags":["Artigos"],"operationId":"referencia_colors","summary":"Obter cores","description":"Áreas necessárias: artigos.","parameters":[{"name":"ColorID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ColorID":{"type":"integer","format":"int64","nullable":true},"ColorName":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/CountryCodes":{"get":{"tags":["Clientes"],"operationId":"referencia_countrycodes","summary":"Obter lista países","description":"Áreas necessárias: clientes.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CountryID":{"type":"string","nullable":true},"CountryKey":{"type":"string","nullable":true},"CountryName":{"type":"string","nullable":true},"EANUCCPrefix":{"type":"string","nullable":true},"FederalTaxIDFormat":{"type":"string","nullable":true},"FederalTaxScriptCode":{"type":"string","nullable":true},"ISOCountryID":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/DiscountDefinition":{"get":{"tags":["Vendas"],"operationId":"referencia_discountdefinition","summary":"Obter lista campanhas","description":"Áreas necessárias: vendas.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CanBeEvaluatedByOthers":{"type":"boolean","nullable":true},"ChangeSetID":{"type":"number","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"CriteriaType":{"type":"integer","format":"int64","nullable":true},"Cumulative":{"type":"boolean","nullable":true},"Description":{"type":"string","nullable":true},"Discount1":{"type":"number","nullable":true},"Discount2":{"type":"number","nullable":true},"Discount3":{"type":"number","nullable":true},"DiscountEligibleItem":{"type":"array","items":{},"nullable":true},"DiscountFlags":{"type":"integer","format":"int64","nullable":true},"DiscountID":{"type":"integer","format":"int64","nullable":true},"DiscountKey":{"type":"string","nullable":true},"DiscountPriceFlags":{"type":"integer","format":"int64","nullable":true},"DiscountScalingItem":{"type":"array","items":{},"nullable":true},"DiscountValue":{"type":"number","nullable":true},"DiscountWeekDays":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"EligibilityTypeFlag":{"type":"integer","format":"int64","nullable":true},"EndDate":{"type":"string","nullable":true},"EvaluationTime":{"type":"integer","format":"int64","nullable":true},"FamilyID":{"type":"integer","format":"int64","nullable":true},"GroupScaledItems":{"type":"boolean","nullable":true},"HasExpireDate":{"type":"boolean","nullable":true},"HrAlt":{"type":"number","nullable":true},"Inactive":{"type":"boolean","nullable":true},"ItemID":{"type":"string","nullable":true},"ItemOfferType":{"type":"integer","format":"int64","nullable":true},"OfferQuantityMustExist":{"type":"boolean","nullable":true},"OfferTypeFlags":{"type":"integer","format":"int64","nullable":true},"PriceChargePercentage":{"type":"number","nullable":true},"PriceChargeValue":{"type":"number","nullable":true},"PriceFlags":{"type":"integer","format":"int64","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"PriceUnitID":{"type":"string","nullable":true},"ScalingMode":{"type":"integer","format":"int64","nullable":true},"ScalingType":{"type":"integer","format":"int64","nullable":true},"SessionIDSessionID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"StartDate":{"type":"string","nullable":true},"TaxIncludedPrice":{"type":"number","nullable":true},"TimeIntervals":{"type":"string","nullable":true},"UID":{"type":"string","nullable":true},"UnitPrice":{"type":"number","nullable":true},"UseTaxIncludedValues":{"type":"boolean","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"VoucherGiftValue":{"type":"number","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true},"WorkstationList":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/DiscountDefinition/{DiscountID}":{"get":{"tags":["Vendas"],"operationId":"referencia_discountdefinition_1","summary":"Obter campanha","description":"Áreas necessárias: vendas.","parameters":[{"name":"DiscountID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CanBeEvaluatedByOthers":{"type":"boolean","nullable":true},"ChangeSetID":{"type":"number","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"CriteriaType":{"type":"integer","format":"int64","nullable":true},"Cumulative":{"type":"boolean","nullable":true},"Description":{"type":"string","nullable":true},"Discount1":{"type":"number","nullable":true},"Discount2":{"type":"number","nullable":true},"Discount3":{"type":"number","nullable":true},"DiscountEligibleItem":{"type":"array","items":{},"nullable":true},"DiscountFlags":{"type":"integer","format":"int64","nullable":true},"DiscountID":{"type":"integer","format":"int64","nullable":true},"DiscountKey":{"type":"string","nullable":true},"DiscountPriceFlags":{"type":"integer","format":"int64","nullable":true},"DiscountScalingItem":{"type":"array","items":{},"nullable":true},"DiscountValue":{"type":"number","nullable":true},"DiscountWeekDays":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"EligibilityTypeFlag":{"type":"integer","format":"int64","nullable":true},"EndDate":{"type":"string","nullable":true},"EvaluationTime":{"type":"integer","format":"int64","nullable":true},"FamilyID":{"type":"integer","format":"int64","nullable":true},"GroupScaledItems":{"type":"boolean","nullable":true},"HasExpireDate":{"type":"boolean","nullable":true},"HrAlt":{"type":"number","nullable":true},"Inactive":{"type":"boolean","nullable":true},"ItemID":{"type":"string","nullable":true},"ItemOfferType":{"type":"integer","format":"int64","nullable":true},"OfferQuantityMustExist":{"type":"boolean","nullable":true},"OfferTypeFlags":{"type":"integer","format":"int64","nullable":true},"PriceChargePercentage":{"type":"number","nullable":true},"PriceChargeValue":{"type":"number","nullable":true},"PriceFlags":{"type":"integer","format":"int64","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"PriceUnitID":{"type":"string","nullable":true},"ScalingMode":{"type":"integer","format":"int64","nullable":true},"ScalingType":{"type":"integer","format":"int64","nullable":true},"SessionIDSessionID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"StartDate":{"type":"string","nullable":true},"TaxIncludedPrice":{"type":"number","nullable":true},"TimeIntervals":{"type":"string","nullable":true},"UID":{"type":"string","nullable":true},"UnitPrice":{"type":"number","nullable":true},"UseTaxIncludedValues":{"type":"boolean","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"VoucherGiftValue":{"type":"number","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true},"WorkstationList":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/DiscountDefinition/{DiscountID}/DiscountEligibleItem":{"get":{"tags":["Vendas"],"operationId":"referencia_discountdefinition_1_discounteligibleitem","summary":"Obter descontos por artigo","description":"Áreas necessárias: vendas.","parameters":[{"name":"DiscountID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CanBeEvaluatedByOthers":{"type":"boolean","nullable":true},"ChangeSetID":{"type":"number","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"CriteriaType":{"type":"integer","format":"int64","nullable":true},"Cumulative":{"type":"boolean","nullable":true},"Description":{"type":"string","nullable":true},"Discount1":{"type":"number","nullable":true},"Discount2":{"type":"number","nullable":true},"Discount3":{"type":"number","nullable":true},"DiscountEligibleItem":{"type":"array","items":{},"nullable":true},"DiscountFlags":{"type":"integer","format":"int64","nullable":true},"DiscountID":{"type":"integer","format":"int64","nullable":true},"DiscountKey":{"type":"string","nullable":true},"DiscountPriceFlags":{"type":"integer","format":"int64","nullable":true},"DiscountScalingItem":{"type":"array","items":{},"nullable":true},"DiscountValue":{"type":"number","nullable":true},"DiscountWeekDays":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"EligibilityTypeFlag":{"type":"integer","format":"int64","nullable":true},"EndDate":{"type":"string","nullable":true},"EvaluationTime":{"type":"integer","format":"int64","nullable":true},"FamilyID":{"type":"integer","format":"int64","nullable":true},"GroupScaledItems":{"type":"boolean","nullable":true},"HasExpireDate":{"type":"boolean","nullable":true},"HrAlt":{"type":"number","nullable":true},"Inactive":{"type":"boolean","nullable":true},"ItemID":{"type":"string","nullable":true},"ItemOfferType":{"type":"integer","format":"int64","nullable":true},"OfferQuantityMustExist":{"type":"boolean","nullable":true},"OfferTypeFlags":{"type":"integer","format":"int64","nullable":true},"PriceChargePercentage":{"type":"number","nullable":true},"PriceChargeValue":{"type":"number","nullable":true},"PriceFlags":{"type":"integer","format":"int64","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"PriceUnitID":{"type":"string","nullable":true},"ScalingMode":{"type":"integer","format":"int64","nullable":true},"ScalingType":{"type":"integer","format":"int64","nullable":true},"SessionIDSessionID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"StartDate":{"type":"string","nullable":true},"TaxIncludedPrice":{"type":"number","nullable":true},"TimeIntervals":{"type":"string","nullable":true},"UID":{"type":"string","nullable":true},"UnitPrice":{"type":"number","nullable":true},"UseTaxIncludedValues":{"type":"boolean","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"VoucherGiftValue":{"type":"number","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true},"WorkstationList":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/DiscountDefinition/{DiscountID}/DiscountScalingItem":{"get":{"tags":["Vendas"],"operationId":"referencia_discountdefinition_1_discountscalingitem","summary":"Obter escalões de desconto","description":"Áreas necessárias: vendas.","parameters":[{"name":"DiscountID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CanBeEvaluatedByOthers":{"type":"boolean","nullable":true},"ChangeSetID":{"type":"number","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"CriteriaType":{"type":"integer","format":"int64","nullable":true},"Cumulative":{"type":"boolean","nullable":true},"Description":{"type":"string","nullable":true},"Discount1":{"type":"number","nullable":true},"Discount2":{"type":"number","nullable":true},"Discount3":{"type":"number","nullable":true},"DiscountEligibleItem":{"type":"array","items":{},"nullable":true},"DiscountFlags":{"type":"integer","format":"int64","nullable":true},"DiscountID":{"type":"integer","format":"int64","nullable":true},"DiscountKey":{"type":"string","nullable":true},"DiscountPriceFlags":{"type":"integer","format":"int64","nullable":true},"DiscountScalingItem":{"type":"array","items":{},"nullable":true},"DiscountValue":{"type":"number","nullable":true},"DiscountWeekDays":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"EligibilityTypeFlag":{"type":"integer","format":"int64","nullable":true},"EndDate":{"type":"string","nullable":true},"EvaluationTime":{"type":"integer","format":"int64","nullable":true},"FamilyID":{"type":"integer","format":"int64","nullable":true},"GroupScaledItems":{"type":"boolean","nullable":true},"HasExpireDate":{"type":"boolean","nullable":true},"HrAlt":{"type":"number","nullable":true},"Inactive":{"type":"boolean","nullable":true},"ItemID":{"type":"string","nullable":true},"ItemOfferType":{"type":"integer","format":"int64","nullable":true},"OfferQuantityMustExist":{"type":"boolean","nullable":true},"OfferTypeFlags":{"type":"integer","format":"int64","nullable":true},"PriceChargePercentage":{"type":"number","nullable":true},"PriceChargeValue":{"type":"number","nullable":true},"PriceFlags":{"type":"integer","format":"int64","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"PriceUnitID":{"type":"string","nullable":true},"ScalingMode":{"type":"integer","format":"int64","nullable":true},"ScalingType":{"type":"integer","format":"int64","nullable":true},"SessionIDSessionID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"StartDate":{"type":"string","nullable":true},"TaxIncludedPrice":{"type":"number","nullable":true},"TimeIntervals":{"type":"string","nullable":true},"UID":{"type":"string","nullable":true},"UnitPrice":{"type":"number","nullable":true},"UseTaxIncludedValues":{"type":"boolean","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"VoucherGiftValue":{"type":"number","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true},"WorkstationList":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/extraFields":{"get":{"tags":["Artigos"],"operationId":"referencia_extrafields","summary":"Listar campos extra","description":"Áreas necessárias: artigos.","parameters":[{"name":"ExtraFieldID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ExtraFieldID":{"type":"integer","format":"int64","nullable":true},"Description":{"type":"string","nullable":true},"AplyToTable":{"type":"string","nullable":true},"TextField":{"type":"boolean","nullable":true},"TextFieldLenght":{"type":"integer","format":"int64","nullable":true},"TextAnswersList":{"type":"string","nullable":true},"LongTextAnswersList":{"type":"string","nullable":true},"NumberField":{"type":"boolean","nullable":true},"NumberFieldLenght":{"type":"integer","format":"int64","nullable":true},"DataField":{"type":"boolean","nullable":true},"BooleanField":{"type":"boolean","nullable":true},"MemoField":{"type":"boolean","nullable":true},"IsMandatory":{"type":"boolean","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/family":{"get":{"tags":["Artigos"],"operationId":"referencia_family","summary":"Listar famílias","description":"Áreas necessárias: artigos. InternalID e ExtendedProperties não têm origem confirmada.","parameters":[{"name":"FamilyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"FamilyID":{"type":"integer","format":"int64","nullable":true},"FamilyKey":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"Level":{"type":"integer","format":"int64","nullable":true},"ParentDescription":{"type":"string","nullable":true},"MaximumDiscount":{"type":"number","nullable":true},"DOSFamilyID":{"type":"integer","format":"int64","nullable":true},"FullPath":{"type":"string","nullable":true},"ParentID":{"type":"integer","format":"int64","nullable":true},"Service":{"type":"boolean","nullable":true},"LabelCopies":{"type":"integer","format":"int64","nullable":true},"FamilyPicturePath":{"type":"string","nullable":true},"ProfitRates":{"type":"array","items":{},"nullable":true},"ItemDefaultUnit":{"type":"string","nullable":true},"TillReportSummary":{"type":"boolean","nullable":true},"ExportToTouch":{"type":"boolean","nullable":true},"TouchButtonFontColor":{"type":"integer","format":"int64","nullable":true},"TouchLastLevel":{"type":"boolean","nullable":true},"PropertyID1":{"type":"string","nullable":true},"PropertyID2":{"type":"string","nullable":true},"PropertyID3":{"type":"string","nullable":true},"InformationField1":{"type":"string","nullable":true},"InformationField2":{"type":"string","nullable":true},"InformationField3":{"type":"string","nullable":true},"InformationField4":{"type":"string","nullable":true},"InformationField5":{"type":"string","nullable":true},"InformationField6":{"type":"string","nullable":true},"InformationField7":{"type":"string","nullable":true},"InformationField8":{"type":"string","nullable":true},"InformationField9":{"type":"string","nullable":true},"InformationField10":{"type":"string","nullable":true},"MonthWarranty":{"type":"integer","format":"int64","nullable":true},"MandatoryCustomer":{"type":"boolean","nullable":true},"ProductCategory":{"type":"integer","format":"int64","nullable":true},"FamilyType":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/familychildren":{"get":{"tags":["Artigos"],"operationId":"referencia_familychildren","summary":"Listar sub-famílias","description":"Áreas necessárias: artigos. Subfamílias imediatas. InternalID e ExtendedProperties não têm origem confirmada.","parameters":[{"name":"FamilyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"FamilyID":{"type":"integer","format":"int64","nullable":true},"FamilyKey":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"Level":{"type":"integer","format":"int64","nullable":true},"ParentDescription":{"type":"string","nullable":true},"MaximumDiscount":{"type":"number","nullable":true},"DOSFamilyID":{"type":"integer","format":"int64","nullable":true},"FullPath":{"type":"string","nullable":true},"ParentID":{"type":"integer","format":"int64","nullable":true},"Service":{"type":"boolean","nullable":true},"LabelCopies":{"type":"integer","format":"int64","nullable":true},"FamilyPicturePath":{"type":"string","nullable":true},"ProfitRates":{"type":"array","items":{},"nullable":true},"ItemDefaultUnit":{"type":"string","nullable":true},"TillReportSummary":{"type":"boolean","nullable":true},"ExportToTouch":{"type":"boolean","nullable":true},"TouchButtonFontColor":{"type":"integer","format":"int64","nullable":true},"TouchLastLevel":{"type":"boolean","nullable":true},"PropertyID1":{"type":"string","nullable":true},"PropertyID2":{"type":"string","nullable":true},"PropertyID3":{"type":"string","nullable":true},"InformationField1":{"type":"string","nullable":true},"InformationField2":{"type":"string","nullable":true},"InformationField3":{"type":"string","nullable":true},"InformationField4":{"type":"string","nullable":true},"InformationField5":{"type":"string","nullable":true},"InformationField6":{"type":"string","nullable":true},"InformationField7":{"type":"string","nullable":true},"InformationField8":{"type":"string","nullable":true},"InformationField9":{"type":"string","nullable":true},"InformationField10":{"type":"string","nullable":true},"MonthWarranty":{"type":"integer","format":"int64","nullable":true},"MandatoryCustomer":{"type":"boolean","nullable":true},"ProductCategory":{"type":"integer","format":"int64","nullable":true},"FamilyType":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/languageCodes":{"get":{"tags":["Clientes"],"operationId":"referencia_languagecodes","summary":"Listar Idiomas","description":"Áreas necessárias: clientes.","parameters":[{"name":"LanguageID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"LanguageID":{"type":"string","nullable":true},"LanguageKey":{"type":"string","nullable":true},"LanguageName":{"type":"string","nullable":true},"FontCharacterSet":{"type":"integer","format":"int64","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/loadunloadplace":{"get":{"tags":["Vendas"],"operationId":"referencia_loadunloadplace","summary":"Listar cargas/descargas","description":"Áreas necessárias: vendas.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"LoadUnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"Description":{"type":"string","nullable":true},"AddressType":{"type":"integer","format":"int64","nullable":true},"AddressTypeID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/payment":{"get":{"tags":["Financeiro"],"operationId":"referencia_payment","summary":"Obter pagamentos","description":"Áreas necessárias: financeiro. PaymentDaysAfter e ExtendedProperties não têm origem confirmada.","parameters":[{"name":"PaymentID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PaymentID":{"type":"integer","format":"int64","nullable":true},"PaymentKey":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"PaymentDays":{"type":"integer","format":"int64","nullable":true},"IssueReceipt":{"type":"boolean","nullable":true},"InternalUse":{"type":"boolean","nullable":true},"InstallmentList":{"type":"array","items":{},"nullable":true},"PaymentDateType":{"type":"integer","format":"int64","nullable":true},"Installments":{"type":"integer","format":"int64","nullable":true},"InstallmentsType":{"type":"integer","format":"int64","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/prices":{"get":{"tags":["Artigos"],"operationId":"referencia_prices","summary":"Linhas de preço (GET prices)","description":"Áreas necessárias: artigos.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PriceLineID":{"type":"integer","format":"int64","nullable":true},"UnitPrice":{"type":"number","nullable":true},"TaxIncludedPrice":{"type":"number","nullable":true},"FixedProfitRate":{"type":"number","nullable":true},"ItemID":{"type":"string","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products":{"get":{"tags":["Artigos"],"operationId":"referencia_products","summary":"Listar artigo por Refª","description":"Áreas necessárias: artigos, stocks. Requer também compras quando simple está ausente ou é falso. simple=true mantém Price e devolve null em Stocks, StockProperties, ItemSupplierList, Colors e Sizes. barcodes=true inclui os códigos alternativos. dtalt filtra inclusivamente a data de alteração da ficha (AAAA-MM-DD). TaxPercent, ItemUpdateDate e Price.ProfitRate dependem de regras do SDK ainda sem equivalência confirmada.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"FamilyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"Discontinued","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"dtalt","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"LanguageID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"simple","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"barcodes","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"PriceLineID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ItemID":{"type":"string","nullable":true},"ItemType":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"ShortDescription":{"type":"string","nullable":true},"Barcode":{"type":"string","nullable":true},"ItemPictureName":{"type":"string","nullable":true},"UnitOfSaleID":{"type":"string","nullable":true},"AlternativeUnitOfStock":{"type":"string","nullable":true},"WeightMeasure":{"type":"number","nullable":true},"WeightUnitOfMeasure":{"type":"string","nullable":true},"TaxableGroupID":{"type":"integer","format":"int64","nullable":true},"AverageCostPrice":{"type":"number","nullable":true},"CustomerOrderQty":{"type":"number","nullable":true},"SupplierOrderQty":{"type":"number","nullable":true},"CustomerConsignmentQty":{"type":"number","nullable":true},"SupplierConsignmentQty":{"type":"number","nullable":true},"AvailableQty":{"type":"number","nullable":true},"PhysicalQty":{"type":"number","nullable":true},"PhysicalUnits":{"type":"number","nullable":true},"AvailableUnits":{"type":"number","nullable":true},"AverageCostStockValue":{"type":"number","nullable":true},"LastCostStockValue":{"type":"number","nullable":true},"ReorderPoint":{"type":"number","nullable":true},"RestockLevel":{"type":"number","nullable":true},"LastReceivedDate":{"type":"string","nullable":true},"LastOutgoingDate":{"type":"string","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"FamilyID":{"type":"integer","format":"int64","nullable":true},"Price":{"type":"array","items":{},"nullable":true},"Sizes":{"type":"array","items":{},"nullable":true},"Colors":{"type":"array","items":{},"nullable":true},"BarCodes":{"type":"array","items":{},"nullable":true},"Graduation":{"type":"integer","format":"int64","nullable":true},"BinLocation":{"type":"string","nullable":true},"Comments":{"type":"string","nullable":true},"Discontinued":{"type":"boolean","nullable":true},"NetDrainedWeight":{"type":"integer","format":"int64","nullable":true},"NetDrainedUnitOfMeasure":{"type":"string","nullable":true},"GrossWeight":{"type":"number","nullable":true},"MeasureLength":{"type":"number","nullable":true},"MeasureWidth":{"type":"number","nullable":true},"MeasureDepth":{"type":"number","nullable":true},"CreateDate":{"type":"string","nullable":true},"DtAlt":{"type":"string","nullable":true},"HrAlt":{"type":"string","nullable":true},"PropertyID1":{"type":"string","nullable":true},"PropertyID2":{"type":"string","nullable":true},"PropertyID3":{"type":"string","nullable":true},"ItemFirstGroupDescription":{"type":"string","nullable":true},"ItemSecondGroupDescription":{"type":"string","nullable":true},"ItemThirdGroupDescription":{"type":"string","nullable":true},"BarcodeType":{"type":"string","nullable":true},"OriginCountryID":{"type":"string","nullable":true},"LabelIngredients":{"type":"string","nullable":true},"StockManagement":{"type":"boolean","nullable":true},"ReadQuantityFromScale":{"type":"boolean","nullable":true},"DefaultBuyUnit":{"type":"string","nullable":true},"DefaultSellingUnit":{"type":"string","nullable":true},"DefaultStockUnit":{"type":"string","nullable":true},"UnitConversion":{"type":"number","nullable":true},"Locked":{"type":"integer","format":"int64","nullable":true},"StockProperties":{"type":"array","items":{},"nullable":true},"ItemSupplierList":{"type":"array","items":{},"nullable":true},"Stocks":{"type":"array","items":{},"nullable":true},"IntraStatCN":{"type":"string","nullable":true},"ExportToTouch":{"type":"boolean","nullable":true},"TagAlongItem":{"type":"string","nullable":true},"TagAlongQuantity":{"type":"number","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/colorCount":{"get":{"tags":["Artigos"],"operationId":"referencia_products_colorcount","summary":"Obter total de cores do artigo","description":"Áreas necessárias: artigos. Cores distintas associadas aos artigos selecionados, em objeto Count.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"Count":{"type":"integer","format":"int64","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/colorsizes":{"get":{"tags":["Artigos"],"operationId":"referencia_products_colorsizes","summary":"Cores/Tamanhos do artigo","description":"Áreas necessárias: artigos. Cores e tamanhos distintos associados ao artigo ou, sem filtro, aos artigos do catálogo.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"Sizes":{"type":"array","items":{},"nullable":true},"Colors":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/count":{"get":{"tags":["Artigos"],"operationId":"referencia_products_count","summary":"Total de artigos (count)","description":"Áreas necessárias: artigos.","parameters":[{"name":"FamilyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"integer","format":"int64","nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/descriptions":{"get":{"tags":["Artigos"],"operationId":"referencia_products_descriptions","summary":"Descrições do artigo por idioma","description":"Áreas necessárias: artigos.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ItemID":{"type":"string","nullable":true},"LanguageID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"ShortDescription":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/extraFields":{"get":{"tags":["Artigos"],"operationId":"referencia_products_extrafields","summary":"Listar Campos Extra Artigo","description":"Áreas necessárias: artigos.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"BooleanAnswer":{"type":"boolean","nullable":true},"DateAnswer":{"type":"string","nullable":true},"ExtraFieldID":{"type":"integer","format":"int64","nullable":true},"ItemID":{"type":"string","nullable":true},"MemoAnswer":{"type":"string","nullable":true},"NumberAnswer":{"type":"number","nullable":true},"TextAnswer":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/itemproperties":{"get":{"tags":["Stocks"],"operationId":"referencia_products_itemproperties","summary":"Listar propriedades do artigo","description":"Áreas necessárias: stocks. Combinações distintas nas existências dos armazéns.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PropertyValue1":{"type":"string","nullable":true},"PropertyValue1_Key2":{"type":"string","nullable":true},"PropertyValue1_Key3":{"type":"string","nullable":true},"PropertyValue2":{"type":"string","nullable":true},"PropertyValue2_Key2":{"type":"string","nullable":true},"PropertyValue2_Key3":{"type":"string","nullable":true},"PropertyValue3":{"type":"string","nullable":true},"PropertyValue3_Key2":{"type":"string","nullable":true},"PropertyValue3_Key3":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/itempropertiesCount":{"get":{"tags":["Stocks"],"operationId":"referencia_products_itempropertiescount","summary":"Total propriedades do artigo","description":"Áreas necessárias: stocks. Conta as combinações distintas de propriedades.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"Count":{"type":"integer","format":"int64","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/sizeCount":{"get":{"tags":["Artigos"],"operationId":"referencia_products_sizecount","summary":"Total de tamanhos do artigo (sizeCount)","description":"Áreas necessárias: artigos. Contagem das associações ao artigo, em objeto Count.","parameters":[{"name":"ItemID","in":"query","required":true,"schema":{"type":"string","maxLength":256}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"Count":{"type":"integer","format":"int64","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/stock":{"get":{"tags":["Stocks"],"operationId":"referencia_products_stock","summary":"Listar stock artigo por refª","description":"Áreas necessárias: stocks.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"WarehouseID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"AvailableQty":{"type":"number","nullable":true},"AvailableUnits":{"type":"number","nullable":true},"AverageCostStockValue":{"type":"number","nullable":true},"BinLocation":{"type":"string","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"CurrencyExchange":{"type":"number","nullable":true},"CurrencyFactor":{"type":"number","nullable":true},"CurrencyID":{"type":"string","nullable":true},"CustomerConsignmentQty":{"type":"number","nullable":true},"CustomerConsignmentUnits":{"type":"number","nullable":true},"CustomerOrderQty":{"type":"number","nullable":true},"CustomerOrderUnits":{"type":"number","nullable":true},"DtAlt":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true},"IntCod":{"type":"number","nullable":true},"ItemID":{"type":"string","nullable":true},"LastCostPrice":{"type":"number","nullable":true},"LastCostStockValue":{"type":"number","nullable":true},"LastOutgoingDate":{"type":"string","nullable":true},"LotID":{"type":"string","nullable":true},"PhysicalQty":{"type":"number","nullable":true},"PhysicalUnits":{"type":"number","nullable":true},"ReorderPoint":{"type":"number","nullable":true},"RestockLevel":{"type":"number","nullable":true},"SessionID":{"type":"integer","format":"int64","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"SupplierConsignmentQty":{"type":"number","nullable":true},"SupplierConsignmentUnits":{"type":"number","nullable":true},"SupplierOrderQty":{"type":"number","nullable":true},"SupplierOrderUnits":{"type":"number","nullable":true},"TaxIncludedLastCostPrice":{"type":"number","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/stockproperties":{"get":{"tags":["Stocks"],"operationId":"referencia_products_stockproperties","summary":"Listar stock artigo por propriedades","description":"Áreas necessárias: stocks.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ExpirationDate":{"type":"string","nullable":true},"ItemID":{"type":"string","nullable":true},"PhysicalQty":{"type":"number","nullable":true},"ProductionDate":{"type":"string","nullable":true},"PropertyValue1":{"type":"string","nullable":true},"PropertyValue1_Key2":{"type":"string","nullable":true},"PropertyValue1_Key3":{"type":"string","nullable":true},"PropertyValue2":{"type":"string","nullable":true},"PropertyValue2_Key2":{"type":"string","nullable":true},"PropertyValue2_Key3":{"type":"string","nullable":true},"PropertyValue3":{"type":"string","nullable":true},"PropertyValue3_Key2":{"type":"string","nullable":true},"PropertyValue3_Key3":{"type":"string","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/suppliers":{"get":{"tags":["Compras"],"operationId":"referencia_products_suppliers","summary":"Fornecedores do artigo","description":"Áreas necessárias: compras. Requer também stocks quando WarehouseID está presente. A associação é por artigo. WarehouseID restringe a artigos com linha de stock no armazém.","parameters":[{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"WarehouseID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ItemID":{"type":"string","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"UnitOfMeasure":{"type":"string","nullable":true},"ReorderID":{"type":"string","nullable":true},"CostPrice":{"type":"number","nullable":true},"TaxIncludedCostPrice":{"type":"number","nullable":true},"CostPriceDate":{"type":"string","nullable":true},"CurrencyID":{"type":"string","nullable":true},"CurrencyFactor":{"type":"number","nullable":true},"CurrencyExchange":{"type":"number","nullable":true},"Discount1":{"type":"number","nullable":true},"Discount2":{"type":"number","nullable":true},"Discount3":{"type":"number","nullable":true},"MinOrder":{"type":"number","nullable":true},"PackQuantity":{"type":"number","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/salesman":{"get":{"tags":["Vendas"],"operationId":"referencia_salesman","summary":"Vendedores","description":"Áreas necessárias: vendas.","parameters":[{"name":"SalesmanID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"SalesmanID":{"type":"integer","format":"int64","nullable":true},"Name":{"type":"string","nullable":true},"Inactive":{"type":"boolean","nullable":true},"SalesmanLevel":{"type":"integer","format":"int64","nullable":true},"MaximumDiscount":{"type":"number","nullable":true},"Telephone1":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/sizes":{"get":{"tags":["Artigos"],"operationId":"referencia_sizes","summary":"Tamanhos","description":"Áreas necessárias: artigos.","parameters":[{"name":"SizeID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"SizeName","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"SizeID":{"type":"integer","format":"int64","nullable":true},"SizeName":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/taxes":{"get":{"tags":["Financeiro"],"operationId":"referencia_taxes","summary":"Taxas","description":"Áreas necessárias: financeiro. TaxID filtra o identificador de grupo tributável devolvido na listagem.","parameters":[{"name":"TaxID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TaxableGroupID":{"type":"integer","format":"int64","nullable":true},"Description":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/taxes/taxrate":{"get":{"tags":["Financeiro"],"operationId":"referencia_taxes_taxrate","summary":"Taxa por grupo IVA (taxrate)","description":"Áreas necessárias: financeiro. Apresenta as taxas por grupo, país e região com a data de vigência disponível no Sage.","parameters":[{"name":"TaxableGroupID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TaxableGroupID":{"type":"integer","format":"int64","nullable":true},"TaxGroupID":{"type":"string","nullable":true},"TaxSequenceID":{"type":"integer","format":"int64","nullable":true},"CountryID":{"type":"string","nullable":true},"TaxRegionID":{"type":"string","nullable":true},"TaxRate":{"type":"number","nullable":true},"TaxExpirationDate":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/taxeTable":{"get":{"tags":["Financeiro"],"operationId":"referencia_taxetable","summary":"Tabela impostos","description":"Áreas necessárias: financeiro.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TaxSequenceID":{"type":"integer","format":"int64","nullable":true},"CountryID":{"type":"string","nullable":true},"TaxRegionID":{"type":"string","nullable":true},"TaxRate":{"type":"number","nullable":true},"TaxOnShipping":{"type":"boolean","nullable":true},"InternalUse":{"type":"boolean","nullable":true},"TaxExemptionReason":{"type":"string","nullable":true},"TaxExpirationDate":{"type":"string","nullable":true},"TaxExemptionReasonCode":{"type":"string","nullable":true},"TaxCode":{"type":"string","nullable":true},"TaxGroupID":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/tender":{"get":{"tags":["Financeiro"],"operationId":"referencia_tender","summary":"Modalidades","description":"Áreas necessárias: financeiro. Nome em português. Internal, ExtendedProperties e Properties não têm origem confirmada.","parameters":[{"name":"TenderID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TenderID":{"type":"integer","format":"int64","nullable":true},"TenderKey":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"MinimumSaleAmount":{"type":"number","nullable":true},"MaximumAcceptAmount":{"type":"number","nullable":true},"MaxAcceptAmntCurrencyID":{"type":"string","nullable":true},"MaxAcceptAmntCurrencyFactor":{"type":"number","nullable":true},"MaxAcceptAmntCurrencyExchange":{"type":"number","nullable":true},"CanReturnMoneyChange":{"type":"boolean","nullable":true},"TenderUse":{"type":"integer","format":"int64","nullable":true},"UseDOCToPay":{"type":"boolean","nullable":true},"DocIDUsedToPay":{"type":"string","nullable":true},"TenderType":{"type":"integer","format":"int64","nullable":true},"CustomerIdentificationRequired":{"type":"boolean","nullable":true},"AccountIdentificationRequired":{"type":"boolean","nullable":true},"OpenCashDrawerRequired":{"type":"boolean","nullable":true},"SeriesBarcodeList":{"type":"array","items":{},"nullable":true},"InternalUse":{"type":"boolean","nullable":true},"UpdateTillReport":{"type":"boolean","nullable":true},"DebitedOnAccount":{"type":"boolean","nullable":true},"Inactive":{"type":"boolean","nullable":true},"StampDutyBillOfExchange":{"type":"string","nullable":true},"SAFTPaymentMechanism":{"type":"string","nullable":true},"DebitedDocuments":{"type":"array","items":{},"nullable":true},"ChargeDaysAfterDueDate":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/till":{"get":{"tags":["Financeiro"],"operationId":"referencia_till","summary":"Listar caixas","description":"Áreas necessárias: financeiro.","parameters":[{"name":"TillID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TillID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"StatusCode":{"type":"integer","format":"int64","nullable":true},"MinimumWarningAmount":{"type":"number","nullable":true},"DefaultCashBalanceAmount":{"type":"number","nullable":true},"MaximumWarningAmount":{"type":"number","nullable":true},"MaximumLockoutAmount":{"type":"number","nullable":true},"StoreId":{"type":"integer","format":"int64","nullable":true},"MainTill":{"type":"boolean","nullable":true},"OfflineTill":{"type":"boolean","nullable":true},"Comments":{"type":"string","nullable":true},"TillOpenMode":{"type":"integer","format":"int64","nullable":true},"OnTouchUseRoute":{"type":"boolean","nullable":true},"MaximumSessionsPerDay":{"type":"integer","format":"int64","nullable":true},"CanHaveOpenTill":{"type":"boolean","nullable":true},"TillLockToSalesman":{"type":"boolean","nullable":true},"FixSalesmanForSession":{"type":"boolean","nullable":true},"ExclusiveToOwnerSalesman":{"type":"boolean","nullable":true},"CanChangeTranOnSignOffTill":{"type":"boolean","nullable":true},"CheckForTempTransactionOnSignOff":{"type":"boolean","nullable":true},"OperatorTenderStatement":{"type":"boolean","nullable":true},"TenderStatementTentatives":{"type":"integer","format":"int64","nullable":true},"OnStatementCanHaveDiscrepancy":{"type":"boolean","nullable":true},"StatementDiscrepancyAmount":{"type":"number","nullable":true},"DiscrepancyTillID":{"type":"string","nullable":true},"DiscrepancyAccountTypeID":{"type":"string","nullable":true},"BuiltIn":{"type":"boolean","nullable":true},"TillBankAccount":{"type":"array","items":{},"nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/unitofmeasure":{"get":{"tags":["Artigos"],"operationId":"referencia_unitofmeasure","summary":"Unidades de medida","description":"Áreas necessárias: artigos.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"UnitOfMeasureID":{"type":"string","nullable":true},"UnitOfMeasureKey":{"type":"string","nullable":true},"LanguageID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"EnglishMetricFlag":{"type":"boolean","nullable":true},"UnitOfMeasureTypeCode":{"type":"integer","format":"int64","nullable":true},"UnitOfMeasureConversion":{"type":"number","nullable":true},"ConversionTo":{"type":"string","nullable":true},"CalcFormula":{"type":"string","nullable":true},"MaximumDecimals":{"type":"integer","format":"int64","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"DtAlt":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true},"UID":{"type":"string","nullable":true},"ChangeSetID":{"type":"number","nullable":true},"UNECEUnitcode":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/warehouses":{"get":{"tags":["Stocks"],"operationId":"referencia_warehouses","summary":"Listar armazéns","description":"Áreas necessárias: stocks.","parameters":[{"name":"WarehouseID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"AddressLine1":{"type":"string","nullable":true},"AddressLine2":{"type":"string","nullable":true},"CountryID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"DtAlt":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true},"IsExternal":{"type":"boolean","nullable":true},"LocalityID":{"type":"integer","format":"int64","nullable":true},"PostalCode":{"type":"string","nullable":true},"ProductCategory":{"type":"integer","format":"int64","nullable":true},"ProvinceID":{"type":"string","nullable":true},"SessionID":{"type":"integer","format":"int64","nullable":true},"StoreID":{"type":"integer","format":"int64","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true},"WarehouseKey":{"type":"string","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/warehousesstocks":{"get":{"tags":["Stocks"],"operationId":"referencia_warehousesstocks","summary":"Listar stock artigos por armazém","description":"Áreas necessárias: stocks. Description é a descrição portuguesa do artigo. A página preserva cada variante de lote do stock.","parameters":[{"name":"WarehouseID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ItemID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"AvailableQty":{"type":"number","nullable":true},"BinLocation":{"type":"string","nullable":true},"ColorID":{"type":"integer","format":"int64","nullable":true},"Description":{"type":"string","nullable":true},"ItemID":{"type":"string","nullable":true},"PhysicalQty":{"type":"number","nullable":true},"SizeID":{"type":"integer","format":"int64","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/zones":{"get":{"tags":["Clientes"],"operationId":"referencia_zones","summary":"Zonas","description":"Áreas necessárias: clientes. Sem fonte SQL confirmada para ExtendedProperties.","parameters":[{"name":"ZoneID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ZoneID":{"type":"integer","format":"int64","nullable":true},"Zonekey":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"ZoneType":{"type":"integer","format":"int64","nullable":true},"CurrencyID":{"type":"string","nullable":true},"CountryID":{"type":"string","nullable":true},"TaxRegionID":{"type":"string","nullable":true},"TaxExemptionReasonCode":{"type":"string","nullable":true},"TaxExemptionReasonCodeService":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/groups":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_groups","summary":"Listar grupos de cliente","description":"Áreas necessárias: clientes. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso.","parameters":[{"name":"GroupID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"GroupID":{"type":"integer","format":"int64","nullable":true},"Description":{"type":"string","nullable":true},"GroupKey":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/status/all":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_status_all","summary":"Lista de estados do documento","description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"StatusID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/series":{"get":{"tags":["Vendas"],"operationId":"referencia_series","summary":"Listar séries","description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"Series":{"type":"string","nullable":true},"SeriesKey":{"type":"string","nullable":true},"IsInactive":{"type":"boolean","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/series":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_series","summary":"Lista de séries","description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso.","parameters":[{"name":"Series","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"Series":{"type":"string","nullable":true},"SeriesKey":{"type":"string","nullable":true},"IsInactive":{"type":"boolean","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/address/{PartyID}":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_address_1","summary":"Moradas do cliente","description":"Áreas necessárias: clientes. Resolve a morada pelo identificador de entidade da ficha.","parameters":[{"name":"PartyID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"AddressID":{"type":"integer","format":"int64","nullable":true},"AddressType":{"type":"integer","format":"int64","nullable":true},"AddressLine1":{"type":"string","nullable":true},"AddressLine2":{"type":"string","nullable":true},"PostalCode":{"type":"string","nullable":true},"CountryID":{"type":"string","nullable":true},"ProvinceID":{"type":"string","nullable":true},"LocalityID":{"type":"integer","format":"int64","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"CountryDescription":{"type":"string","nullable":true},"ProvinceDescription":{"type":"string","nullable":true},"LocalityDescription":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/address/{SupplierID}":{"get":{"tags":["Compras"],"operationId":"referencia_suppliers_address_1","summary":"Morada do fornecedor","description":"Áreas necessárias: compras. Resolve a morada pelo identificador de entidade da ficha.","parameters":[{"name":"SupplierID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"AddressID":{"type":"integer","format":"int64","nullable":true},"AddressType":{"type":"integer","format":"int64","nullable":true},"AddressLine1":{"type":"string","nullable":true},"AddressLine2":{"type":"string","nullable":true},"PostalCode":{"type":"string","nullable":true},"CountryID":{"type":"string","nullable":true},"ProvinceID":{"type":"string","nullable":true},"LocalityID":{"type":"integer","format":"int64","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"CountryDescription":{"type":"string","nullable":true},"ProvinceDescription":{"type":"string","nullable":true},"LocalityDescription":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/email":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_email","summary":"Email do cliente","description":"Áreas necessárias: clientes. A documentação descreve o endereço da ficha e o parâmetro obrigatório. Não publica o invólucro de sucesso.","parameters":[{"name":"PartyID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"EmailAddress":{"type":"string","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/contacts/{PartyID}":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_contacts_1","summary":"Contactos do cliente","description":"Áreas necessárias: clientes. Listas de contacto com os campos EmailAddress e TelephoneNumber. A estrutura dos elementos destas listas não foi publicada.","parameters":[{"name":"PartyID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PersonID":{"type":"integer","format":"int64","nullable":true},"Name":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Position":{"type":"string","nullable":true},"EmailList":{"type":"array","items":{},"nullable":true},"TelephoneList":{"type":"array","items":{},"nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/bank-accounts":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_bank_accounts","summary":"Contas bancárias do cliente","description":"Áreas necessárias: clientes, financeiro. Identificação e IBAN das contas de clientes. A referência não especifica outros campos de resposta.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"BankAccountID":{"type":"integer","format":"int64","nullable":true},"FormattedIBAN":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/extrafields/{PartyID}":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_extrafields_1","summary":"Campos extra do cliente","description":"Áreas necessárias: clientes. A referência não publica o esquema de sucesso. A consulta expõe o ID do campo e as suas respostas tipadas.","parameters":[{"name":"PartyID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ExtraFieldID":{"type":"integer","format":"int64","nullable":true},"TextAnswer":{"type":"string","nullable":true},"NumberAnswer":{"type":"number","nullable":true},"DateAnswer":{"type":"string","nullable":true},"BooleanAnswer":{"type":"boolean","nullable":true},"MemoAnswer":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/extraFields":{"get":{"tags":["Compras"],"operationId":"referencia_suppliers_extrafields","summary":"Campo extra do fornecedor","description":"Áreas necessárias: compras. Apenas a resposta de erro foi publicada. Os valores vêm da resposta tipada da ficha. Uma chave sem resultado devolve o objeto Code/Message documentado.","parameters":[{"name":"SupplierID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ExtraFieldID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"ExtraFieldID":{"type":"integer","format":"int64","nullable":true},"TextAnswer":{"type":"string","nullable":true},"NumberAnswer":{"type":"number","nullable":true},"DateAnswer":{"type":"string","nullable":true},"BooleanAnswer":{"type":"boolean","nullable":true},"MemoAnswer":{"type":"string","nullable":true}},"nullable":true},{"type":"object","required":["Code","Message"],"example":{"Code":"Error","Message":"ExtraField not found or does not have a value"}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/voucher":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_voucher","summary":"Consultar talão","description":"Áreas necessárias: vendas. A data de validade inclui o próprio dia, no calendário do SQL Server da empresa. Uma chave sem resultado devolve o objeto Code/Message documentado.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"FaceValueAmount":{"type":"number","nullable":true},"SpentValueAmount":{"type":"number","nullable":true},"AvailableAmount":{"type":"number","nullable":true},"ExpirationDate":{"type":"string","nullable":true},"DateSold":{"type":"string","nullable":true},"OpenAmountFlag":{"type":"boolean","nullable":true},"Valid":{"type":"boolean","nullable":true}},"nullable":true},{"type":"object","required":["Code","Message"],"example":{"Code":"error","Message":"Talão não encontrado"}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/ledgeraccount":{"get":{"tags":["Financeiro"],"operationId":"referencia_documents_ledgeraccount","summary":"Documento ledger account (Sage)","description":"Áreas necessárias: financeiro. Projeção de identificação, estado e valores do lançamento. O fornecedor publica o caso de erro, sem esquema de sucesso. Uma chave sem resultado devolve o objeto Code/Message documentado.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyAccountTypeID":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TotalTaxAmount":{"type":"number","nullable":true},"TotalRetentionAmount":{"type":"number","nullable":true},"TotalAmount":{"type":"number","nullable":true},"CurrencyID":{"type":"string","nullable":true},"TransStatus":{"type":"integer","format":"int64","nullable":true}},"nullable":true},{"type":"object","required":["Code","Message"],"example":{"Code":"error","Message":"Document not found"}}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/pending/{PartyID}":{"get":{"tags":["Financeiro"],"operationId":"referencia_customers_pending_50023","summary":"Listar Pendentes cliente","description":"Áreas necessárias: financeiro, clientes. Agrupa prestações pela chave documental, conserva o sinal e indica o primeiro vencimento ainda em aberto. A regra para vários vencimentos requer reconciliação com o fornecedor. Um agregado em moedas distintas devolve montante nulo.","parameters":[{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"PartyID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"TotalAmount":{"type":"number","nullable":true},"PendingAmount":{"type":"number","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/pending":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_pending","summary":"Pendentes de fornecedor (lista)","description":"Áreas necessárias: financeiro, compras. Agrupa prestações pela chave documental, conserva o sinal e indica o primeiro vencimento ainda em aberto. A regra para vários vencimentos requer reconciliação com o fornecedor. Um agregado em moedas distintas devolve montante nulo.","parameters":[{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"TotalAmount":{"type":"number","nullable":true},"PendingAmount":{"type":"number","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/pending/{SupplierID}":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_pending_1","summary":"Pendentes de um fornecedor","description":"Áreas necessárias: financeiro, compras. Agrupa prestações pela chave documental, conserva o sinal e indica o primeiro vencimento ainda em aberto. A regra para vários vencimentos requer reconciliação com o fornecedor. Um agregado em moedas distintas devolve montante nulo.","parameters":[{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"SupplierID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"TotalAmount":{"type":"number","nullable":true},"PendingAmount":{"type":"number","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/ledgeraccount":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_ledgeraccount","summary":"Linhas ledger fornecedor (sem agregar)","description":"Áreas necessárias: financeiro, compras. PartyID no filtro seleciona a entidade da ficha. A resposta apresenta o PartyID da linha de conta-corrente conforme o exemplo publicado. Teto de mil linhas sem filtro de entidade.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"SupplierID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"PartyAccountTypeID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"TransSerial","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"onlyPending","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"BalanceAccountSign":{"type":"integer","format":"int64","nullable":true},"BalanceAmount":{"type":"number","nullable":true},"CashAccountingSchemeType":{"type":"integer","format":"int64","nullable":true},"ComissionAmount":{"type":"number","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"CreditTotalAmount":{"type":"number","nullable":true},"CurrencyExchange":{"type":"number","nullable":true},"CurrencyFactor":{"type":"number","nullable":true},"CurrencyID":{"type":"string","nullable":true},"DebitTotalAmount":{"type":"number","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"DtAlt":{"type":"string","nullable":true},"ExchangeDifCurrency":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true},"InternalID":{"type":"integer","format":"int64","nullable":true},"LedgerCounter":{"type":"number","nullable":true},"LedgerGuid":{"type":"string","nullable":true},"OperationID":{"type":"integer","format":"int64","nullable":true},"OriginTransDocNumber":{"type":"integer","format":"int64","nullable":true},"OriginTransDocument":{"type":"string","nullable":true},"OriginTransSerial":{"type":"string","nullable":true},"PartyAccountTypeID":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyTypeCode":{"type":"integer","format":"int64","nullable":true},"ReconciledFlag":{"type":"boolean","nullable":true},"RetentionPendingAmount":{"type":"number","nullable":true},"RetentionTotalAmount":{"type":"number","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"SessionID":{"type":"integer","format":"int64","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"SystemEntryDate":{"type":"string","nullable":true},"TotalAccountSign":{"type":"integer","format":"int64","nullable":true},"TotalAmount":{"type":"number","nullable":true},"TotalPendingAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransInstallmentID":{"type":"integer","format":"int64","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransStatus":{"type":"integer","format":"int64","nullable":true},"UserAlt":{"type":"integer","format":"int64","nullable":true},"WorkstationID":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/vehicles":{"get":{"tags":["Clientes"],"operationId":"referencia_vehicles","summary":"Listar veículos","description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura.","parameters":[{"name":"CustomerID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"Discontinued","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CustomerImputeID":{"type":"integer","format":"int64","nullable":true},"CustomerID":{"type":"integer","format":"int64","nullable":true},"CustomerName":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"VehicleMake":{"type":"string","nullable":true},"VehicleModel":{"type":"string","nullable":true},"VehicleYear":{"type":"integer","format":"int64","nullable":true},"VehicleMonth":{"type":"integer","format":"int64","nullable":true},"VehicleDateOfFirstRegistration":{"type":"string","nullable":true},"VehicleColor":{"type":"string","nullable":true},"VehicleFrameNumber":{"type":"string","nullable":true},"VehicleEngineNumber":{"type":"string","nullable":true},"VehicleKilometers":{"type":"number","nullable":true},"Comments":{"type":"string","nullable":true},"Discontinued":{"type":"boolean","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/vehicles/makes":{"get":{"tags":["Clientes"],"operationId":"referencia_vehicles_makes","summary":"Marcas de veículos","description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura.","parameters":[{"name":"CustomerID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"VehicleMake":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/vehicles/models":{"get":{"tags":["Clientes"],"operationId":"referencia_vehicles_models","summary":"Modelos de veículos","description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura.","parameters":[{"name":"CustomerID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"VehicleMake","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"VehicleMake":{"type":"string","nullable":true},"VehicleModel":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents":{"get":{"tags":["Vendas"],"operationId":"referencia_documents","summary":"Lista de documentos","description":"Áreas necessárias: vendas. Lista o catálogo de tipos na língua da empresa ou na língua solicitada. A referência não publica a projeção de sucesso.","parameters":[{"name":"LanguageID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"DocumentType","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TransDocumentID":{"type":"string","nullable":true},"TransDocType":{"type":"integer","format":"int64","nullable":true},"LanguageID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"ShortDescription":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/contracts":{"get":{"tags":["Clientes"],"operationId":"referencia_customers_contracts","summary":"Obter avenças","description":"Áreas necessárias: clientes, vendas. No esquema local da avença não há SalesmanID nem WeekDays. Estes campos do exemplo ficam omitidos. Price acompanha o regime de imposto da avença.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"CustomerContractID":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransDocumentToConvert":{"type":"string","nullable":true},"CreateTempTransaction":{"type":"boolean","nullable":true},"TaxIncluded":{"type":"boolean","nullable":true},"Periocity":{"type":"integer","format":"int64","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true},"Days":{"type":"integer","format":"int64","nullable":true},"InitialDate":{"type":"string","nullable":true},"FinalDate":{"type":"string","nullable":true},"NextContractDate":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"LoadPlaceID":{"type":"integer","format":"int64","nullable":true},"UnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"GlobalDiscountPercent":{"type":"number","nullable":true},"Items":{"type":"array","items":{},"nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers":{"get":{"tags":["Compras"],"operationId":"referencia_suppliers","summary":"Fornecedores","description":"Áreas necessárias: compras. A ficha devolve campos presentes na Supplier e moradas. Defaults de DTO sem coluna para CarrierID, CustomerLevel, LimitPurchaseDays, LimitPurchaseValue, LimitType, OtherEmails, PriceLineID e SalesmanID ficam omitidos.","parameters":[{"name":"SupplierID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"SupplierID":{"type":"integer","format":"int64","nullable":true},"OrganizationName":{"type":"string","nullable":true},"ActiveParty":{"type":"boolean","nullable":true},"Comments":{"type":"string","nullable":true},"DirectDiscount":{"type":"number","nullable":true},"DtAlt":{"type":"string","nullable":true},"EmailAddress":{"type":"string","nullable":true},"EntityFiscalStatusID":{"type":"integer","format":"int64","nullable":true},"Fax":{"type":"string","nullable":true},"FederalTaxID":{"type":"string","nullable":true},"HrAlt":{"type":"number","nullable":true},"LastTransDocNumber":{"type":"integer","format":"int64","nullable":true},"LastTransDocument":{"type":"string","nullable":true},"LastTransSerial":{"type":"string","nullable":true},"Locked":{"type":"boolean","nullable":true},"MobileTelephone1":{"type":"string","nullable":true},"MobileTelephone2":{"type":"string","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"PriceItemDecimalPlaces":{"type":"integer","format":"int64","nullable":true},"TaxablePersonType":{"type":"integer","format":"int64","nullable":true},"Telephone1":{"type":"string","nullable":true},"Telephone2":{"type":"string","nullable":true},"Telephone3":{"type":"string","nullable":true},"Telephone4":{"type":"string","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"WebAddress":{"type":"string","nullable":true},"ZoneID":{"type":"integer","format":"int64","nullable":true},"KeyFederalTaxID":{"type":"string","nullable":true},"LastUpdated":{"type":"string","nullable":true},"PartyAddress":{"type":"array","items":{},"nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers":{"get":{"tags":["Clientes"],"operationId":"referencia_customers","summary":"Listar clientes por refª","description":"Áreas necessárias: clientes. Requer também financeiro quando onlyPending é verdadeiro. OrderBy aceita OrganizationName, TenderID e PartyID em asc ou desc; filter faz pesquisa textual por nome, NIF e email. A linguagem de filtro avançado não foi publicada. A morada vem na coleção PartyAddress. A ficha local não tem BirthDate nem campos diretos de província/país/localidade.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"FederalTaxID","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"EmailAddress","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"OrderBy","in":"query","required":false,"schema":{"type":"string","maxLength":256,"enum":["OrganizationName","OrganizationName|asc","OrganizationName|desc","TenderID","TenderID|asc","TenderID|desc","PartyID","PartyID|asc","PartyID|desc"]}},{"name":"onlyPending","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"ActiveParty":{"type":"boolean","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"Comments":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"CustomerLevel":{"type":"integer","format":"int64","nullable":true},"DirectDiscount":{"type":"number","nullable":true},"DtAlt":{"type":"string","nullable":true},"EmailAddress":{"type":"string","nullable":true},"EntityFiscalStatusID":{"type":"integer","format":"int64","nullable":true},"Fax":{"type":"string","nullable":true},"FederalTaxID":{"type":"string","nullable":true},"GlobalDiscount":{"type":"number","nullable":true},"LastTransDocNumber":{"type":"integer","format":"int64","nullable":true},"LastTransDocument":{"type":"string","nullable":true},"LastTransSerial":{"type":"string","nullable":true},"LimitPurchaseDays":{"type":"integer","format":"int64","nullable":true},"LimitPurchaseValue":{"type":"number","nullable":true},"LimitType":{"type":"integer","format":"int64","nullable":true},"Locked":{"type":"boolean","nullable":true},"MobileTelephone1":{"type":"string","nullable":true},"MobileTelephone2":{"type":"string","nullable":true},"OrganizationName":{"type":"string","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"PersonalIDNumber":{"type":"string","nullable":true},"PriceLineID":{"type":"integer","format":"int64","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"TaxablePersonType":{"type":"integer","format":"int64","nullable":true},"Telephone1":{"type":"string","nullable":true},"Telephone2":{"type":"string","nullable":true},"Telephone3":{"type":"string","nullable":true},"Telephone4":{"type":"string","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"WebAddress":{"type":"string","nullable":true},"ZoneID":{"type":"integer","format":"int64","nullable":true},"KeyFederalTaxID":{"type":"string","nullable":true},"LastUpdated":{"type":"string","nullable":true},"PartyAddress":{"type":"array","items":{},"nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/stock":{"get":{"tags":["Stocks"],"operationId":"referencia_documents_stock","summary":"Documentos de stock","description":"Áreas necessárias: stocks. Cabeçalhos e linhas físicas publicadas com Details=true. A referência não fornece esquema de resposta para o GET de stock. Com a chave completa (TransSerial, TransDocument, TransDocNumber) devolve um objeto ou null.","parameters":[{"name":"TransSerial","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"Details","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"WarehouseReceipt":{"type":"integer","format":"int64","nullable":true},"WarehouseOutgoing":{"type":"integer","format":"int64","nullable":true},"CurrencyID":{"type":"string","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TotalTaxAmount":{"type":"number","nullable":true},"TotalAmount":{"type":"number","nullable":true},"TransStatus":{"type":"integer","format":"int64","nullable":true},"Details":{"type":"array","items":{},"nullable":true}}}},{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"CreateDate":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"WarehouseReceipt":{"type":"integer","format":"int64","nullable":true},"WarehouseOutgoing":{"type":"integer","format":"int64","nullable":true},"CurrencyID":{"type":"string","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TotalTaxAmount":{"type":"number","nullable":true},"TotalAmount":{"type":"number","nullable":true},"TransStatus":{"type":"integer","format":"int64","nullable":true},"Details":{"type":"array","items":{},"nullable":true}},"nullable":true}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/customers/cc":{"get":{"tags":["Financeiro"],"operationId":"referencia_customers_cc","summary":"Listar Conta-corrente clientes","description":"Áreas necessárias: financeiro, clientes. Inclui campos persistidos do lançamento e moeda. As propriedades calculadas do DTO do fornecedor (pagamentos, descontos, adiantamentos e propriedades de apresentação) não têm equivalência comprovada.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"BalanceCompensationFlag":{"type":"boolean","nullable":true},"CashAccountingSchemeType":{"type":"integer","format":"int64","nullable":true},"ComissionAmount":{"type":"number","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"CreditTotalAmount":{"type":"number","nullable":true},"DebitTotalAmount":{"type":"number","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"ExchangeDifCurrency":{"type":"string","nullable":true},"Guid":{"type":"string","nullable":true},"InternalID":{"type":"integer","format":"int64","nullable":true},"LedgerCounter":{"type":"number","nullable":true},"OperationID":{"type":"integer","format":"int64","nullable":true},"OriginTransDocNumber":{"type":"integer","format":"int64","nullable":true},"OriginTransDocument":{"type":"string","nullable":true},"OriginTransSerial":{"type":"string","nullable":true},"PartyAccountTypeID":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyTypeCode":{"type":"integer","format":"int64","nullable":true},"ReconciledFlag":{"type":"boolean","nullable":true},"RetentionPendingAmount":{"type":"number","nullable":true},"RetentionStampDutyPending":{"type":"number","nullable":true},"RetentionStampDutyTotal":{"type":"number","nullable":true},"RetentionTotalAmount":{"type":"number","nullable":true},"SalesmanId":{"type":"integer","format":"int64","nullable":true},"SystemEntryDate":{"type":"string","nullable":true},"TotalAccountSign":{"type":"integer","format":"int64","nullable":true},"TotalAmount":{"type":"number","nullable":true},"TotalPendingAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransInstallmentID":{"type":"integer","format":"int64","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransStatus":{"type":"integer","format":"int64","nullable":true},"BaseCurrency":{"type":"object","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/account":{"get":{"tags":["Financeiro"],"operationId":"referencia_documents_account","summary":"Listar documentos de conta-corrente","description":"Áreas necessárias: financeiro. Coleções de documentos liquidados, pagamentos e cheques consultadas em separado. Os dados específicos de cheque ficam em CheckTenderLineItems. O Sage local não guarda PaymentID no cabeçalho do recibo.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TotalAmount":{"type":"number","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyName":{"type":"string","nullable":true},"PartyAddress1":{"type":"string","nullable":true},"PartyAddress2":{"type":"string","nullable":true},"PartyFederalTaxID":{"type":"string","nullable":true},"PartyPostalCode":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"ATCUD":{"type":"string","nullable":true},"QRCode":{"type":"string","nullable":true},"TillID":{"type":"string","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"SalesmanName":{"type":"string","nullable":true},"Details":{"type":"array","items":{},"nullable":true},"TenderLineItems":{"type":"array","items":{},"nullable":true},"CheckTenderLineItems":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/saldo":{"get":{"tags":["Financeiro"],"operationId":"referencia_saldo","summary":"Saldo do cliente","description":"Áreas necessárias: financeiro, clientes. A especificação omite a fórmula e o formato de sucesso. Projeção local por moeda da diferença entre débitos e créditos na conta CC. Sem paridade comprovada com o saldo Sage.","parameters":[{"name":"CustomerID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"CustomerID":{"type":"integer","format":"int64","nullable":true},"Saldos":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/cc":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_cc","summary":"Conta-corrente fornecedores (agregada)","description":"Áreas necessárias: financeiro, compras. Com StartDate e sem Limit/limite explícito nem filter, a resposta contém lançamentos individuais da conta CC, incluindo documento, moeda, vencimento e valores assinados. Com Limit ou filter, ou sem StartDate, devolve totais por fornecedor. Agregados em moedas distintas têm TotalPendingAmount nulo. A referência não especifica todas as propriedades calculadas do DTO Sage de detalhe. O filtro PartyID recebe o identificador comercial (SupplierID) conforme o exemplo publicado; a listagem devolve também o identificador comum de entidade PartyID.","parameters":[{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","title":"agregada","properties":{"EmailAddress":{"nullable":true},"KeyFederalTaxID":{"type":"string"},"OrganizationName":{"type":"string"},"PartyID":{"type":"number"},"SupplierID":{"type":"number"},"TotalPendingAmount":{"type":"number"},"ZoneID":{"type":"number"}}},{"type":"object","title":"detalhe","properties":{"BalanceCompensationFlag":{"type":"boolean"},"BaseCurrency":{"type":"object","properties":{"BuyExchange":{"type":"number"},"CurrencyID":{"type":"string"},"CurrencyKey":{"nullable":true},"Description":{"nullable":true},"EuroConversionRate":{"type":"number"},"ExchangeDate":{"type":"string"},"FormatMask":{"nullable":true},"ISOCode":{"nullable":true},"Inactive":{"type":"boolean"},"ItsEuroCurrency":{"type":"boolean"},"NegativeFormat":{"nullable":true},"PriceItemDecimalPlaces":{"type":"number"},"RelatedCurrencyID":{"nullable":true},"SaleExchange":{"type":"number"},"Symbol":{"nullable":true},"SymbolPosition":{"nullable":true},"decimalPlaces":{"type":"number"}}},"CashAccountingSchemeType":{"type":"number"},"ComissionAmount":{"type":"number"},"ContractReferenceNumber":{"nullable":true},"CreateDate":{"type":"string"},"CreditTotalAmount":{"type":"number"},"DebitTotalAmount":{"type":"number"},"DeferredPaymentDate":{"type":"string"},"ExchangeDifCurrency":{"nullable":true},"Guid":{"type":"string"},"InternalID":{"type":"number"},"LedgerCounter":{"type":"number"},"OperationID":{"type":"number"},"OriginTransDocNumber":{"type":"number"},"OriginTransDocument":{"nullable":true},"OriginTransSerial":{"nullable":true},"PartyAccountTypeID":{"nullable":true},"PartyAddressID":{"type":"number"},"PartyID":{"type":"number"},"PartyTypeCode":{"type":"number"},"ReconciledFlag":{"type":"boolean"},"RetentionPendingAmount":{"type":"number"},"RetentionStampDutyPending":{"type":"number"},"RetentionStampDutyTotal":{"type":"number"},"RetentionTotalAmount":{"type":"number"},"SalesmanId":{"type":"number"},"SystemEntryDate":{"type":"string"},"TotalAccountSign":{"type":"number"},"TotalAmount":{"type":"number"},"TotalPendingAmount":{"type":"number"},"TransDocNumber":{"type":"number"},"TransDocument":{"type":"string"},"TransInstallmentID":{"type":"number"},"TransSerial":{"type":"string"},"TransStatus":{"type":"number"}}}]}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/sale":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_sale","summary":"Listar documento venda","description":"Áreas necessárias: vendas. Lista ou documento por chave completa. Reconstitui linhas finais e em preparação, selecionando campos públicos persistidos. Campos calculados do SDK, propriedades adicionais por lote e alguns campos de transporte/detalhe não estão reconciliados; dados ausentes dos temporários são nulos. Com a chave completa (TransSerial, TransDocument, TransDocNumber) devolve um objeto ou null.","parameters":[{"name":"TransSerial","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"Details","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"Temp","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"StartDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"ContractReferenceNumber","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"PartyID","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"ATCUD":{"type":"string","nullable":true},"ATDocCodeId":{"type":"string","nullable":true},"ActualDeliveryDate":{"type":"string","nullable":true},"BillToPartyID":{"type":"integer","format":"int64","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"Comments":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"DefaultWarehouse":{"type":"integer","format":"int64","nullable":true},"GlobalCumulativeDiscountPercent1":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent2":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent3":{"type":"number","nullable":true},"GlobalDiscountPercent":{"type":"number","nullable":true},"LineItemsCount":{"type":"integer","format":"int64","nullable":true},"LoadPlaceDateTime":{"type":"string","nullable":true},"LoadPlaceID":{"type":"integer","format":"int64","nullable":true},"PartyAddress1":{"type":"string","nullable":true},"PartyAddress2":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyCountryID":{"type":"string","nullable":true},"PartyFederalTaxID":{"type":"string","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyLocalityID":{"type":"integer","format":"int64","nullable":true},"PartyName":{"type":"string","nullable":true},"PartyPostalCode":{"type":"string","nullable":true},"PartyProvinceID":{"type":"string","nullable":true},"PaymentDiscountPercent1":{"type":"number","nullable":true},"PaymentDiscountPercent2":{"type":"number","nullable":true},"PaymentDiscountPercent3":{"type":"number","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"SystemEntryDate":{"type":"string","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"TillID":{"type":"string","nullable":true},"TotalAdjustmentAmount":{"type":"number","nullable":true},"TotalFreightAmount":{"type":"number","nullable":true},"TotalFreightAmountWithTax":{"type":"number","nullable":true},"TotalGrossAmount":{"type":"number","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransactionConverted":{"type":"boolean","nullable":true},"TransactionTaxIncluded":{"type":"boolean","nullable":true},"UnloadAddressLine1":{"type":"string","nullable":true},"UnloadAddressLine2":{"type":"string","nullable":true},"UnloadPlaceDateTime":{"type":"string","nullable":true},"UnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"UnloadPostalCode":{"type":"string","nullable":true},"ZoneID":{"type":"integer","format":"int64","nullable":true},"Temp":{"type":"boolean","nullable":true},"Details":{"type":"array","items":{},"nullable":true},"ExtraFields":{"type":"array","items":{},"nullable":true}}}},{"type":"object","properties":{"ATCUD":{"type":"string","nullable":true},"ATDocCodeId":{"type":"string","nullable":true},"ActualDeliveryDate":{"type":"string","nullable":true},"BillToPartyID":{"type":"integer","format":"int64","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"Comments":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"DefaultWarehouse":{"type":"integer","format":"int64","nullable":true},"GlobalCumulativeDiscountPercent1":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent2":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent3":{"type":"number","nullable":true},"GlobalDiscountPercent":{"type":"number","nullable":true},"LineItemsCount":{"type":"integer","format":"int64","nullable":true},"LoadPlaceDateTime":{"type":"string","nullable":true},"LoadPlaceID":{"type":"integer","format":"int64","nullable":true},"PartyAddress1":{"type":"string","nullable":true},"PartyAddress2":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyCountryID":{"type":"string","nullable":true},"PartyFederalTaxID":{"type":"string","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyLocalityID":{"type":"integer","format":"int64","nullable":true},"PartyName":{"type":"string","nullable":true},"PartyPostalCode":{"type":"string","nullable":true},"PartyProvinceID":{"type":"string","nullable":true},"PaymentDiscountPercent1":{"type":"number","nullable":true},"PaymentDiscountPercent2":{"type":"number","nullable":true},"PaymentDiscountPercent3":{"type":"number","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"SystemEntryDate":{"type":"string","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"TillID":{"type":"string","nullable":true},"TotalAdjustmentAmount":{"type":"number","nullable":true},"TotalFreightAmount":{"type":"number","nullable":true},"TotalFreightAmountWithTax":{"type":"number","nullable":true},"TotalGrossAmount":{"type":"number","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransactionConverted":{"type":"boolean","nullable":true},"TransactionTaxIncluded":{"type":"boolean","nullable":true},"UnloadAddressLine1":{"type":"string","nullable":true},"UnloadAddressLine2":{"type":"string","nullable":true},"UnloadPlaceDateTime":{"type":"string","nullable":true},"UnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"UnloadPostalCode":{"type":"string","nullable":true},"ZoneID":{"type":"integer","format":"int64","nullable":true},"Temp":{"type":"boolean","nullable":true},"Details":{"type":"array","items":{},"nullable":true},"ExtraFields":{"type":"array","items":{},"nullable":true}},"nullable":true}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/purchase":{"get":{"tags":["Compras"],"operationId":"referencia_documents_purchase","summary":"Documentos de compras","description":"Áreas necessárias: compras. Lista ou documento por chave completa. Reconstitui linhas finais e em preparação, selecionando campos públicos persistidos. Campos calculados do SDK, propriedades adicionais por lote e alguns campos de transporte/detalhe não estão reconciliados; dados ausentes dos temporários são nulos. Com a chave completa (TransSerial, TransDocument, TransDocNumber) devolve um objeto ou null.","parameters":[{"name":"TransSerial","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":false,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"Details","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"Temp","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"NotConverted","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"ATCUD":{"type":"string","nullable":true},"ActualDeliveryDate":{"type":"string","nullable":true},"BillToPartyID":{"type":"integer","format":"int64","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"Comments":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"DefaultWarehouse":{"type":"integer","format":"int64","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"GlobalCumulativeDiscountPercent1":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent2":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent3":{"type":"number","nullable":true},"GlobalDiscountPercent":{"type":"number","nullable":true},"LineItemsCount":{"type":"integer","format":"int64","nullable":true},"LoadPlaceDateTime":{"type":"string","nullable":true},"LoadPlaceID":{"type":"integer","format":"int64","nullable":true},"PartyAddress1":{"type":"string","nullable":true},"PartyAddress2":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyCountryID":{"type":"string","nullable":true},"PartyFederalTaxID":{"type":"string","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyLocalityID":{"type":"integer","format":"int64","nullable":true},"PartyName":{"type":"string","nullable":true},"PartyPostalCode":{"type":"string","nullable":true},"PartyProvinceID":{"type":"string","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"TillID":{"type":"string","nullable":true},"TotalAdjustmentAmount":{"type":"number","nullable":true},"TotalFreightAmount":{"type":"number","nullable":true},"TotalFreightAmountWithTax":{"type":"number","nullable":true},"TotalGrossAmount":{"type":"number","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransactionConverted":{"type":"boolean","nullable":true},"TransactionTaxIncluded":{"type":"boolean","nullable":true},"UnloadAddressLine1":{"type":"string","nullable":true},"UnloadAddressLine2":{"type":"string","nullable":true},"UnloadPlaceDateTime":{"type":"string","nullable":true},"UnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"UnloadPostalCode":{"type":"string","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true},"Temp":{"type":"boolean","nullable":true},"Details":{"type":"array","items":{},"nullable":true},"ExtraFields":{"type":"array","items":{},"nullable":true}}}},{"type":"object","properties":{"ATCUD":{"type":"string","nullable":true},"ActualDeliveryDate":{"type":"string","nullable":true},"BillToPartyID":{"type":"integer","format":"int64","nullable":true},"CarrierID":{"type":"integer","format":"int64","nullable":true},"Comments":{"type":"string","nullable":true},"ContractReferenceNumber":{"type":"string","nullable":true},"CreateDate":{"type":"string","nullable":true},"DefaultWarehouse":{"type":"integer","format":"int64","nullable":true},"DeferredPaymentDate":{"type":"string","nullable":true},"GlobalCumulativeDiscountPercent1":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent2":{"type":"number","nullable":true},"GlobalCumulativeDiscountPercent3":{"type":"number","nullable":true},"GlobalDiscountPercent":{"type":"number","nullable":true},"LineItemsCount":{"type":"integer","format":"int64","nullable":true},"LoadPlaceDateTime":{"type":"string","nullable":true},"LoadPlaceID":{"type":"integer","format":"int64","nullable":true},"PartyAddress1":{"type":"string","nullable":true},"PartyAddress2":{"type":"string","nullable":true},"PartyAddressID":{"type":"integer","format":"int64","nullable":true},"PartyCountryID":{"type":"string","nullable":true},"PartyFederalTaxID":{"type":"string","nullable":true},"PartyID":{"type":"integer","format":"int64","nullable":true},"PartyLocalityID":{"type":"integer","format":"int64","nullable":true},"PartyName":{"type":"string","nullable":true},"PartyPostalCode":{"type":"string","nullable":true},"PartyProvinceID":{"type":"string","nullable":true},"PaymentID":{"type":"integer","format":"int64","nullable":true},"SalesmanID":{"type":"integer","format":"int64","nullable":true},"TenderID":{"type":"integer","format":"int64","nullable":true},"TillID":{"type":"string","nullable":true},"TotalAdjustmentAmount":{"type":"number","nullable":true},"TotalFreightAmount":{"type":"number","nullable":true},"TotalFreightAmountWithTax":{"type":"number","nullable":true},"TotalGrossAmount":{"type":"number","nullable":true},"TotalNetAmount":{"type":"number","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransSerial":{"type":"string","nullable":true},"TransactionConverted":{"type":"boolean","nullable":true},"TransactionTaxIncluded":{"type":"boolean","nullable":true},"UnloadAddressLine1":{"type":"string","nullable":true},"UnloadAddressLine2":{"type":"string","nullable":true},"UnloadPlaceDateTime":{"type":"string","nullable":true},"UnloadPlaceID":{"type":"integer","format":"int64","nullable":true},"UnloadPostalCode":{"type":"string","nullable":true},"WarehouseID":{"type":"integer","format":"int64","nullable":true},"Temp":{"type":"boolean","nullable":true},"Details":{"type":"array","items":{},"nullable":true},"ExtraFields":{"type":"array","items":{},"nullable":true}},"nullable":true}]}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/documents/status":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_status","summary":"Estado do documento","description":"Áreas necessárias: vendas, compras. Estado atual de vendas e compras. Requer ambas as áreas; o catálogo de estados tem rota separada.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"TransSerial":{"type":"string","nullable":true},"TransDocument":{"type":"string","nullable":true},"TransDocNumber":{"type":"integer","format":"int64","nullable":true},"StatusID":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/pendentes":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_pendentes","summary":"Pendentes (alias pendentes)","description":"Áreas necessárias: financeiro, compras. Projeção local de movimentos individuais por entidade. Os dados de licença/identificação do emitente, os montantes por modalidade e a reconciliação com o relatório oficial estão pendentes. TotalAmount agrega pendentes na mesma moeda e fica nulo com moedas distintas. Para paginar Movimentos, use movimentoOffset (0 a 1000000) e movimentoLimite (1 a 200). Sem filtros, a lista conserva todos os movimentos selecionados; extratos grandes podem exigir paginação. O deslocamento e o limite não alteram os totais. No exemplo do fornecedor o filtro partyID recebe a referência comercial SupplierID e o campo PartyID de saída contém o identificador de entidade da ficha.","parameters":[{"name":"partyID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"movimentoOffset","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":1000000}},{"name":"movimentoLimite","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"OrganizationName":{"type":"string","nullable":true},"NIFCliente":{"type":"string","nullable":true},"MoradaCliente":{"type":"string","nullable":true},"Morada2Cliente":{"type":"string","nullable":true},"CPostalCliente":{"type":"string","nullable":true},"Data":{"type":"string","nullable":true},"TotalAmount":{"type":"number","nullable":true},"Movimentos":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/pendentes":{"get":{"tags":["Financeiro"],"operationId":"referencia_pendentes","summary":"Listar documentos pendentes cliente","description":"Áreas necessárias: financeiro, clientes. Projeção local de movimentos individuais por entidade. Os dados de licença/identificação do emitente, os montantes por modalidade e a reconciliação com o relatório oficial estão pendentes. TotalAmount agrega pendentes na mesma moeda e fica nulo com moedas distintas. Para paginar Movimentos, use movimentoOffset (0 a 1000000) e movimentoLimite (1 a 200). Sem filtros, a lista conserva todos os movimentos selecionados; extratos grandes podem exigir paginação. O deslocamento e o limite não alteram os totais.","parameters":[{"name":"partyID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"movimentoOffset","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":1000000}},{"name":"movimentoLimite","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"OrganizationName":{"type":"string","nullable":true},"NIFCliente":{"type":"string","nullable":true},"MoradaCliente":{"type":"string","nullable":true},"Morada2Cliente":{"type":"string","nullable":true},"CPostalCliente":{"type":"string","nullable":true},"Data":{"type":"string","nullable":true},"TotalAmount":{"type":"number","nullable":true},"Movimentos":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/suppliers/extrato":{"get":{"tags":["Financeiro"],"operationId":"referencia_suppliers_extrato","summary":"Extrato fornecedor","description":"Áreas necessárias: financeiro, compras. Projeção local de movimentos individuais por entidade. Os dados de licença/identificação do emitente, os montantes por modalidade e a reconciliação com o relatório oficial estão pendentes. Omite o saldo inicial e TotalAmount, cuja convenção não consta da documentação. Para paginar Movimentos, use movimentoOffset (0 a 1000000) e movimentoLimite (1 a 200). Sem filtros, a lista conserva todos os movimentos selecionados; extratos grandes podem exigir paginação. O deslocamento e o limite não alteram os totais. No exemplo do fornecedor o filtro partyID recebe a referência comercial SupplierID e o campo PartyID de saída contém o identificador de entidade da ficha.","parameters":[{"name":"partyID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"dataInicio","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"movimentoOffset","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":1000000}},{"name":"movimentoLimite","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"OrganizationName":{"type":"string","nullable":true},"NIFCliente":{"type":"string","nullable":true},"MoradaCliente":{"type":"string","nullable":true},"Morada2Cliente":{"type":"string","nullable":true},"CPostalCliente":{"type":"string","nullable":true},"Data":{"type":"string","nullable":true},"Movimentos":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/extrato":{"get":{"tags":["Financeiro"],"operationId":"referencia_extrato","summary":"Listar extrato cliente","description":"Áreas necessárias: financeiro, clientes. Projeção local de movimentos individuais por entidade. Os dados de licença/identificação do emitente, os montantes por modalidade e a reconciliação com o relatório oficial estão pendentes. Omite o saldo inicial e TotalAmount, cuja convenção não consta da documentação. Para paginar Movimentos, use movimentoOffset (0 a 1000000) e movimentoLimite (1 a 200). Sem filtros, a lista conserva todos os movimentos selecionados; extratos grandes podem exigir paginação. O deslocamento e o limite não alteram os totais.","parameters":[{"name":"partyID","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"dataInicio","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"movimentoOffset","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":1000000}},{"name":"movimentoLimite","in":"query","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"PartyID":{"type":"integer","format":"int64","nullable":true},"OrganizationName":{"type":"string","nullable":true},"NIFCliente":{"type":"string","nullable":true},"MoradaCliente":{"type":"string","nullable":true},"Morada2Cliente":{"type":"string","nullable":true},"CPostalCliente":{"type":"string","nullable":true},"Data":{"type":"string","nullable":true},"Movimentos":{"type":"array","items":{},"nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/checkDocument":{"get":{"tags":["Vendas"],"operationId":"referencia_checkdocument","summary":"Verificar documento","description":"Áreas necessárias: vendas, compras, stocks, financeiro. Consulta a existência da chave nas cinco famílias finais e devolve um booleano. A referência não especifica o formato do resultado ou a inclusão de temporários.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string","maxLength":256}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"boolean","nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/SystemSettings":{"get":{"tags":["Financeiro"],"operationId":"referencia_systemsettings","summary":"SystemSettings","description":"Áreas necessárias: financeiro. Configuração monetária e fiscal da empresa. A projeção local devolve BaseCurrency, DefaultCountryID, DefaultLanguageID e TaxRegionID. Requer a área financeiro. O fornecedor não publica um esquema para esta operação.","parameters":[],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"BaseCurrency":{"type":"string","nullable":true},"DefaultCountryID":{"type":"string","nullable":true},"DefaultLanguageID":{"type":"string","nullable":true},"TaxRegionID":{"type":"string","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/test":{"get":{"tags":["Artigos"],"operationId":"referencia_test","summary":"Test Webservice","description":"Áreas necessárias: artigos. Diagnóstico local da chave de catálogo e da ligação à fonte da empresa. Uma consulta concluída devolve {\"ok\":true}. Requer a área artigos.","parameters":[],"responses":{"200":{"description":"Consulta de leitura concluída.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","nullable":true}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/version":{"get":{"operationId":"referencia_version","tags":["Serviço"],"summary":"Versão do gateway","description":"Qualquer chave de consumidor válida pode consultar a versão deste gateway, inclusive quando o agente da empresa está offline. Se a instalação usa o catálogo de assinaturas, a assinatura deve estar ativa. O valor é a versão de release, a versão Go do módulo, uma revisão de desenvolvimento ou desenvolvimento se o binário não contiver metadados de versão.","parameters":[],"responses":{"200":{"description":"Identificador de versão do gateway.","content":{"application/json":{"schema":{"type":"string"},"example":"v1.2.0"}}},"400":{"description":"Pedido contém parâmetros ou corpo."},"401":{"description":"Chave de consumidor inválida."},"403":{"description":"Assinatura inativa."},"405":{"description":"Método não permitido."},"503":{"description":"Catálogo de credenciais ou assinaturas indisponível."}}}},"/api/v1/SageVersion":{"get":{"operationId":"referencia_sageversion","tags":["Artigos"],"summary":"Versão da instalação Sage 50c","description":"Requer a área artigos. Em fonte SQL Server, lê ProductVersion do executável Sage associado pelo operador à instalação desta empresa. Uma instalação sem executável configurado ou válido devolve 503. Empresas com fonte sintética devolvem a respetiva amostra.","parameters":[],"responses":{"200":{"description":"Versão do produto instalada no posto da empresa.","content":{"application/json":{"schema":{"type":"string"},"example":"2026.03.0001"}}},"400":{"description":"Pedido contém parâmetros ou corpo."},"401":{"description":"Credencial inválida."},"403":{"description":"Área sem permissão ou assinatura inativa."},"405":{"description":"Método não permitido."},"503":{"description":"Agente, instalação do produto ou catálogo indisponível."}}}},"/api/v1/documents/excel":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_excel","summary":"Exportar um documento para Excel","description":"Gera em memória um livro XLSX com o cabeçalho, totais, linhas e sublinhas do documento de venda, compra ou stock. A chave documental é obrigatória. Devolve o livro em base64 ou null se a chave não existir nessas famílias. A projeção local permite até 10.000 linhas, 32.767 unidades UTF-16 por célula, 16 MiB de XML e o limite do canal de 2 MiB para a resposta. Requer as áreas vendas, compras, stocks.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string"}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string"}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64","minimum":1}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"byte"}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros. Na fonte real, o ficheiro excede o limite permitido."}}}},"/api/v1/documents/pdf":{"get":{"tags":["Vendas"],"operationId":"referencia_documents_pdf","summary":"Ler o PDF fiscal arquivado","description":"Reproduz os bytes do PDF fiscal de uma venda guardada no arquivo EInvoiceSales desta empresa. O PDF conserva o layout e as vias existentes à data do arquivo. Até 1 MiB. Uma chave sem um único arquivo fiscal elegível devolve null. Aceita apenas a chave documental e, opcionalmente, Print=false. Requer as áreas vendas, clientes, financeiro.","parameters":[{"name":"TransSerial","in":"query","required":true,"schema":{"type":"string"}},{"name":"TransDocument","in":"query","required":true,"schema":{"type":"string"}},{"name":"TransDocNumber","in":"query","required":true,"schema":{"type":"integer","format":"int64","minimum":1}},{"name":"Print","in":"query","required":false,"schema":{"type":"boolean","enum":[false]}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"byte"}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."},"413":{"description":"O conteúdo excede o limite do ficheiro ou da resposta."}}}},"/api/v1/products/{ItemID}/image":{"get":{"tags":["Artigos"],"operationId":"referencia_products_image","summary":"Imagem do artigo","description":"Lê a imagem indicada na ficha a partir do diretório exclusivo da empresa configurado no agente. Aceita JPEG, PNG e GIF até 1 MiB e devolve os bytes em base64. Com barcodes=true inclui os códigos de barras. A lista fica vazia se a imagem estiver ausente. Requer as áreas artigos.","parameters":[{"name":"ItemID","in":"path","required":true,"schema":{"type":"string"}},{"name":"barcodes","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["ItemID","ContentType","Image"],"properties":{"ItemID":{"type":"string"},"ContentType":{"type":"string"},"Image":{"type":"string","format":"byte"},"BarCodes":{"type":"array","items":{"type":"object","required":["Barcode"],"properties":{"Barcode":{"type":"string"}}}}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."},"413":{"description":"O conteúdo excede o limite do ficheiro ou da resposta."}}}},"/api/v1/products/archives":{"get":{"tags":["Artigos"],"operationId":"referencia_products_archives","summary":"Anexos públicos do artigo","description":"Lista metadados dos ficheiros guardados no arquivo SQL de artigos da empresa e associados à referência ItemID. Ordena por data de arquivo e GUID. Exclui anexos pessoais e conteúdos de outros arquivos. Requer as áreas artigos.","parameters":[{"name":"ItemID","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["ItemID","ArchiveGuid","DocDate","StoreDate","DocSize"],"properties":{"ItemID":{"type":"string"},"ArchiveGuid":{"type":"string","format":"uuid"},"DocDate":{"type":"string","nullable":true},"StoreDate":{"type":"string","nullable":true},"DocSize":{"type":"integer","format":"int64","nullable":true}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/products/archives/{archiveGuid}":{"get":{"tags":["Artigos"],"operationId":"referencia_products_archives_guid","summary":"Conteúdo do anexo de artigo","description":"Devolve o conteúdo em base64 até 1 MiB. O GUID tem de pertencer a um artigo da empresa no contentor público de artigos. Pode confirmar o vínculo indicando também ItemID. Um GUID ausente ou alheio devolve null. Requer as áreas artigos.","parameters":[{"name":"archiveGuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ItemID","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"object","required":["ItemID","ArchiveGuid","Size","file"],"properties":{"ItemID":{"type":"string"},"ArchiveGuid":{"type":"string","format":"uuid"},"Size":{"type":"integer","format":"int64"},"file":{"type":"string","format":"byte"}},"nullable":true}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."},"413":{"description":"O conteúdo excede o limite do ficheiro ou da resposta."}}}},"/api/v1/SystemSettings/Application":{"get":{"tags":["Financeiro"],"operationId":"referencia_systemsettings_application","summary":"Application da instalação Sage","description":"Área necessária: financeiro. Nome e versão do produto nos recursos PE do executável Sage configurado pela empresa com source.sage_executable. Requer instalação Windows; a fonte sintética tem amostra própria.","parameters":[],"responses":{"200":{"description":"Configuração consultada.","content":{"application/json":{"schema":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Version":{"type":"string","nullable":true}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/SystemSettings/SystemInfo":{"get":{"tags":["Financeiro"],"operationId":"referencia_systemsettings_systeminfo","summary":"SystemInfo da instalação Sage","description":"Área necessária: financeiro. Definições comerciais e de stock da própria empresa. Os nomes correspondem a propriedades de SystemSettings.SystemInfo disponíveis na instalação do Sage.","parameters":[],"responses":{"200":{"description":"Configuração consultada.","content":{"application/json":{"schema":{"type":"object","properties":{"TaxRegionID":{"type":"string","nullable":true},"DefaultCustomerID":{"type":"integer","nullable":true},"UnloadPlaceType":{"type":"integer","nullable":true},"UseCompositeItems":{"type":"boolean","nullable":true},"UseUnitOfMeasureItems":{"type":"boolean","nullable":true},"UseOffLineMode":{"type":"boolean","nullable":true},"UseColorSizeItems":{"type":"boolean","nullable":true},"UsePropertyItems":{"type":"boolean","nullable":true},"ClosureDay":{"type":"string","nullable":true}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/SystemSettings/WorkstationInfo":{"get":{"tags":["Financeiro"],"operationId":"referencia_systemsettings_workstationinfo","summary":"WorkstationInfo da instalação Sage","description":"Área necessária: financeiro. Definições do posto ativo que o operador associa à instalação desta empresa por source.sage_workstation_id. A configuração em falta ou um posto inativo/inexistente devolvem 503.","parameters":[],"responses":{"200":{"description":"Configuração consultada.","content":{"application/json":{"schema":{"type":"object","properties":{"WorkstationID":{"type":"integer","nullable":true},"Active":{"type":"boolean","nullable":true},"DefaultTransDocument":{"type":"string","nullable":true},"DefaultTransSerial":{"type":"string","nullable":true},"DefaultMainTillID":{"type":"string","nullable":true},"DefaultTillID":{"type":"string","nullable":true}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"$ref":"#/components/responses/SemCredencial"},"403":{"$ref":"#/components/responses/SemAcesso"},"429":{"$ref":"#/components/responses/AgenteOcupado"},"502":{"$ref":"#/components/responses/RespostaInvalida"},"503":{"$ref":"#/components/responses/Indisponivel"},"504":{"$ref":"#/components/responses/PrazoExcedido"},"422":{"description":"Na empresa sintética, não existe amostra para a combinação de filtros."}}}},"/api/v1/log":{"get":{"tags":["Serviço"],"operationId":"referencia_log","summary":"Consultas recentes do consumidor","description":"Lista os GET encaminhados ao agente e concluídos com sucesso por esta empresa e esta chave, começando pelo mais recente. Mostra a data UTC e o caminho público. O gateway guarda em memória os últimos 1.024 eventos entre todas as empresas enquanto o processo estiver ativo. Só são visíveis as consultas abrangidas pelas permissões atuais. O filtro name aceita o nome do recurso (por exemplo SaleDocuments ou PurchaseDocuments). data usa o dia em UTC.","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"data","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000001}}],"responses":{"200":{"description":"Consulta concluída.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","path","at"],"properties":{"name":{"type":"string"},"path":{"type":"string"},"at":{"type":"string","format":"date-time"}}}}}}},"400":{"$ref":"#/components/responses/PedidoInvalido"},"401":{"description":"Chave de consumidor inválida."},"403":{"description":"Assinatura inativa."},"405":{"description":"Método não permitido."},"503":{"description":"Catálogo de credenciais ou assinaturas indisponível."}}}}},"components":{"securitySchemes":{"ChaveDeLeitura":{"type":"http","scheme":"bearer","description":"Chave opaca emitida pelo painel. Envie um único cabeçalho `Authorization: Bearer <chave>`. A chave identifica a empresa e as áreas permitidas."}},"parameters":{"Artigo":{"name":"artigo","in":"query","required":false,"description":"Filtra pela referência exata do artigo. Omita o parâmetro para paginar o catálogo. A referência deve conter texto, estar em UTF-8 e ocupar até 25 unidades UTF-16. Caracteres de controlo são rejeitados.","schema":{"type":"string","minLength":1,"maxLength":25},"example":"PILOTO-001"},"Offset":{"name":"offset","in":"query","required":false,"description":"Número de linhas a saltar a partir do início, em algarismos decimais.","schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},"Limite":{"name":"limite","in":"query","required":false,"description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},"Inicio":{"name":"inicio","in":"query","required":true,"description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","schema":{"type":"string","format":"date"},"example":"2026-09-01"},"FimExclusivo":{"name":"fimExclusivo","in":"query","required":true,"description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","schema":{"type":"string","format":"date"},"example":"2026-10-01"},"Cliente":{"name":"cliente","in":"query","required":true,"description":"Identificador comercial CustomerID, em algarismos decimais. Use a listagem de clientes para encontrar o identificador.","schema":{"type":"integer","format":"int64","minimum":1,"maximum":9223372036854775807},"example":1}},"schemas":{"Artigo":{"type":"object","description":"Ficha de um artigo. Os campos sem valor são apresentados como null.","required":["ItemID","Description","ShortDescription","ItemType","FamilyID","BarCode","Discontinued","StockManagement","UnitOfSaleID","DefaultStockUnit","DefaultSellingUnit","UnitConversion","CurrencyID","CurrencyFactor","CurrencyExchange","AverageCostPrice","AverageCostStockValue","LastCostStockValue"],"properties":{"ItemID":{"type":"string","description":"Referência do artigo."},"Description":{"type":"string","description":"Designação em português (idioma PTG).","nullable":true},"ShortDescription":{"type":"string","description":"Designação abreviada em português (PTG).","nullable":true},"ItemType":{"type":"integer","description":"Código do tipo de artigo registado no Sage."},"FamilyID":{"type":"integer","description":"Identificador da família.","format":"int64"},"BarCode":{"type":"string","description":"Código de barras com eventuais zeros à esquerda.","nullable":true},"Discontinued":{"type":"boolean","description":"Indica se o artigo foi descontinuado."},"StockManagement":{"type":"boolean","description":"Indica se o artigo está sujeito a gestão de stock."},"UnitOfSaleID":{"type":"string","description":"Identificador da unidade de venda."},"DefaultStockUnit":{"type":"string","description":"Unidade de stock predefinida."},"DefaultSellingUnit":{"type":"string","description":"Unidade de venda predefinida."},"UnitConversion":{"type":"number","description":"Fator de conversão de unidades registado na ficha.","nullable":true},"CurrencyID":{"type":"string","description":"Código de moeda da ficha."},"CurrencyFactor":{"type":"number","description":"Fator da moeda da ficha.","nullable":true},"CurrencyExchange":{"type":"number","description":"Câmbio registado na ficha.","nullable":true},"AverageCostPrice":{"type":"number","description":"Preço de custo médio do artigo.","nullable":true},"AverageCostStockValue":{"type":"number","description":"Valor do stock ao custo médio.","nullable":true},"LastCostStockValue":{"type":"number","description":"Valor do stock ao último custo.","nullable":true}}},"Rotacao":{"type":"object","description":"Indicador por artigo. Quando Estado difere de ok, as três medidas são null. Com Estado ok, zero unidades vendidas produzem rotação zero.","required":["ItemID","DefaultStockUnit","Estado","UnidadesSaidasVenda","StockMedioUnidades","RotacaoPeriodo"],"properties":{"ItemID":{"type":"string","description":"Referência do artigo."},"DefaultStockUnit":{"type":"string","description":"Unidade de stock predefinida."},"Estado":{"type":"string","description":"`ok` indica cálculo válido. `fim_sem_cobertura` indica que falta histórico até ao fim do período. `sem_saldo_anterior` indica que falta o saldo de abertura. `historico_nao_conciliado` assinala movimentos inconsistentes. `saldo_atual_nao_conciliado` indica que o saldo final do histórico e o stock físico atual não foram conciliados. `saldo_medio_inadequado` indica que os saldos são inválidos ou a média é nula ou negativa.","enum":["ok","fim_sem_cobertura","sem_saldo_anterior","historico_nao_conciliado","saldo_atual_nao_conciliado","saldo_medio_inadequado"]},"UnidadesSaidasVenda":{"type":"number","description":"Unidades de saída associadas a documentos de venda definitivos durante o período.","nullable":true},"StockMedioUnidades":{"type":"number","description":"Média do stock físico em unidades, ponderada pelos dias em que cada saldo de fecho esteve em vigor.","nullable":true},"RotacaoPeriodo":{"type":"number","description":"Unidades de saída de venda divididas pelo stock médio. Razão adimensional calculada para o período pedido.","nullable":true}}},"PaginaArtigos":{"type":"object","required":["offset","limite","dados"],"properties":{"offset":{"type":"integer","description":"Deslocamento pedido.","minimum":0,"maximum":1000000},"limite":{"type":"integer","description":"Tamanho máximo da página pedido.","minimum":1,"maximum":200},"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Artigo"}}}},"PaginaRotacao":{"type":"object","required":["offset","limite","dados"],"properties":{"offset":{"type":"integer","description":"Deslocamento pedido.","minimum":0,"maximum":1000000},"limite":{"type":"integer","description":"Tamanho máximo da página pedido.","minimum":1,"maximum":200},"dados":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/Rotacao"}}}},"Liquidacao":{"type":"object","required":["TransSerial","TransDocument","TransDocNumber","CreateDate","EffectivePaymentDate","TransStatus","DocSerial","DocID","DocNumber","DocInstallmentID","TotalPayedAmount","TotalDiscountAmount","CurrencyID","DocCurrencyID"],"properties":{"TransSerial":{"type":"string","maxLength":10},"TransDocument":{"type":"string","maxLength":10},"TransDocNumber":{"type":"integer","format":"int64"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"EffectivePaymentDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true},"TransStatus":{"type":"integer","format":"int32"},"DocSerial":{"type":"string","maxLength":10},"DocID":{"type":"string","maxLength":10},"DocNumber":{"type":"integer","format":"int64"},"DocInstallmentID":{"type":"integer","format":"int32"},"TotalPayedAmount":{"type":"number"},"TotalDiscountAmount":{"type":"number"},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"DocCurrencyID":{"type":"string","maxLength":3}}},"Paginacao":{"type":"object","required":["offset","limite"],"properties":{"offset":{"type":"integer","description":"Deslocamento pedido.","minimum":0,"maximum":1000000},"limite":{"type":"integer","description":"Tamanho máximo da página pedido.","minimum":1,"maximum":200}}},"Preco":{"type":"object","required":["ItemID","LotID","SizeID","ColorID","PriceUnitID","PriceLineID","PriceLineDescription","CreateDate","UnitPrice","TaxIncludedPrice","CurrencyID","CurrencyFactor","CurrencyExchange","FixedProfitRate","DiscountPercent","ExcludesGlobalDiscount"],"properties":{"ItemID":{"type":"string","maxLength":25,"example":"PILOTO-001"},"LotID":{"type":"string","maxLength":5,"example":""},"SizeID":{"type":"integer","format":"int32"},"ColorID":{"type":"integer","format":"int32"},"PriceUnitID":{"type":"string","maxLength":3,"example":"UN"},"PriceLineID":{"type":"integer","format":"int32","example":1},"PriceLineDescription":{"type":"string","maxLength":255,"nullable":true,"example":"Preço de tabela"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"UnitPrice":{"type":"number","example":20},"TaxIncludedPrice":{"type":"number","example":24.6},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"CurrencyFactor":{"type":"number","example":1},"CurrencyExchange":{"type":"number","example":1},"FixedProfitRate":{"type":"number"},"DiscountPercent":{"type":"number"},"ExcludesGlobalDiscount":{"type":"boolean"}}},"Stock":{"type":"object","required":["ItemID","LotID","ColorID","SizeID","WarehouseID","WarehouseDescription","BinLocation","PhysicalQty","AvailableQty","PhysicalUnits","AvailableUnits","CustomerOrderQty","SupplierOrderQty","CustomerConsignmentQty","SupplierConsignmentQty","ReorderPoint","RestockLevel","LastCostPrice","TaxIncludedLastCostPrice","AverageCostStockValue","LastCostStockValue","CurrencyID","CurrencyFactor","CurrencyExchange"],"properties":{"ItemID":{"type":"string","maxLength":25,"example":"PILOTO-001"},"LotID":{"type":"string","maxLength":5,"example":""},"ColorID":{"type":"integer","format":"int32"},"SizeID":{"type":"integer","format":"int32"},"WarehouseID":{"type":"integer","format":"int32","example":1},"WarehouseDescription":{"type":"string","maxLength":255,"nullable":true,"example":"Armazém de demonstração"},"BinLocation":{"type":"string","maxLength":255,"example":"A-01"},"PhysicalQty":{"type":"number","example":18},"AvailableQty":{"type":"number","example":15},"PhysicalUnits":{"type":"number","example":18},"AvailableUnits":{"type":"number","example":15},"CustomerOrderQty":{"type":"number","example":3},"SupplierOrderQty":{"type":"number"},"CustomerConsignmentQty":{"type":"number"},"SupplierConsignmentQty":{"type":"number"},"ReorderPoint":{"type":"number"},"RestockLevel":{"type":"number"},"LastCostPrice":{"type":"number"},"TaxIncludedLastCostPrice":{"type":"number"},"AverageCostStockValue":{"type":"number"},"LastCostStockValue":{"type":"number"},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"CurrencyFactor":{"type":"number","example":1},"CurrencyExchange":{"type":"number","example":1}}},"MovimentoStock":{"type":"object","required":["StockGuid","ActualDeliveryDate","CreateDate","ItemID","LotID","ColorID","SizeID","WarehouseID","TransSerial","TransDocument","TransDocNumber","LineItemID","LineItemSubID","OperationID","Quantity","UnitOfMeasure","UnitConversion","StockUnits","PhysicalQtyRule","StatementQuantityReceived","StatementQuantityOutgoing","StatementQuantityBalance","StatementUnitsReceived","StatementUnitsOutgoing","StatementUnitsBalance","StatementAverageCostPrice","StatementLastCostPrice","CostComputed","CurrencyID"],"properties":{"StockGuid":{"type":"string","maxLength":40,"example":"70f0e612-0c12-4ff3-aea2-d8dc8b81314e"},"ActualDeliveryDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","example":"2026-09-14T00:00:00"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"ItemID":{"type":"string","maxLength":25,"example":"PILOTO-001"},"LotID":{"type":"string","maxLength":5,"example":""},"ColorID":{"type":"integer","format":"int32"},"SizeID":{"type":"integer","format":"int32"},"WarehouseID":{"type":"integer","format":"int32","example":1},"TransSerial":{"type":"string","maxLength":10},"TransDocument":{"type":"string","maxLength":10},"TransDocNumber":{"type":"integer","format":"int64"},"LineItemID":{"type":"integer","format":"int64"},"LineItemSubID":{"type":"integer","format":"int32"},"OperationID":{"type":"integer","format":"int32"},"Quantity":{"type":"number"},"UnitOfMeasure":{"type":"string","maxLength":3},"UnitConversion":{"type":"number"},"StockUnits":{"type":"number"},"PhysicalQtyRule":{"type":"integer","format":"int32"},"StatementQuantityReceived":{"type":"number"},"StatementQuantityOutgoing":{"type":"number"},"StatementQuantityBalance":{"type":"number"},"StatementUnitsReceived":{"type":"number"},"StatementUnitsOutgoing":{"type":"number"},"StatementUnitsBalance":{"type":"number"},"StatementAverageCostPrice":{"type":"number"},"StatementLastCostPrice":{"type":"number"},"CostComputed":{"type":"boolean"},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"}}},"VendaMensal":{"type":"object","required":["mes","moeda","tipo_documento","sinal_mapa","documentos","faturacao_sem_imposto","imposto","total_documentos"],"properties":{"mes":{"type":"string","description":"Primeiro dia do mês, à meia-noite no calendário do Sage.","example":"2026-09-01T00:00:00","nullable":true},"moeda":{"type":"string","maxLength":3,"example":"EUR"},"tipo_documento":{"type":"string","maxLength":10},"sinal_mapa":{"type":"integer","format":"int32","nullable":true,"example":1},"documentos":{"type":"integer","format":"int64","nullable":true},"faturacao_sem_imposto":{"type":"number","nullable":true},"imposto":{"type":"number","nullable":true},"total_documentos":{"type":"number","nullable":true}}},"DocumentoVenda":{"type":"object","required":["serie","tipo_documento","numero","data_emissao","cliente_documento_id","moeda","sinal_mapa","estado_codigo","anulado","base_sem_imposto","imposto","total_documento"],"properties":{"serie":{"type":"string","maxLength":10},"tipo_documento":{"type":"string","maxLength":10},"numero":{"type":"integer","format":"int64"},"data_emissao":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"cliente_documento_id":{"type":"integer","format":"int64"},"moeda":{"type":"string","maxLength":3,"example":"EUR"},"sinal_mapa":{"type":"integer","format":"int32","nullable":true,"example":1},"estado_codigo":{"type":"integer","format":"int32"},"anulado":{"type":"boolean","nullable":true},"base_sem_imposto":{"type":"number","nullable":true},"imposto":{"type":"number","nullable":true},"total_documento":{"type":"number","nullable":true}}},"Margem":{"type":"object","required":["artigo","moeda","cobertura","linhas","receita_linhas_sem_imposto","custo_medio_historico","margem_valor","margem_percentual"],"properties":{"artigo":{"type":"string","maxLength":25,"example":"PILOTO-001"},"moeda":{"type":"string","maxLength":3,"example":"EUR"},"cobertura":{"type":"string","maxLength":30,"enum":["apurada","tipo_sem_custo_validado","moeda_sem_conversao_validada","unidade_sem_conversao_validada","custo_ausente_ou_nao_positivo","receita_ausente"]},"linhas":{"type":"integer","format":"int64","nullable":true},"receita_linhas_sem_imposto":{"type":"number","nullable":true},"custo_medio_historico":{"type":"number","nullable":true},"margem_valor":{"type":"number","nullable":true},"margem_percentual":{"type":"number","nullable":true}}},"CompraMensal":{"type":"object","required":["mes","moeda","tipo_documento","fornecedor_documento_id","sinal_mapa","documentos","compras_sem_imposto","imposto","total_documentos"],"properties":{"mes":{"type":"string","description":"Primeiro dia do mês, à meia-noite no calendário do Sage.","example":"2026-09-01T00:00:00","nullable":true},"moeda":{"type":"string","maxLength":3,"example":"EUR"},"tipo_documento":{"type":"string","maxLength":10},"fornecedor_documento_id":{"type":"integer","format":"int64"},"sinal_mapa":{"type":"integer","format":"int32","nullable":true,"example":1},"documentos":{"type":"integer","format":"int64","nullable":true},"compras_sem_imposto":{"type":"number","nullable":true},"imposto":{"type":"number","nullable":true},"total_documentos":{"type":"number","nullable":true}}},"DocumentoCompra":{"type":"object","required":["serie","tipo_documento","numero","data_emissao","fornecedor_documento_id","moeda","sinal_mapa","estado_codigo","anulado","base_sem_imposto","imposto","total_documento"],"properties":{"serie":{"type":"string","maxLength":10},"tipo_documento":{"type":"string","maxLength":10},"numero":{"type":"integer","format":"int64"},"data_emissao":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"fornecedor_documento_id":{"type":"integer","format":"int64"},"moeda":{"type":"string","maxLength":3,"example":"EUR"},"sinal_mapa":{"type":"integer","format":"int32","nullable":true,"example":1},"estado_codigo":{"type":"integer","format":"int32"},"anulado":{"type":"boolean","nullable":true},"base_sem_imposto":{"type":"number","nullable":true},"imposto":{"type":"number","nullable":true},"total_documento":{"type":"number","nullable":true}}},"Fornecedor":{"type":"object","required":["fornecedor_id","entidade_id","nome","ativo","bloqueado"],"properties":{"fornecedor_id":{"type":"integer","format":"int64"},"entidade_id":{"type":"integer","format":"int64"},"nome":{"type":"string","maxLength":255},"ativo":{"type":"boolean"},"bloqueado":{"type":"boolean"}}},"Cliente":{"type":"object","required":["CustomerID","PartyID","OrganizationName","ActiveParty","Locked","CreateDate","DtAlt","PaymentID","TenderID","PriceLineID","SalesmanID","ZoneID"],"properties":{"CustomerID":{"type":"integer","format":"int64","example":1},"PartyID":{"type":"integer","format":"int64"},"OrganizationName":{"type":"string","maxLength":255,"example":"Cliente de demonstração"},"ActiveParty":{"type":"boolean"},"Locked":{"type":"boolean"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"DtAlt":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário."},"PaymentID":{"type":"integer","format":"int32"},"TenderID":{"type":"integer","format":"int32"},"PriceLineID":{"type":"integer","format":"int32","example":1},"SalesmanID":{"type":"integer","format":"int64"},"ZoneID":{"type":"integer","format":"int32"}}},"EventoCliente":{"type":"object","required":["TipoEvento","CreateDate","TransSerial","TransDocument","TransDocNumber","CustomerID","TransStatus","CurrentStatusID","CurrencyID","TotalDocumento","TransactionConverted","LineItemID","LineItemSubID","ItemID","ItemType","DescricaoLinha","UnitOfSaleID","Quantity","UnitPrice","TotalLiquidoLinha","ImpostoLinha","TotalLinha"],"properties":{"TipoEvento":{"type":"string","maxLength":24,"enum":["linha_venda","venda_sem_linha","documento_conta_corrente"]},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"TransSerial":{"type":"string","maxLength":10},"TransDocument":{"type":"string","maxLength":10},"TransDocNumber":{"type":"integer","format":"int64"},"CustomerID":{"type":"integer","format":"int64","example":1},"TransStatus":{"type":"integer","format":"int32"},"CurrentStatusID":{"type":"string","maxLength":20,"nullable":true},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"TotalDocumento":{"type":"number"},"TransactionConverted":{"type":"boolean","nullable":true},"LineItemID":{"type":"integer","format":"int64","nullable":true},"LineItemSubID":{"type":"integer","format":"int32","nullable":true},"ItemID":{"type":"string","maxLength":25,"nullable":true,"example":"PILOTO-001"},"ItemType":{"type":"integer","format":"int32","nullable":true},"DescricaoLinha":{"type":"string","maxLength":255,"nullable":true},"UnitOfSaleID":{"type":"string","maxLength":3,"nullable":true},"Quantity":{"type":"number","nullable":true},"UnitPrice":{"type":"number","nullable":true,"example":20},"TotalLiquidoLinha":{"type":"number","nullable":true},"ImpostoLinha":{"type":"number","nullable":true},"TotalLinha":{"type":"number","nullable":true}}},"LancamentoCliente":{"type":"object","required":["LedgerGuid","CustomerID","PartyAccountTypeID","TransSerial","TransDocument","TransDocNumber","TransInstallmentID","CreateDate","DeferredPaymentDate","CurrencyID","CurrencyExchange","CurrencyFactor","TotalAmount","DebitTotalAmount","CreditTotalAmount","TotalPendingAmount","TotalAccountSign","BalanceAmount","BalanceAccountSign","TransStatus","ReconciledFlag","OriginTransSerial","OriginTransDocument","OriginTransDocNumber","TotalLiquidacoes","Liquidacoes"],"properties":{"LedgerGuid":{"type":"string","maxLength":40},"CustomerID":{"type":"integer","format":"int64","example":1},"PartyAccountTypeID":{"type":"string","maxLength":10},"TransSerial":{"type":"string","maxLength":10},"TransDocument":{"type":"string","maxLength":10},"TransDocNumber":{"type":"integer","format":"int64"},"TransInstallmentID":{"type":"integer","format":"int32"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"DeferredPaymentDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"CurrencyExchange":{"type":"number","example":1},"CurrencyFactor":{"type":"number","example":1},"TotalAmount":{"type":"number"},"DebitTotalAmount":{"type":"number"},"CreditTotalAmount":{"type":"number"},"TotalPendingAmount":{"type":"number"},"TotalAccountSign":{"type":"integer","format":"int32"},"BalanceAmount":{"type":"number"},"BalanceAccountSign":{"type":"integer","format":"int32"},"TransStatus":{"type":"integer","format":"int32"},"ReconciledFlag":{"type":"boolean"},"OriginTransSerial":{"type":"string","maxLength":10},"OriginTransDocument":{"type":"string","maxLength":10},"OriginTransDocNumber":{"type":"integer","format":"int64"},"TotalLiquidacoes":{"type":"integer","format":"int64","nullable":true},"Liquidacoes":{"type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/Liquidacao"},"description":"Até 20 liquidações, começando pelas mais recentes. A lista vazia indica que não existem vínculos."}}},"LancamentoFornecedor":{"type":"object","required":["LedgerGuid","SupplierID","PartyAccountTypeID","TransSerial","TransDocument","TransDocNumber","TransInstallmentID","CreateDate","DeferredPaymentDate","CurrencyID","CurrencyExchange","CurrencyFactor","TotalAmount","DebitTotalAmount","CreditTotalAmount","TotalPendingAmount","TotalAccountSign","BalanceAmount","BalanceAccountSign","TransStatus","ReconciledFlag","OriginTransSerial","OriginTransDocument","OriginTransDocNumber","TotalLiquidacoes","Liquidacoes"],"properties":{"LedgerGuid":{"type":"string","maxLength":40},"SupplierID":{"type":"integer","format":"int64","example":2},"PartyAccountTypeID":{"type":"string","maxLength":10},"TransSerial":{"type":"string","maxLength":10},"TransDocument":{"type":"string","maxLength":10},"TransDocNumber":{"type":"integer","format":"int64"},"TransInstallmentID":{"type":"integer","format":"int32"},"CreateDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true,"example":"2026-09-14T10:30:00"},"DeferredPaymentDate":{"type":"string","description":"Data e hora do Sage em ISO 8601, sem fuso horário.","nullable":true},"CurrencyID":{"type":"string","maxLength":3,"example":"EUR"},"CurrencyExchange":{"type":"number","example":1},"CurrencyFactor":{"type":"number","example":1},"TotalAmount":{"type":"number"},"DebitTotalAmount":{"type":"number"},"CreditTotalAmount":{"type":"number"},"TotalPendingAmount":{"type":"number"},"TotalAccountSign":{"type":"integer","format":"int32"},"BalanceAmount":{"type":"number"},"BalanceAccountSign":{"type":"integer","format":"int32"},"TransStatus":{"type":"integer","format":"int32"},"ReconciledFlag":{"type":"boolean"},"OriginTransSerial":{"type":"string","maxLength":10},"OriginTransDocument":{"type":"string","maxLength":10},"OriginTransDocNumber":{"type":"integer","format":"int64"},"TotalLiquidacoes":{"type":"integer","format":"int64","nullable":true},"Liquidacoes":{"type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/Liquidacao"},"description":"Até 20 liquidações, começando pelas mais recentes. A lista vazia indica que não existem vínculos."}}}},"responses":{"PedidoInvalido":{"description":"Corpo ou codificação da query inválidos (`pedido_invalido`), ou parâmetros desconhecidos, repetidos, vazios ou fora dos limites (`filtros_invalidos`).","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["filtros_invalidos","pedido_invalido"]}}},"example":{"erro":"filtros_invalidos"}}}},"SemCredencial":{"description":"Envie uma chave de consumidor válida no cabeçalho Authorization. Uma chave ausente, desconhecida, malformada ou revogada produz este estado.","headers":{"WWW-Authenticate":{"description":"Esquema de autenticação aceite.","schema":{"type":"string","enum":["Bearer"]}}},"content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["credencial_invalida"]}}},"example":{"erro":"credencial_invalida"}}}},"SemAcesso":{"description":"A chave não inclui a área requerida (`area_nao_autorizada`) ou a empresa não tem uma assinatura vigente (`assinatura_inativa`).","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["area_nao_autorizada","assinatura_inativa"]}}},"example":{"erro":"area_nao_autorizada"}}}},"AgenteOcupado":{"description":"A instalação atingiu a capacidade de consultas simultâneas (até quatro por instalação). Volte a tentar mais tarde.","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["agente_ocupado"]}}},"example":{"erro":"agente_ocupado"}}}},"RespostaInvalida":{"description":"Os dados pedidos não puderam ser devolvidos no formato esperado.","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["pagina_invalida","linha_invalida"]}}},"example":{"erro":"pagina_invalida"}}}},"Indisponivel":{"description":"Consulte o campo `erro`. Com `agente_offline`, verifique a ligação do agente. Com `fonte_indisponivel`, verifique a ligação ao SQL Server, as tabelas e colunas exigidas pela operação e as permissões de leitura da conta do serviço.","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["agente_offline","consulta_indisponivel","fonte_indisponivel","provisionamento_indisponivel","assinaturas_indisponiveis"]}}},"example":{"erro":"agente_offline"}}}},"PrazoExcedido":{"description":"O pedido excedeu o prazo de resposta.","content":{"application/json":{"schema":{"type":"object","required":["erro"],"properties":{"erro":{"type":"string","enum":["consulta_expirada"]}}},"example":{"erro":"consulta_expirada"}}}}}}}