{"info":{"name":"automcp · Gateway de leitura","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":"A variável **baseUrl** termina em `/api`. Todos os pedidos da coleção começam com `{{baseUrl}}/v1/`. Copie a chave da ficha da empresa para o valor local de **token** e mantenha a verificação TLS ativa. Em **Primeiros testes**, envie **GET /api/v1/version** para verificar a chave e **GET /api/v1/test** para consultar a ligação com o agente."},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{token}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://automcp.cboxclub.com:8443/api","type":"string","description":"Raiz HTTPS da API. Retire o sufixo /v1 e a barra final do endereço da ficha."},{"key":"token","value":"","type":"string","description":"Preencha apenas o valor local com a chave de leitura da sua empresa."}],"event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"O gateway respondeu HTTP 200\", function () {","    pm.response.to.have.status(200);","});","pm.test(\"O corpo contém JSON válido\", function () {","    pm.expect(pm.response.headers.get(\"Content-Type\")).to.match(/^application\\/json\\b/i);","    pm.response.json();","});"]}}],"item":[{"name":"Primeiros testes","item":[{"name":"GET /api/v1/version · Versão do gateway","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/version","host":["{{baseUrl}}"],"path":["v1","version"]},"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."},"event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"A versão do gateway é uma string preenchida\", function () {","    pm.expect(pm.response.json()).to.be.a(\"string\").and.not.be.empty;","});"]}}]},{"name":"GET /api/v1/test · Test Webservice","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/test","host":["{{baseUrl}}"],"path":["v1","test"]},"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."},"event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"A fonte de dados respondeu ao agente\", function () {","    pm.expect(pm.response.json()).to.have.property(\"ok\", true);","});"]}}]},{"name":"GET /api/v1/artigos · Listar artigos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/artigos?limite=1","host":["{{baseUrl}}"],"path":["v1","artigos"],"query":[{"key":"artigo","value":"PILOTO-001","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.","disabled":true},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."},"event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"A página de artigos respeita o limite devolvido\", function () {","    const page = pm.response.json();","    pm.expect(page.offset).to.be.a(\"number\").and.at.least(0);","    pm.expect(page.limite).to.be.a(\"number\").and.within(1, 200);","    pm.expect(page.dados).to.be.an(\"array\");","    pm.expect(page.dados.length).to.be.at.most(page.limite);","});"]}}]}]},{"name":"Artigos","item":[{"name":"GET /api/v1/precos · Listar preços de venda","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/precos?limite=1","host":["{{baseUrl}}"],"path":["v1","precos"],"query":[{"key":"artigo","value":"PILOTO-001","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.","disabled":true},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/colors · Obter cores","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/colors?limit=1","host":["{{baseUrl}}"],"path":["v1","colors"],"query":[{"key":"ColorID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/extraFields · Listar campos extra","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/extraFields?limit=1","host":["{{baseUrl}}"],"path":["v1","extraFields"],"query":[{"key":"ExtraFieldID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/family · Listar famílias","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/family?limit=1","host":["{{baseUrl}}"],"path":["v1","family"],"query":[{"key":"FamilyID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos. InternalID e ExtendedProperties não têm origem confirmada."}},{"name":"GET /api/v1/familychildren · Listar sub-famílias","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/familychildren?limit=1","host":["{{baseUrl}}"],"path":["v1","familychildren"],"query":[{"key":"FamilyID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos. Subfamílias imediatas. InternalID e ExtendedProperties não têm origem confirmada."}},{"name":"GET /api/v1/prices · Linhas de preço (GET prices)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/prices?limit=1","host":["{{baseUrl}}"],"path":["v1","prices"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/products · Listar artigo por Refª","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products?limit=1","host":["{{baseUrl}}"],"path":["v1","products"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"FamilyID","value":"1","disabled":true},{"key":"Discontinued","value":"false","disabled":true},{"key":"dtalt","value":"2026-09-01","disabled":true},{"key":"LanguageID","value":"","disabled":true},{"key":"simple","value":"false","disabled":true},{"key":"barcodes","value":"false","disabled":true},{"key":"PriceLineID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/products/colorCount · Obter total de cores do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/colorCount","host":["{{baseUrl}}"],"path":["v1","products","colorCount"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true}]},"description":"Áreas necessárias: artigos. Cores distintas associadas aos artigos selecionados, em objeto Count."}},{"name":"GET /api/v1/products/colorsizes · Cores/Tamanhos do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/colorsizes","host":["{{baseUrl}}"],"path":["v1","products","colorsizes"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true}]},"description":"Áreas necessárias: artigos. Cores e tamanhos distintos associados ao artigo ou, sem filtro, aos artigos do catálogo."}},{"name":"GET /api/v1/products/count · Total de artigos (count)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/count","host":["{{baseUrl}}"],"path":["v1","products","count"],"query":[{"key":"FamilyID","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/products/descriptions · Descrições do artigo por idioma","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/descriptions?limit=1","host":["{{baseUrl}}"],"path":["v1","products","descriptions"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/products/extraFields · Listar Campos Extra Artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/extraFields?limit=1","host":["{{baseUrl}}"],"path":["v1","products","extraFields"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/products/sizeCount · Total de tamanhos do artigo (sizeCount)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/sizeCount?ItemID=PILOTO-001","host":["{{baseUrl}}"],"path":["v1","products","sizeCount"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":false}]},"description":"Áreas necessárias: artigos. Contagem das associações ao artigo, em objeto Count."}},{"name":"GET /api/v1/sizes · Tamanhos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/sizes?limit=1","host":["{{baseUrl}}"],"path":["v1","sizes"],"query":[{"key":"SizeID","value":"1","disabled":true},{"key":"SizeName","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/unitofmeasure · Unidades de medida","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/unitofmeasure?limit=1","host":["{{baseUrl}}"],"path":["v1","unitofmeasure"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: artigos."}},{"name":"GET /api/v1/SageVersion · Versão da instalação Sage 50c","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/SageVersion","host":["{{baseUrl}}"],"path":["v1","SageVersion"]},"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."}},{"name":"GET /api/v1/products/{ItemID}/image · Imagem do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/:ItemID/image?limit=1","host":["{{baseUrl}}"],"path":["v1","products",":ItemID","image"],"query":[{"key":"barcodes","value":"false","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"ItemID","value":"PILOTO-001"}]},"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."}},{"name":"GET /api/v1/products/archives · Anexos públicos do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/archives?ItemID=PILOTO-001&limit=1","host":["{{baseUrl}}"],"path":["v1","products","archives"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":false},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/products/archives/{archiveGuid} · Conteúdo do anexo de artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/archives/:archiveGuid","host":["{{baseUrl}}"],"path":["v1","products","archives",":archiveGuid"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true}],"variable":[{"key":"archiveGuid","value":"11111111-1111-1111-1111-111111111111"}]},"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."}}]},{"name":"Stocks","item":[{"name":"GET /api/v1/rotacao · Consultar a rotação de stock","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/rotacao?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","rotacao"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"artigo","value":"PILOTO-001","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.","disabled":true},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/stocks · Consultar stock por armazém","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/stocks?limite=1","host":["{{baseUrl}}"],"path":["v1","stocks"],"query":[{"key":"artigo","value":"PILOTO-001","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.","disabled":true},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"description":"Requer a área `stocks`. Quantidades físicas e disponíveis, encomendas, consignações e valores de custo por artigo, variante e armazém."}},{"name":"GET /api/v1/movimentos-stock · Listar movimentos de stock","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/movimentos-stock?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","movimentos-stock"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"artigo","value":"PILOTO-001","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.","disabled":true},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"description":"Requer a área `stocks`. Movimentos no período da entrega efetiva (ActualDeliveryDate). Inclui o documento, unidades recebidas e saídas, saldo e custos."}},{"name":"GET /api/v1/products/itemproperties · Listar propriedades do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/itemproperties?limit=1","host":["{{baseUrl}}"],"path":["v1","products","itemproperties"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: stocks. Combinações distintas nas existências dos armazéns."}},{"name":"GET /api/v1/products/itempropertiesCount · Total propriedades do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/itempropertiesCount","host":["{{baseUrl}}"],"path":["v1","products","itempropertiesCount"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true}]},"description":"Áreas necessárias: stocks. Conta as combinações distintas de propriedades."}},{"name":"GET /api/v1/products/stock · Listar stock artigo por refª","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/stock?limit=1","host":["{{baseUrl}}"],"path":["v1","products","stock"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"WarehouseID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: stocks."}},{"name":"GET /api/v1/products/stockproperties · Listar stock artigo por propriedades","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/stockproperties?limit=1","host":["{{baseUrl}}"],"path":["v1","products","stockproperties"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: stocks."}},{"name":"GET /api/v1/warehouses · Listar armazéns","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/warehouses?limit=1","host":["{{baseUrl}}"],"path":["v1","warehouses"],"query":[{"key":"WarehouseID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: stocks."}},{"name":"GET /api/v1/warehousesstocks · Listar stock artigos por armazém","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/warehousesstocks?limit=1","host":["{{baseUrl}}"],"path":["v1","warehousesstocks"],"query":[{"key":"WarehouseID","value":"1","disabled":true},{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: stocks. Description é a descrição portuguesa do artigo. A página preserva cada variante de lote do stock."}},{"name":"GET /api/v1/documents/stock · Documentos de stock","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/stock?limit=1","host":["{{baseUrl}}"],"path":["v1","documents","stock"],"query":[{"key":"TransSerial","value":"DEMO","disabled":true},{"key":"TransDocument","value":"FT","disabled":true},{"key":"TransDocNumber","value":"1","disabled":true},{"key":"Details","value":"false","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}}]},{"name":"Vendas","item":[{"name":"GET /api/v1/vendas · Consultar faturação por mês","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/vendas?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","vendas"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/documentos-venda · Listar documentos de venda","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documentos-venda?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","documentos-venda"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/margens · Consultar margens por artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/margens?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","margens"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/carrier · Obter Transportes","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/carrier?limit=1","host":["{{baseUrl}}"],"path":["v1","carrier"],"query":[{"key":"CarrierID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas. Sem fonte SQL confirmada para ExtendedProperties."}},{"name":"GET /api/v1/DiscountDefinition · Obter lista campanhas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/DiscountDefinition?limit=1","host":["{{baseUrl}}"],"path":["v1","DiscountDefinition"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/DiscountDefinition/{DiscountID} · Obter campanha","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/DiscountDefinition/:DiscountID?limit=1","host":["{{baseUrl}}"],"path":["v1","DiscountDefinition",":DiscountID"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"DiscountID","value":"1"}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/DiscountDefinition/{DiscountID}/DiscountEligibleItem · Obter descontos por artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/DiscountDefinition/:DiscountID/DiscountEligibleItem?limit=1","host":["{{baseUrl}}"],"path":["v1","DiscountDefinition",":DiscountID","DiscountEligibleItem"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"DiscountID","value":"1"}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/DiscountDefinition/{DiscountID}/DiscountScalingItem · Obter escalões de desconto","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/DiscountDefinition/:DiscountID/DiscountScalingItem?limit=1","host":["{{baseUrl}}"],"path":["v1","DiscountDefinition",":DiscountID","DiscountScalingItem"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"DiscountID","value":"1"}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/loadunloadplace · Listar cargas/descargas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/loadunloadplace?limit=1","host":["{{baseUrl}}"],"path":["v1","loadunloadplace"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/salesman · Vendedores","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/salesman?limit=1","host":["{{baseUrl}}"],"path":["v1","salesman"],"query":[{"key":"SalesmanID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas."}},{"name":"GET /api/v1/documents/status/all · Lista de estados do documento","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/status/all?limit=1","host":["{{baseUrl}}"],"path":["v1","documents","status","all"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso."}},{"name":"GET /api/v1/series · Listar séries","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/series?limit=1","host":["{{baseUrl}}"],"path":["v1","series"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso."}},{"name":"GET /api/v1/documents/series · Lista de séries","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/series?limit=1","host":["{{baseUrl}}"],"path":["v1","documents","series"],"query":[{"key":"Series","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso."}},{"name":"GET /api/v1/documents/voucher · Consultar talão","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/voucher?TransSerial=DEMO&TransDocument=FT&TransDocNumber=1","host":["{{baseUrl}}"],"path":["v1","documents","voucher"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FT","disabled":false},{"key":"TransDocNumber","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/documents · Lista de documentos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents?limit=1","host":["{{baseUrl}}"],"path":["v1","documents"],"query":[{"key":"LanguageID","value":"","disabled":true},{"key":"TransDocID","value":"","disabled":true},{"key":"DocumentType","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/documents/sale · Listar documento venda","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/sale?limit=1","host":["{{baseUrl}}"],"path":["v1","documents","sale"],"query":[{"key":"TransSerial","value":"DEMO","disabled":true},{"key":"TransDocument","value":"FT","disabled":true},{"key":"TransDocNumber","value":"1","disabled":true},{"key":"Details","value":"false","disabled":true},{"key":"Temp","value":"false","disabled":true},{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"EndDate","value":"2026-10-01","disabled":true},{"key":"ContractReferenceNumber","value":"","disabled":true},{"key":"PartyID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/documents/status · Estado do documento","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/status?TransSerial=DEMO&TransDocument=FT&TransDocNumber=1&limit=1","host":["{{baseUrl}}"],"path":["v1","documents","status"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FT","disabled":false},{"key":"TransDocNumber","value":"1","disabled":false},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: vendas, compras. Estado atual de vendas e compras. Requer ambas as áreas; o catálogo de estados tem rota separada."}},{"name":"GET /api/v1/checkDocument · Verificar documento","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/checkDocument?TransSerial=DEMO&TransDocument=FT&TransDocNumber=1","host":["{{baseUrl}}"],"path":["v1","checkDocument"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FT","disabled":false},{"key":"TransDocNumber","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/documents/excel · Exportar um documento para Excel","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/excel?TransSerial=DEMO&TransDocument=FA&TransDocNumber=401","host":["{{baseUrl}}"],"path":["v1","documents","excel"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FA","disabled":false},{"key":"TransDocNumber","value":"401","disabled":false}]},"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."}},{"name":"GET /api/v1/documents/pdf · Ler o PDF fiscal arquivado","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/pdf?TransSerial=DEMO&TransDocument=FA&TransDocNumber=401","host":["{{baseUrl}}"],"path":["v1","documents","pdf"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FA","disabled":false},{"key":"TransDocNumber","value":"401","disabled":false},{"key":"Print","value":"false","disabled":true}]},"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."}}]},{"name":"Compras","item":[{"name":"GET /api/v1/compras · Consultar compras por fornecedor e mês","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/compras?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","compras"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"description":"Requer a área `compras`. Totais de documentos definitivos por fornecedor, mês, moeda, tipo e sinal do mapa de compras."}},{"name":"GET /api/v1/documentos-compra · Listar documentos de compra","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documentos-compra?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","documentos-compra"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/fornecedores · Listar fornecedores","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/fornecedores?limite=1","host":["{{baseUrl}}"],"path":["v1","fornecedores"],"query":[{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"description":"Requer a área `compras`. Ficha de cada fornecedor por ordem de identificador, com nome e indicadores de atividade e bloqueio."}},{"name":"GET /api/v1/products/suppliers · Fornecedores do artigo","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/products/suppliers?limit=1","host":["{{baseUrl}}"],"path":["v1","products","suppliers"],"query":[{"key":"ItemID","value":"PILOTO-001","disabled":true},{"key":"WarehouseID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/suppliers/address/{SupplierID} · Morada do fornecedor","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/address/:SupplierID?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers","address",":SupplierID"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"SupplierID","value":"1"}]},"description":"Áreas necessárias: compras. Resolve a morada pelo identificador de entidade da ficha."}},{"name":"GET /api/v1/suppliers/extraFields · Campo extra do fornecedor","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/extraFields?SupplierID=1&ExtraFieldID=1","host":["{{baseUrl}}"],"path":["v1","suppliers","extraFields"],"query":[{"key":"SupplierID","value":"1","disabled":false},{"key":"ExtraFieldID","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/suppliers · Fornecedores","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers"],"query":[{"key":"SupplierID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/documents/purchase · Documentos de compras","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/purchase?limit=1","host":["{{baseUrl}}"],"path":["v1","documents","purchase"],"query":[{"key":"TransSerial","value":"DEMO","disabled":true},{"key":"TransDocument","value":"FT","disabled":true},{"key":"TransDocNumber","value":"1","disabled":true},{"key":"Details","value":"false","disabled":true},{"key":"Temp","value":"false","disabled":true},{"key":"NotConverted","value":"false","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}}]},{"name":"Clientes","item":[{"name":"GET /api/v1/clientes · Listar clientes","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/clientes?limite=1","host":["{{baseUrl}}"],"path":["v1","clientes"],"query":[{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"description":"Requer a área `clientes`. Ficha comercial por CustomerID, com nome, estado, condições de pagamento, linha de preço e vendedor."}},{"name":"GET /api/v1/historico-cliente · Consultar histórico de um cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/historico-cliente?inicio=2026-09-01&fimExclusivo=2026-10-01&cliente=1&limite=1","host":["{{baseUrl}}"],"path":["v1","historico-cliente"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"cliente","value":"1","description":"Identificador comercial CustomerID, em algarismos decimais. Use a listagem de clientes para encontrar o identificador.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/CountryCodes · Obter lista países","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/CountryCodes?limit=1","host":["{{baseUrl}}"],"path":["v1","CountryCodes"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes."}},{"name":"GET /api/v1/languageCodes · Listar Idiomas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/languageCodes?limit=1","host":["{{baseUrl}}"],"path":["v1","languageCodes"],"query":[{"key":"LanguageID","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes."}},{"name":"GET /api/v1/zones · Zonas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/zones?limit=1","host":["{{baseUrl}}"],"path":["v1","zones"],"query":[{"key":"ZoneID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes. Sem fonte SQL confirmada para ExtendedProperties."}},{"name":"GET /api/v1/customers/groups · Listar grupos de cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/groups?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","groups"],"query":[{"key":"GroupID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes. Projeção de catálogo do Sage local. O fornecedor não publicou o esquema de sucesso."}},{"name":"GET /api/v1/customers/address/{PartyID} · Moradas do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/address/:PartyID?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","address",":PartyID"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"PartyID","value":"1"}]},"description":"Áreas necessárias: clientes. Resolve a morada pelo identificador de entidade da ficha."}},{"name":"GET /api/v1/customers/email · Email do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/email?PartyID=1","host":["{{baseUrl}}"],"path":["v1","customers","email"],"query":[{"key":"PartyID","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/customers/contacts/{PartyID} · Contactos do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/contacts/:PartyID?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","contacts",":PartyID"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"PartyID","value":"1"}]},"description":"Áreas necessárias: clientes. Listas de contacto com os campos EmailAddress e TelephoneNumber. A estrutura dos elementos destas listas não foi publicada."}},{"name":"GET /api/v1/customers/bank-accounts · Contas bancárias do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/bank-accounts?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","bank-accounts"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes, financeiro. Identificação e IBAN das contas de clientes. A referência não especifica outros campos de resposta."}},{"name":"GET /api/v1/customers/extrafields/{PartyID} · Campos extra do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/extrafields/:PartyID?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","extrafields",":PartyID"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"PartyID","value":"1"}]},"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."}},{"name":"GET /api/v1/vehicles · Listar veículos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/vehicles?limit=1","host":["{{baseUrl}}"],"path":["v1","vehicles"],"query":[{"key":"CustomerID","value":"1","disabled":true},{"key":"Discontinued","value":"false","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura."}},{"name":"GET /api/v1/vehicles/makes · Marcas de veículos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/vehicles/makes?limit=1","host":["{{baseUrl}}"],"path":["v1","vehicles","makes"],"query":[{"key":"CustomerID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura."}},{"name":"GET /api/v1/vehicles/models · Modelos de veículos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/vehicles/models?limit=1","host":["{{baseUrl}}"],"path":["v1","vehicles","models"],"query":[{"key":"CustomerID","value":"1","disabled":true},{"key":"VehicleMake","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: clientes. Sage CustomerImputeTypeEnum.citByVehicle = 2. Seleciona exclusivamente as imputações de viatura."}},{"name":"GET /api/v1/customers/contracts · Obter avenças","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/contracts?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","contracts"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/customers · Listar clientes por refª","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers?limit=1","host":["{{baseUrl}}"],"path":["v1","customers"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"FederalTaxID","value":"","disabled":true},{"key":"EmailAddress","value":"","disabled":true},{"key":"OrderBy","value":"OrganizationName","disabled":true},{"key":"onlyPending","value":"false","disabled":true},{"key":"filter","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}}]},{"name":"Financeiro","item":[{"name":"GET /api/v1/financeiro-clientes · Consultar contas a receber","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/financeiro-clientes?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","financeiro-clientes"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/financeiro-fornecedores · Consultar contas a pagar","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/financeiro-fornecedores?inicio=2026-09-01&fimExclusivo=2026-10-01&limite=1","host":["{{baseUrl}}"],"path":["v1","financeiro-fornecedores"],"query":[{"key":"inicio","value":"2026-09-01","description":"Primeiro dia incluído, em AAAA-MM-DD. A data mínima é 1753-01-01.","disabled":false},{"key":"fimExclusivo","value":"2026-10-01","description":"Primeiro dia excluído, em AAAA-MM-DD. Deve ser posterior a inicio. O período deve ter entre 1 e 366 dias.","disabled":false},{"key":"offset","value":"0","description":"Número de linhas a saltar a partir do início, em algarismos decimais.","disabled":true},{"key":"limite","value":"1","description":"Máximo de linhas a devolver, em algarismos decimais. Para ler a página seguinte, aumente o offset pelo limite.","disabled":false}]},"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."}},{"name":"GET /api/v1/payment · Obter pagamentos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/payment?limit=1","host":["{{baseUrl}}"],"path":["v1","payment"],"query":[{"key":"PaymentID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: financeiro. PaymentDaysAfter e ExtendedProperties não têm origem confirmada."}},{"name":"GET /api/v1/taxes · Taxas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/taxes?limit=1","host":["{{baseUrl}}"],"path":["v1","taxes"],"query":[{"key":"TaxID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: financeiro. TaxID filtra o identificador de grupo tributável devolvido na listagem."}},{"name":"GET /api/v1/taxes/taxrate · Taxa por grupo IVA (taxrate)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/taxes/taxrate?limit=1","host":["{{baseUrl}}"],"path":["v1","taxes","taxrate"],"query":[{"key":"TaxableGroupID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/taxeTable · Tabela impostos","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/taxeTable?limit=1","host":["{{baseUrl}}"],"path":["v1","taxeTable"],"query":[{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: financeiro."}},{"name":"GET /api/v1/tender · Modalidades","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/tender?limit=1","host":["{{baseUrl}}"],"path":["v1","tender"],"query":[{"key":"TenderID","value":"1","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: financeiro. Nome em português. Internal, ExtendedProperties e Properties não têm origem confirmada."}},{"name":"GET /api/v1/till · Listar caixas","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/till?limit=1","host":["{{baseUrl}}"],"path":["v1","till"],"query":[{"key":"TillID","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"description":"Áreas necessárias: financeiro."}},{"name":"GET /api/v1/documents/ledgeraccount · Documento ledger account (Sage)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/ledgeraccount?TransSerial=DEMO&TransDocument=FT&TransDocNumber=1","host":["{{baseUrl}}"],"path":["v1","documents","ledgeraccount"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FT","disabled":false},{"key":"TransDocNumber","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/customers/pending/{PartyID} · Listar Pendentes cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/pending/:PartyID?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","pending",":PartyID"],"query":[{"key":"startDate","value":"2026-09-01","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"PartyID","value":"1"}]},"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."}},{"name":"GET /api/v1/suppliers/pending · Pendentes de fornecedor (lista)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/pending?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers","pending"],"query":[{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/suppliers/pending/{SupplierID} · Pendentes de um fornecedor","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/pending/:SupplierID?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers","pending",":SupplierID"],"query":[{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"SupplierID","value":"1"}]},"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."}},{"name":"GET /api/v1/suppliers/ledgeraccount · Linhas ledger fornecedor (sem agregar)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/ledgeraccount?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers","ledgeraccount"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"SupplierID","value":"1","disabled":true},{"key":"PartyAccountTypeID","value":"","disabled":true},{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"EndDate","value":"2026-10-01","disabled":true},{"key":"TransSerial","value":"DEMO","disabled":true},{"key":"TransDocument","value":"FT","disabled":true},{"key":"TransDocNumber","value":"1","disabled":true},{"key":"onlyPending","value":"false","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/customers/cc · Listar Conta-corrente clientes","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/customers/cc?limit=1","host":["{{baseUrl}}"],"path":["v1","customers","cc"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"EndDate","value":"2026-10-01","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/documents/account · Listar documentos de conta-corrente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/documents/account?TransSerial=DEMO&TransDocument=FT&TransDocNumber=1","host":["{{baseUrl}}"],"path":["v1","documents","account"],"query":[{"key":"TransSerial","value":"DEMO","disabled":false},{"key":"TransDocument","value":"FT","disabled":false},{"key":"TransDocNumber","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/saldo · Saldo do cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/saldo?CustomerID=1","host":["{{baseUrl}}"],"path":["v1","saldo"],"query":[{"key":"CustomerID","value":"1","disabled":false}]},"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."}},{"name":"GET /api/v1/suppliers/cc · Conta-corrente fornecedores (agregada)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/cc?limit=1","host":["{{baseUrl}}"],"path":["v1","suppliers","cc"],"query":[{"key":"PartyID","value":"1","disabled":true},{"key":"StartDate","value":"2026-09-01","disabled":true},{"key":"EndDate","value":"2026-10-01","disabled":true},{"key":"filter","value":"","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/suppliers/pendentes · Pendentes (alias pendentes)","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/pendentes?partyID=1","host":["{{baseUrl}}"],"path":["v1","suppliers","pendentes"],"query":[{"key":"partyID","value":"1","disabled":false},{"key":"movimentoOffset","value":"0","disabled":true},{"key":"movimentoLimite","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/pendentes · Listar documentos pendentes cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/pendentes?partyID=1","host":["{{baseUrl}}"],"path":["v1","pendentes"],"query":[{"key":"partyID","value":"1","disabled":false},{"key":"movimentoOffset","value":"0","disabled":true},{"key":"movimentoLimite","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/suppliers/extrato · Extrato fornecedor","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/suppliers/extrato?partyID=1","host":["{{baseUrl}}"],"path":["v1","suppliers","extrato"],"query":[{"key":"partyID","value":"1","disabled":false},{"key":"dataInicio","value":"2026-09-01","disabled":true},{"key":"movimentoOffset","value":"0","disabled":true},{"key":"movimentoLimite","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/extrato · Listar extrato cliente","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/extrato?partyID=1","host":["{{baseUrl}}"],"path":["v1","extrato"],"query":[{"key":"partyID","value":"1","disabled":false},{"key":"dataInicio","value":"2026-09-01","disabled":true},{"key":"movimentoOffset","value":"0","disabled":true},{"key":"movimentoLimite","value":"1","disabled":true}]},"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."}},{"name":"GET /api/v1/SystemSettings · SystemSettings","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/SystemSettings","host":["{{baseUrl}}"],"path":["v1","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."}},{"name":"GET /api/v1/SystemSettings/Application · Application da instalação Sage","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/SystemSettings/Application","host":["{{baseUrl}}"],"path":["v1","SystemSettings","Application"]},"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."}},{"name":"GET /api/v1/SystemSettings/SystemInfo · SystemInfo da instalação Sage","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/SystemSettings/SystemInfo","host":["{{baseUrl}}"],"path":["v1","SystemSettings","SystemInfo"]},"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."}},{"name":"GET /api/v1/SystemSettings/WorkstationInfo · WorkstationInfo da instalação Sage","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/SystemSettings/WorkstationInfo","host":["{{baseUrl}}"],"path":["v1","SystemSettings","WorkstationInfo"]},"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."}}]},{"name":"Serviço","item":[{"name":"GET /api/v1/log · Consultas recentes do consumidor","request":{"method":"GET","url":{"raw":"{{baseUrl}}/v1/log?limit=1","host":["{{baseUrl}}"],"path":["v1","log"],"query":[{"key":"name","value":"","disabled":true},{"key":"data","value":"2026-09-01","disabled":true},{"key":"limit","value":"1","disabled":false},{"key":"offset","value":"0","disabled":true},{"key":"page","value":"1","disabled":true}]},"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."}}]}]}