Manual da API
Integração com o ERP Eticadata · URL base https://api.erpsinc.pt/v1.0.0
Introdução
A API ERP Sinc expõe dados e operações do ERP Eticadata (contabilidade, entidades, artigos, documentos comerciais e tabelas auxiliares) através de HTTPS e JSON.
- URL base
https://api.erpsinc.pt/v1.0.0- Formato
- JSON (UTF-8). Pedidos com corpo usam
Content-Type: application/json. - Especificação
- OpenAPI 3 (SwaggerHub) ·
coleção Postman em
postman/ - Versão
- 1.0.0 · manual gerado em 2026-11-19
Autenticação
Todos os pedidos exigem o cabeçalho X-Api-Key com a chave fornecida pelo parceiro. Cada chave está
associada a um servidor/empresa do ERP. Uma chave inválida ou em falta devolve 403.
curl 'https://api.erpsinc.pt/v1.0.0/contabilidade/periodos' \
-H 'X-Api-Key: <a-sua-chave>'Multiempresa
Quando a chave dá acesso a várias empresas, a empresa (base de dados) é indicada em cada pedido:
- GET: parâmetro
dbna query (ex.?db=emp_236). - POST / PUT / PATCH: campo
database(oudb) no corpo JSON.
As empresas disponíveis obtêm-se em GET /contabilidade/listDBemp.
Sem empresa indicada é usada a empresa por omissão da chave.
Listagens e paginação
A maioria das listagens devolve o envelope DataTables:
{
"sEcho": 0,
"iTotalRecords": 898,
"iTotalDisplayRecords": 898,
"aaData": [
{
"Id": "74",
"intCodigo": "1006",
"strNome": "Exemplo"
}
]
}| Parâmetro | Descrição |
|---|---|
limit | Registos por página (por omissão 100). |
offset | Em /contabilidade/* é o número de registos a saltar.
Nos restantes endpoints é o número da página (0, 1, 2…), ou seja, salta offset × limit registos. |
q + searchField | Filtro por igualdade num campo da listagem
(ex. ?searchField=strNumContrib&q=509999999). Alguns endpoints aceitam srchType
(equal, not-equal, startswith). |
order | Ordenação campo;ASC|DESC (ex. Id;DESC). |
"Id": "74", "fltValor": "194.060000")
e campos vazios podem vir a null. Os endpoints de integração da contabilidade
(lancamentos, periodos, entidades, tiposdocumentos, saldos…)
devolvem tipos JSON nativos.Erros
Os erros de negócio vêm normalmente com HTTP 200 e success: 0; os endpoints mais
recentes usam também códigos HTTP (400, 413…).
Verifique sempre o campo success.
{
"success": 0,
"errormsg": "registo inexistente"
}| HTTP | Significado |
|---|---|
| 200 | Pedido processado. Ver success (1 = sucesso, 0 = erro com errormsg/message). |
| 400 | Pedido mal formado ou parâmetro obrigatório em falta. |
| 403 | API Key em falta ou inválida. |
| 413 | Limite excedido (ex. mais de 50 documentos num pedido de lançamentos). |
| 500 | Erro interno (contacte o suporte com a hora do pedido). |
Guia: integração de lançamentos contabilísticos
Fluxo recomendado para enviar lançamentos para a contabilidade:
- Escolher a empresa —
GET /contabilidade/listDBemp. - Carregar dados mestre (com
db): períodos (exercício aberto/fechado), plano de contas (contas de movimento, IVA, centro de custo obrigatório), diários, tipos de documento, centros de custo e códigos de IVA. - Validar a entidade —
GET /contabilidade/entidades?nif=. Se o fornecedor não tiver conta corrente, criá-la comPOST /contabilidade/planocontas(act=ensureSupplierAccount). - Simular —
POST /contabilidade/lancamentoscom"validarApenas": true: devolve todos os erros por linha sem gravar. - Enviar — o mesmo pedido com
"validarApenas": false. Cada documento devolvecreated,exists(reenvio — não duplica) ouerror. - Confirmar —
GET /contabilidade/lancamentos?id=ou?numeroDocumento=&nif=para obter o número atribuído no Eticadata.
Contabilidade
Endpoints de consulta/importação de contabilidade.
GET Listar empresas (bases de dados)
/contabilidade/listDBempRespostas
- 200 Devolve uma lista de BD de empresas — ctb_listDBemp_response
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/listDBemp' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"emp": "emp_001",
"value": "emp_001"
},
{
"emp": "emp_101",
"value": "emp_101"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Listar diários
/contabilidade/diariosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Devolve uma lista de diários na CTB — DataTables<ctb_diario>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/diarios?db=emp_236&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 12,
"iTotalDisplayRecords": 12,
"aaData": [
{
"Id": "67",
"intCodigo": "12",
"strDescricao": "Pagamentos",
"bitFiltrar_Docs": "0",
"dtmAbertura": "2015-05-14 00:00:00",
"dtmAlteracao": "2015-08-06 00:00:00",
"bitDebDifCre": "0",
"bitPermiteIntroduzir": "0"
},
{
"Id": "66",
"intCodigo": "11",
"strDescricao": "Recibos",
"bitFiltrar_Docs": "0",
"dtmAbertura": "2015-05-14 00:00:00",
"dtmAlteracao": "2015-08-06 00:00:00",
"bitDebDifCre": "0",
"bitPermiteIntroduzir": "0"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tipos documentais eInvoice
/contabilidade/eInvoice_TpDocsTbl_eInvoice_TpDocs).Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipos documentais eInvoice — ctb_eInvoiceTpDocsResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/eInvoice_TpDocs?db=emp_236&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 5,
"iTotalDisplayRecords": 5,
"aaData": [
{
"strTpDoc": "Nota de débito",
"strAbrevTpDoc": "",
"strListDocs": ""
},
{
"strTpDoc": "Nota de crédito",
"strAbrevTpDoc": "",
"strListDocs": ""
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Listar movimentos contabilísticos
/contabilidade/movimentoslinhas e mov_cc (movimentos de centro de custo).Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
intCodDiario | query | string | Código do diario |
intNum_Diario | query | string | Código do diario |
intMes | query | string | Mês do diario |
strData | query | string date | Data do Doc |
strAbrevTpDoc | query | string | Tipo de documento |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Devolve uma lista de Movimentos na CTB paginada — DataTables<ctb_movimentos>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/movimentos?db=emp_236&strCodExercicio=2026&intMes=7&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 4213,
"iTotalDisplayRecords": 4213,
"aaData": [
{
"strCodExercicio": "2026",
"intCodDiario": "2",
"intNum_Diario": "16",
"intMes": "6",
"strData": "2026-06-30",
"strAbrevTpDoc": "DIV",
"strNum_Doc": "16",
"Id": "58116",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"dtmAbertura": "2026-11-19 17:45:00",
"dtmAlteracao": "2026-11-19 17:44:46.000",
"strAplicacaoOrigem": "CTEP",
"strLogin": "Exemplo",
"strNum_Diario": "00016",
"strFArchTaxPayer": "509999999",
"fltFArchTotal": ".000000",
"temAnexoDigital": 1,
"linhas": [
{
"intNumlinha": "1",
"strConta": "1205",
"fltValor": "70594.010000",
"strDescricao": "Descrição exemplo",
"strDeb_Cre": "D",
"intGrp_Terc": "-1",
"strNumContrib": "509999999",
"bitReconciliado": "0",
"strCodePlan": "CONTAB",
"IdReconciliation": "0",
"fltValueReconcilied": ".000000"
},
{
"intNumlinha": "2",
"strConta": "111",
"fltValor": "70594.010000",
"strDescricao": "Descrição exemplo",
"strDeb_Cre": "C",
"intGrp_Terc": "-1",
"strNumContrib": "509999999",
"bitReconciliado": "0",
"strCodePlan": "CONTAB",
"IdReconciliation": "0",
"fltValueReconcilied": ".000000"
}
],
"mov_cc": []
},
{
"strCodExercicio": "2026",
"intCodDiario": "2",
"intNum_Diario": "15",
"intMes": "6",
"strData": "2026-06-30",
"strAbrevTpDoc": "DIV",
"strNum_Doc": "15",
"Id": "58115",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"dtmAbertura": "2026-11-19 17:41:00",
"dtmAlteracao": "2026-11-19 17:40:56.000",
"strAplicacaoOrigem": "CTEP",
"strLogin": "Exemplo",
"strNum_Diario": "00015",
"strFArchTaxPayer": "509999999",
"fltFArchTotal": ".000000",
"temAnexoDigital": 1,
"linhas": [
{
"intNumlinha": "1",
"strConta": "1205",
"fltValor": "30313.260000",
"strDescricao": "Descrição exemplo",
"strDeb_Cre": "C",
"intGrp_Terc": "-1",
"strNumContrib": "509999999",
"bitReconciliado": "0",
"strCodePlan": "CONTAB",
"IdReconciliation": "0",
"fltValueReconcilied": ".000000"
},
{
"intNumlinha": "2",
"strConta": "2311",
"fltValor": "1849.500000",
"strDescricao": "Descrição exemplo",
"strDeb_Cre": "D",
"intGrp_Terc": "-1",
"strNumContrib": "509999999",
"bitReconciliado": "0",
"strCodePlan": "CONTAB",
"IdReconciliation": "0",
"fltValueReconcilied": ".000000"
}
],
"mov_cc": []
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Importar/eliminar movimentos (legado)
/contabilidade/movimentosact (importMovim, deleteMovim). Em deleteMovim, a API elimina Movimentos_Ctb_Lin, Mov_CC e depois Movimentos_Ctb_Cab.Corpo do pedido application/json ctbMovimentosActionRequest
| Campo | Tipo | Descrição |
|---|---|---|
db | string | Base de dados/tenant alvo. Obrigatório em deleteMovim para evitar fallback para a BD por defeito.ex.: emp_236 |
database | string | Alias de db. Obrigatório em deleteMovim quando db não for enviado.ex.: emp_236 |
act | string importMovim · deleteMovim · deleteMovimento · delete | obrigatório |
Id | integer | Identificador interno do movimento (alternativa à chave composta para deleteMovim).ex.: 10021 |
id | integer | Alias de Id.ex.: 10021 |
strCodExercicio | string | Código do exercício. Em deleteMovim, faz parte da chave composta de eliminação.ex.: 2025 |
intCodDiario | integer | Código do diário. Em deleteMovim, faz parte da chave composta de eliminação.ex.: 8 |
intMes | integer | Mês do movimento. Em deleteMovim, faz parte da chave composta de eliminação.ex.: 1 |
intNum_Diario | integer | Número do diário. Em deleteMovim, faz parte da chave composta de eliminação.ex.: 10001 |
intNumDiario | integer | Alias de intNum_Diario.ex.: 10001 |
codDiario | integer | Código do diário a usar em importMovim. Se omitido, o endpoint usa 8.ex.: 8 |
documents | array<ctbImportMovimentoDocument> | Coleção de documentos para importMovim. |
account | array<ctbImportMovimentoLine> | Alias legado de linhas contabilísticas quando o pedido envia um único documento no corpo raiz. |
lines | array<ctbImportMovimentoLine> | Linhas contabilísticas quando o pedido envia um único documento no corpo raiz. |
field_A | string | NIF/Tax payer do documento externo no modo legado de importMovim.ex.: 500108668 |
field_C | string | Descrição do documento externo. ex.: Fatura fornecedor |
field_F | string date | Data do documento externo. ex.: 2026-03-08 |
field_G | string | Número externo/documento externo. ex.: FAC-2026/123 |
field_N | string | Total de IVA no documento externo. ex.: 6.00 |
field_O | string | Total do documento externo. ex.: 106.00 |
docType | string | Tipo documental de contabilidade a gravar. ex.: V/FAC |
file_attachment | ctbFileAttachment | Anexo opcional enviado com importMovim. |
Respostas
- 200 Operação executada com sucesso — ctbMovimentosActionResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/contabilidade/movimentos' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{"db": "emp_236", "database": "emp_236", "act": "importMovim", "Id": 10021, "id": 10021, "strCodExercicio": "2025", "intCodDiario": 8, "intMes": 1, "intNum_Diario": 10001, "intNumDiario": 10001, "codDiario": 8, "documents": [{"field_A": "500108668", "field_B": "", "field_C": "Fatura fornecedor", "field_D": "", "field_E": "", "field_F": "2026-03-08", "field_G": "FAC-2026/123", "field_H": "", "field_I1": "string", "field_I2": "string", "field_I3": "string", "field_I4": "string", "field_I5": "string", "field_I6": "string", "field_I7": "string", "field_I8": "string", "field_N": "string", "field_O": "string", "field_Q": "string", "field_R": "string", "docType": "V/FAC", "import_type": "qr", "dte_add": "string", "user": "api", "bitIsForSend": 0, "intTipoEntidade": 23, "bitFiscalArchive": 1, "bitFiscalArchiveHist": 1, "adicionalDescription": "", "account": [{"strConta": "2211001", "account": "2211001", "conta": "2211001", "fltValor": 106, "valor": 106, "value": 106, "intGrp_Terc": -1, "strDescricao": "Fatura fornecedor", "description": "Fatura fornecedor", "strDeb_Cre": "D", "type": "D", "tax_rate": 23, "strNumContrib": "500108668", "taxId": "500108668", "strCentroCusto": "string", "strCodFichRepart": "string", "mov_cc": [{"strConta_CCusto": null, "cost_center": null, "fltPercentagem": null, "percentage": null, "fltValor": null, "value": null, "strDeb_Cre": null}]}], "lines": [{"strConta": "2211001", "account": "2211001", "conta": "2211001", "fltValor": 106, "valor": 106, "value": 106, "intGrp_Terc": -1, "strDescricao": "Fatura fornecedor", "description": "Fatura fornecedor", "strDeb_Cre": "D", "type": "D", "tax_rate": 23, "strNumContrib": "500108668", "taxId": "500108668", "strCentroCusto": "string", "strCodFichRepart": "string", "mov_cc": [{"strConta_CCusto": null, "cost_center": null, "fltPercentagem": null, "percentage": null, "fltValor": null, "value": null, "strDeb_Cre": null}]}], "file_attachment": {"content_base64": "string", "filename": "fatura.pdf", "path": "/imports/fatura.pdf", "size": 12345, "mime_type": "application/pdf"}}], "account": [{"strConta": "2211001", "account": "2211001", "conta": "2211001", "fltValor": 106, "valor": 106, "value": 106, "intGrp_Terc": -1, "strDescricao": "Fatura fornecedor", "description": "Fatura fornecedor", "strDeb_Cre": "D", "type": "D", "tax_rate": 23, "strNumContrib": "500108668", "taxId": "500108668", "strCentroCusto": "string", "strCodFichRepart": "string", "mov_cc": [{"strConta_CCusto": "string", "cost_center": "string", "fltPercentagem": 1.0, "percentage": 1.0, "fltValor": 1.0, "value": 1.0, "strDeb_Cre": "D"}]}], "lines": [{"strConta": "2211001", "account": "2211001", "conta": "2211001", "fltValor": 106, "valor": 106, "value": 106, "intGrp_Terc": -1, "strDescricao": "Fatura fornecedor", "description": "Fatura fornecedor", "strDeb_Cre": "D", "type": "D", "tax_rate": 23, "strNumContrib": "500108668", "taxId": "500108668", "strCentroCusto": "string", "strCodFichRepart": "string", "mov_cc": [{"strConta_CCusto": "string", "cost_center": "string", "fltPercentagem": 1.0, "percentage": 1.0, "fltValor": 1.0, "value": 1.0, "strDeb_Cre": "D"}]}], "field_A": "500108668", "field_C": "Fatura fornecedor", "field_F": "2026-03-08", "field_G": "FAC-2026/123", "field_N": "6.00", "field_O": "106.00", "docType": "V/FAC", "file_attachment": {"content_base64": "string", "filename": "fatura.pdf", "path": "/imports/fatura.pdf", "size": 12345, "mime_type": "application/pdf"}}'{
"success": 1,
"message": "Movimento eliminado com sucesso",
"errormsg": "Movimento inexistente",
"movimento": {
"Id": 10021,
"strCodExercicio": "2025",
"intCodDiario": 8,
"intMes": 12,
"intNum_Diario": 36,
"strNum_Doc": "3001"
},
"deleted": {
"cabecalhos": 1,
"linhas": 2,
"mov_cc": 1
},
"type": "success",
"status": 200,
"mensagem": "Registo adicionado com sucesso. Doc:509999999 → 110034",
"recs": {
"novo": [
"string"
],
"exist": [
"string"
],
"error": [
"string"
],
"cab_ids": [
{
"id": 1,
"strNum_Doc": "string",
"intNum_Diario": 1,
"strCodExercicio": "string",
"intCodDiario": 1,
"intMes": 1
}
]
},
"cab_ids": [
{
"id": 1,
"strNum_Doc": "string",
"intNum_Diario": 1,
"strCodExercicio": "string",
"intCodDiario": 1,
"intMes": 1
}
],
"log": {}
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Consultar lançamentos contabilísticos
/contabilidade/lancamentosid (devolvido na criação) ou pela referência do documento (numeroDocumento, opcionalmente com nif e tipoDocumento). Devolve o número atribuído pelo Eticadata (exercício, diário, mês, nº diário) e as linhas. É obrigatório enviar id ou numeroDocumento.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
id | query | integer | Id interno do lançamento (lancamento.id devolvido na criação).ex.: 10457 |
numeroDocumento | query | string | Número do documento de origem (correspondência exata). ex.: FT 2026A/1543 |
nif | query | string | NIF da entidade (com ou sem prefixo PT).ex.: 509999999 |
tipoDocumento | query | string | ex.: FT |
incluirLinhas | query | boolean | Incluir linhas e centros de custo (por defeito true). |
Respostas
- 200 Lançamentos encontrados (lista vazia se não existir nenhum) — object
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object - 401 API Key em falta ou inválida
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/lancamentos?db=emp_236&numeroDocumento=FT%202026A%2F1543&nif=509999999' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"id": 1,
"exercicio": "string",
"diario": 1,
"mes": 1,
"numeroDiario": 1,
"tipoDocumento": "string",
"numeroDocumento": "string",
"dataDocumento": "string",
"dataLancamento": "string",
"nif": "string",
"total": 1.0,
"anulado": false,
"aplicacaoOrigem": "string",
"dataCriacao": "string",
"temAnexo": false,
"linhas": [
{
"linha": 1,
"conta": "string",
"natureza": "D",
"valor": 1.0,
"descricao": "string",
"nif": "string",
"centrosCusto": [
{
"codigo": null,
"percentagem": null,
"valor": null
}
]
}
]
}
]
}{
"success": 0,
"message": "Indique 'id' ou 'numeroDocumento'."
}POST Criar lançamentos contabilísticos (importMovim v2)
/contabilidade/lancamentosMovimentos_Ctb_Cab, Movimentos_Ctb_Lin, Mov_CC e, opcionalmente, anexo PDF em Tbl_AnexosDigitais).Regras
- Atomicidade por documento: cada documento é gravado por inteiro ou não é gravado. Um erro num documento não impede os restantes do mesmo pedido.
- Validação prévia: antes de gravar são validados diário, tipo de documento, exercício (existente e não bloqueado), existência das contas e se são de movimento, centros de custo, códigos de IVA e o equilíbrio débito = crédito. Os erros são devolvidos por linha.
- IVA: no Eticadata o IVA é determinado pela conta (ex. 2432x). O objeto
ivaé opcional e serve para validar que o código/taxa enviados correspondem à configuração da conta. - Idempotência: a chave do documento é
entidade.nif+tipoDocumento+numeroDocumentodentro da empresa. Um reenvio não cria duplicados: devolvestatus=existscom os dados do lançamento já existente (não é tratado como erro). - Período: exercício e mês são derivados de
dataLancamento(oudataDocumentose omitida). Seperiodofor enviado, tem de ser coerente com a data. - Alterações: lançamentos não são alterados. Para corrigir, anula-se e envia-se de novo.
- Moeda: apenas EUR.
- Limites: máximo de 50 documentos por pedido; anexo PDF até 10 MB.
- Simulação: com
validarApenas=trueexecuta todas as validações sem gravar (status=validated).
200 pedido processado (ver status de cada documento); 400 pedido mal formado; 401 API Key inválida; 413 limite excedido.Corpo do pedido application/json ctbLancamentoRequest
| Campo | Tipo | Descrição |
|---|---|---|
act | string importMovimV2 | Opcional neste endpoint. por omissão: importMovimV2 |
database | string | obrigatórioBase de dados da empresa (ver /contabilidade/listDBemp).ex.: emp_236 |
validarApenas | boolean | Se true, executa todas as validações sem gravar.por omissão: False |
documentos | array<ctbLancamentoDocumento> | obrigatório |
Respostas
- 200 Pedido processado. O resultado de cada documento está em
documentos[]. — ctbLancamentoResponse - 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object - 401 API Key em falta ou inválida
- 413 Excedido o limite de documentos por pedido ou o tamanho do anexo
curl -X POST 'https://api.erpsinc.pt/v1.0.0/contabilidade/lancamentos' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"act": "importMovimV2",
"database": "emp_236",
"validarApenas": false,
"documentos": [
{
"externalId": "zc-7f3a9c21",
"diario": 8,
"tipoDocumento": "FT",
"numeroDocumento": "FT 2026A/1543",
"dataDocumento": "2026-11-12",
"dataLancamento": "2026-11-12",
"descricao": "Fornecimento material escritório",
"entidade": {
"nif": "509999999",
"nome": "Papelaria Exemplo, Lda",
"pais": "PT"
},
"total": 123.0,
"linhas": [
{
"conta": "62221",
"natureza": "D",
"valor": 100.0,
"descricao": "Material de escritório",
"centrosCusto": [
{
"codigo": "ADM",
"percentagem": 100
}
]
},
{
"conta": "243211",
"natureza": "D",
"valor": 23.0,
"iva": {
"codigo": 3,
"taxa": 23,
"incidencia": 100.0
}
},
{
"conta": "2211100015",
"natureza": "C",
"valor": 123.0
}
],
"anexo": {
"nomeFicheiro": "FT_2026A_1543.pdf",
"mimeType": "application/pdf",
"conteudoBase64": "JVBERi0xLjcKJ..."
}
}
]
}'{
"success": 1,
"resumo": {
"recebidos": 3,
"criados": 1,
"existentes": 1,
"validados": 0,
"erros": 1
},
"documentos": [
{
"externalId": "zc-7f3a9c21",
"numeroDocumento": "FT 2026A/1543",
"status": "created",
"lancamento": {
"id": 10457,
"exercicio": "2026",
"diario": 8,
"mes": 11,
"numeroDiario": 110034,
"anexoId": "3c1f0b7e-2a8d-4c55-9a77-0d5d1e9b2f10"
},
"erros": []
},
{
"externalId": "zc-1b22e0aa",
"numeroDocumento": "FT 2026A/1490",
"status": "exists",
"lancamento": {
"id": 10398,
"exercicio": "2026",
"diario": 8,
"mes": 11,
"numeroDiario": 110012
},
"erros": []
},
{
"externalId": "zc-99d0c3f1",
"numeroDocumento": "FT 2026A/1544",
"status": "error",
"lancamento": null,
"erros": [
{
"codigo": "CONTA_INEXISTENTE",
"mensagem": "A conta 62299 não existe no plano de contas do exercício 2026.",
"linha": 1,
"campo": "linhas[0].conta"
},
{
"codigo": "DESEQUILIBRIO",
"mensagem": "Total a débito (100.00) diferente do total a crédito (123.00).",
"linha": null,
"campo": "linhas"
}
]
}
]
}{
"success": 0,
"message": "Campo 'documentos' em falta ou vazio."
}GET Plano de contas
/contabilidade/planocontasTbl_Plano_Contas), em formato DataTables. Só as contas com bitMovimenta=1 aceitam lançamentos. intCodTaxaIva indica o código de IVA associado à conta e strCodFichRepart='?' indica que a conta exige centro de custo.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
strConta | query | string | Conta (correspondência exata). ex.: 62221 |
strDescricao | query | string | Descrição (correspondência exata). |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Lista paginada de contas — DataTables<ctb_conta>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/planocontas?db=emp_236&strCodExercicio=2026&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 4714,
"iTotalDisplayRecords": 4714,
"aaData": [
{
"strCodExercicio": "2026",
"strConta": "21111000588",
"strDescricao": "Entidade exemplo",
"strRefl_deb_deb": null,
"strRefl_deb_cre": null,
"strRefl_cre_deb": null,
"strRefl_cre_cre": null,
"strCodFichRepart": null,
"bitRecapitula": "1",
"bitMovimenta": "1",
"strConta_Iva": null,
"intCodTaxaIva": null,
"strNumContrib": "509999999",
"bitDefineFluxos": "1",
"strFluxos_Deb": null,
"strFluxos_Cre": null,
"strFluxos_Bal": null,
"bitTaxa": "1",
"fltTaxaValor": ".000000",
"dtmAbertura": "2026-11-03 00:00:00",
"dtmAlteracao": "2026-11-03 00:00:00",
"fltCustoFixo": ".000000",
"intTpImo": null,
"fltTaxaRetencaoIRS": null,
"intCodRubricaImp": null,
"intZonaRetencaoIRS": "0",
"bitNaoGerirPendentes": "0",
"strCodTpRemuneracao": null,
"strCodePlan": "CONTAB",
"fltVatRate": ".000000",
"fltPercNotDeductible": ".000000",
"bitGenerateThirds": "0",
"intTaxonomyCode": null,
"bitManageDeferrals": "0",
"strCriteriaReconciliation": null
},
{
"strCodExercicio": "2026",
"strConta": "21111000580",
"strDescricao": "Entidade exemplo",
"strRefl_deb_deb": null,
"strRefl_deb_cre": null,
"strRefl_cre_deb": null,
"strRefl_cre_cre": null,
"strCodFichRepart": null,
"bitRecapitula": "1",
"bitMovimenta": "1",
"strConta_Iva": null,
"intCodTaxaIva": null,
"strNumContrib": "509999999",
"bitDefineFluxos": "1",
"strFluxos_Deb": null,
"strFluxos_Cre": null,
"strFluxos_Bal": null,
"bitTaxa": "1",
"fltTaxaValor": ".000000",
"dtmAbertura": "2026-11-03 00:00:00",
"dtmAlteracao": "2026-11-03 00:00:00",
"fltCustoFixo": ".000000",
"intTpImo": null,
"fltTaxaRetencaoIRS": null,
"intCodRubricaImp": null,
"intZonaRetencaoIRS": "0",
"bitNaoGerirPendentes": "0",
"strCodTpRemuneracao": null,
"strCodePlan": "CONTAB",
"fltVatRate": ".000000",
"fltPercNotDeductible": ".000000",
"bitGenerateThirds": "0",
"intTaxonomyCode": null,
"bitManageDeferrals": "0",
"strCriteriaReconciliation": null
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Garantir conta de fornecedor
/contabilidade/planocontasact=ensureSupplierAccount: devolve a conta corrente 22x do fornecedor pelo NIF (strNumContrib, com ou sem prefixo PT) ou, se não existir, cria-a em Tbl_Plano_Contas como 22111/22112/22113 + 4 dígitos (nacional / comunitário / outros países) com o próximo número livre, copiando as flags de uma conta irmã. A conta é criada no exercício da datadoc e nos exercícios seguintes já abertos. Usado pelo CRM ao importar faturas a crédito de fornecedores sem conta no ERP.Corpo do pedido application/json object
| Campo | Tipo | Descrição |
|---|---|---|
act | string ensureSupplierAccount | obrigatório |
db | string | obrigatórioBase de dados da empresa (ex. emp_158). |
strNIF | string | obrigatórioNIF do fornecedor. |
strNome | string | Nome do fornecedor (descrição da conta, até 80 caracteres). Obrigatório quando a conta tem de ser criada. |
datadoc | string date | obrigatórioData do documento; define o exercício. |
Respostas
- 200 Conta existente ou criada (
success=0comerrormsgem caso de erro) — object - 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/contabilidade/planocontas' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"act": "ensureSupplierAccount",
"db": "string",
"strNIF": "string",
"strNome": "string",
"datadoc": "string"
}'{
"success": 1,
"created": 1,
"strConta": "string",
"strDescricao": "string",
"strNumContrib": "string",
"strCodExercicio": "string",
"exercicios_criados": [
"string"
],
"mensagem": "string",
"errormsg": "string"
}{
"success": 0,
"errormsg": "NIF inválido."
}GET Centros de custo
/contabilidade/centroscustoTbl_Centros_Custo), em formato DataTables. Indique strCodExercicio ou datadoc (o exercício é obtido pela data). Os códigos (strConta) são os usados em linhas[].centrosCusto[].codigo nos lançamentos.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
datadoc | query | string date | Data (YYYY-MM-DD) usada para determinar o exercício quando strCodExercicio não é enviado. |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Lista paginada de centros de custo — DataTables<object>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/centroscusto?db=emp_236&strCodExercicio=2026&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 8,
"iTotalDisplayRecords": 8,
"aaData": [
{
"strConta": "8",
"strDescricao": "Descrição exemplo",
"bitmovimenta": "1"
},
{
"strConta": "7",
"strDescricao": "Descrição exemplo",
"bitmovimenta": "1"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Códigos e taxas de IVA
/contabilidade/taxasivaTbl_Taxas_Iva) em formato DataTables. intCodigo é o código a usar em linhas[].iva.codigo. intTaxRegionCode indica o espaço fiscal: 0 Continente, 1 Açores, 2 Madeira. fltPercNaoDedutivel é a percentagem não dedutível e bitInactivo=1 indica um código desativado.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Lista paginada de códigos de IVA — DataTables<ctb_taxaIva>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/taxasiva?db=emp_236&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 14,
"iTotalDisplayRecords": 14,
"aaData": [
{
"Id": "45",
"intCodigo": "14",
"strDescricao": "Taxa Normal RAM 22%",
"fltTaxa": "22.000000",
"fltPercNaoDedutivel": ".000000",
"intTaxRegionCode": "2",
"intCodSAFT": "1",
"bitInactivo": "0"
},
{
"Id": "44",
"intCodigo": "13",
"strDescricao": "taxa reduzida nao dedutiv",
"fltTaxa": "6.000000",
"fltPercNaoDedutivel": "100.000000",
"intTaxRegionCode": "0",
"intCodSAFT": "0",
"bitInactivo": "0"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Exercícios e estado
/contabilidade/periodosbloqueado=true → estado=fechado) e um lançamento num exercício fechado é recusado com PERIODO_FECHADO. O mês do lançamento (1–12) é derivado da data de lançamento.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
data | query | string date | Devolve apenas o exercício que cobre esta data (YYYY-MM-DD). ex.: 2026-07-01 |
Respostas
- 200 Lista de exercícios — object
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/periodos?db=emp_236' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"exercicio": "2026",
"inicio": "2026-01-01",
"fim": "2026-12-31",
"bloqueado": false,
"estado": "aberto"
},
{
"exercicio": "2025",
"inicio": "2025-01-01",
"fim": "2025-12-31",
"bloqueado": false,
"estado": "aberto"
}
]
}{
"success": 0,
"message": "Parâmetro 'data' inválido (formato YYYY-MM-DD)."
}GET Tipos de documento
/contabilidade/tiposdocumentosTbl_Tipos_Documentos) aceites em tipoDocumento nos lançamentos, com o diário por defeito e os tipos/códigos eInvoice mapeados para cada um (ex. FT, NC), que também podem ser enviados em tipoDocumento.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
Respostas
- 200 Lista de tipos de documento — object
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/tiposdocumentos?db=emp_236' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"tipoDocumento": "ABT",
"descricao": "ABATE IMO OBSOLETO",
"diario": null,
"eInvoice": []
},
{
"tipoDocumento": "ALIEN",
"descricao": "Alienação",
"diario": null,
"eInvoice": []
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Pesquisar entidades por NIF
/contabilidade/entidadesexercicio, do exercício da data ou, por defeito, do exercício atual.Criação: a conta corrente de um fornecedor inexistente cria-se com
POST /contabilidade/planocontas (act=ensureSupplierAccount).Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
nif | query | string | obrigatórioNIF (com ou sem prefixo de país). ex.: PT509999999 |
tipoEntidade | query | string cliente · fornecedor | |
exercicio | query | string | ex.: 2026 |
data | query | string date |
Respostas
- 200 Entidades e contas encontradas (listas vazias se não existirem) — object
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/entidades?db=emp_236&nif=509999999' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": {
"nif": "509999999",
"exercicio": "2026",
"clientes": [],
"fornecedores": [
{
"codigo": 15,
"nome": "Papelaria Exemplo, Lda",
"nif": "509999999"
}
],
"contas": [
{
"conta": "2211100015",
"descricao": "Papelaria Exemplo, Lda",
"movimento": true,
"tipo": "fornecedor"
}
]
}
}{
"success": 0,
"message": "Parâmetro 'nif' obrigatório."
}GET Contas sugeridas por tipo de documento
/contabilidade/LigacaoCteTipoDocTbl_Gce_LigacaoCteTipoDoc_LinEF) para um tipo de documento, com a conta da entidade resolvida pelo NIF e a configuração de IVA/centro de custo de cada conta. Usado para sugerir as contas de um lançamento a partir de um documento de fornecedor.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
datadoc | query | string | Data do documento (YYYY-MM-DD); define o exercício se strCodExercicio for omitido.ex.: 2026-07-01 |
strNIF | query | string | NIF da entidade. ex.: 509999999 |
strTpDoc | query | string | Tipo de documento (ex. FT, NC, FR).ex.: FT |
strContaEntidadePrefix | query | string | Prefixo da conta da entidade (ex. 22). |
Respostas
- 200 Linhas de ligação — DataTables<ctb_ligacaoCteTipoDoc>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/LigacaoCteTipoDoc?db=emp_236&strCodExercicio=2026' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 1,
"iTotalDisplayRecords": 1,
"aaData": [
{
"Rub_Codigo": null,
"Rub_Descricao": "Conta Fornecedor",
"PC_Descricao": "Exemplo",
"strConta": "22110088",
"strConta_Iva": null,
"intCodTaxaIva": null,
"fltVatRate": ".000000",
"bitTaxa": "1",
"fltTaxaValor": ".000000",
"intNumLinha": "1",
"intValor": "100",
"strTipo": "C",
"bitCentrosCusto": "0",
"strCodFichRepart": null,
"costCenterRequired": 0
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Taxonomias SNC do plano de contas
/contabilidade/taxonomiasTbl_Plano_Contas_Taxonomies), em formato DataTables.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
Respostas
- 200 Lista paginada de taxonomias — DataTables<ctb_taxonomia>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/taxonomias?db=emp_236&limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 16387,
"iTotalDisplayRecords": 16387,
"aaData": [
{
"strExerciseCode": "2017",
"strAccountOrig": "892",
"strAccountDest": "892",
"strDescription": "INTERESSES MINORITÁRIOS",
"bitMovement": "1",
"intTaxonomyCode": null,
"bitAccountTransf": null,
"intOrder": "1",
"bitInsert": "0"
},
{
"strExerciseCode": "2018",
"strAccountOrig": "892",
"strAccountDest": "892",
"strDescription": "INTERESSES MINORITÁRIOS",
"bitMovement": "1",
"intTaxonomyCode": null,
"bitAccountTransf": null,
"intOrder": "1",
"bitInsert": "0"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Balancete (saldos por conta/mês)
/contabilidade/saldosCtb_Saldos) para um exercício e um mês ou intervalo de meses (intMes..intMes2). Usado pela tarefa "Apuramento de IVA" para calcular o valor contabilístico de cada campo da DP. Devolve uma linha por conta/mês; o cliente soma as linhas da mesma conta quando o intervalo cobre vários meses (ex.: trimestre).Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
intMes | query | string | Mês do diario |
intMes2 | query | integer | Último mês do intervalo (inclusive). Se omitido, igual a intMes. |
strConta | query | string | Filtro LIKE sobre a conta (ex. "243%"). Opcional. |
Respostas
- 200 Lista de saldos por conta/mês — ctb_saldos_response
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/saldos?db=emp_236&strCodExercicio=2026&intMes=7' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"strConta": "12",
"intMes": 7,
"fltCredito": 28107.42,
"fltDebito": 5196.75,
"fltSaldo": 22910.67
},
{
"strConta": "1205",
"intMes": 7,
"fltCredito": 28107.42,
"fltDebito": 5196.75,
"fltSaldo": 22910.67
}
]
}{
"success": 0,
"errormsg": "Parametro obrigatorio em falta: strCodExercicio"
}GET Declaração periódica de IVA
/contabilidade/declperiodicaTbl_Ctb_DeclPer) para um período. strPeriodo é a concatenação do primeiro e último dia do período no formato YYYYMMDDYYYYMMDD (ex.: 2026010120260331 para o 1º trimestre de 2026). strAnexo = 1 corresponde ao rosto da declaração.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strPeriodo | query | string | obrigatórioPeríodo da DP no formato YYYYMMDDYYYYMMDD (1º dia + último dia) |
strAnexo | query | string | Anexo da DP ("1" = rosto). Se omitido, devolve todos. |
Respostas
- 200 Lista de campos da DP com o respetivo valor — ctb_declperiodica_response
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/declperiodica?db=emp_236&strPeriodo=2026010120260331&strAnexo=1' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"intCodigo": 1,
"strAnexo": "1",
"fltValor": 0
},
{
"intCodigo": 2,
"strAnexo": "1",
"fltValor": 0
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Totais por diário e documento
/contabilidade/movimentosdiariosstrNum_Doc) e lado (strDeb_Cre = D/C), a partir de Movimentos_Ctb_Cab/Movimentos_Ctb_Lin. Usado pela tarefa "Confirmação de Pasta" do CRM para conferir, por diário, os valores da fita com os lançamentos.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
db | query | string | Base dados da empresa |
strCodExercicio | query | string | Código do exercício |
intMes | query | integer | obrigatórioMês dos movimentos (1-12; 0 = abertura) |
intCodDiario | query | string | Código do diario |
strDeb_Cre | query | string D · C | Filtrar pelo lado da linha (D = débito, C = crédito). Opcional. |
Respostas
- 200 Lista de totais por diário/documento/lado — ctb_movimentosdiarios_response
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/movimentosdiarios?db=emp_236&strCodExercicio=2026&intMes=7' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"data": [
{
"intCodDiario": 2,
"strDescDiario": "Bancos",
"strNum_Doc": "40813",
"strDeb_Cre": "C",
"strData": "2026-07-31",
"fltValor": 53.14,
"intLinhas": 1
},
{
"intCodDiario": 2,
"strDescDiario": "Bancos",
"strNum_Doc": "40813",
"strDeb_Cre": "D",
"strData": "2026-07-31",
"fltValor": 53.14,
"intLinhas": 2
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}Clientes
Gestão de clientes no ERP.
GET Listar clientes
/clientesParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de clientes paginada — DataTables<cliente>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 8,
"iTotalDisplayRecords": 8,
"aaData": [
{
"Id": "74",
"intCodigo": "1006",
"strNome": "Iria do Rosario",
"strNumContrib": "105399647",
"bitConsumidorFinal": "0",
"strTelefone": null,
"strTelemovel": null,
"strEmail": null,
"strMorada_lin1": "Lar Primavida - Rua da Marinheira S/N",
"strMorada_lin2": null,
"strLocalidade": "Amor",
"strPostal": "2400-792",
"strAbrevSubZona": "PRT",
"bitUseElectronicDocument": "0",
"strCodCondPag": "1",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "0",
"intCodVendedor": "0",
"strObs": null,
"dtmAbertura": "2020-04-24 19:47:00",
"dtmAlteracao": "2020-04-24 19:47:00"
},
{
"Id": "72",
"intCodigo": "223",
"strNome": "Maria",
"strNumContrib": "141069856",
"bitConsumidorFinal": "0",
"strTelefone": "939698092",
"strTelemovel": null,
"strEmail": null,
"strMorada_lin1": "Rua",
"strMorada_lin2": null,
"strLocalidade": "Localidade",
"strPostal": null,
"strAbrevSubZona": "PRT",
"bitUseElectronicDocument": "0",
"strCodCondPag": "1",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "0",
"intCodVendedor": "0",
"strObs": null,
"dtmAbertura": "2020-04-24 19:37:00",
"dtmAlteracao": "2020-04-24 19:37:00"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar cliente
/clientesCorpo do pedido application/json cliente
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do cliente. ex.: 2001 |
intCodigo | string | Código numérico do cliente. ex.: 2001 |
strNome | string | Nome do cliente. ex.: Loja Exemplo, Lda |
strNumContrib | string | NIF/VAT do cliente. ex.: PT123456789 |
bitConsumidorFinal | string | 1 se consumidor final; 0 caso contrário. ex.: 0 |
strTelefone | string | nullableTelefone. ex.: +351 212345678 |
strTelemovel | string | nullableTelemóvel. ex.: +351 912345678 |
strEmail | string | nullableEmail principal. ex.: [email protected] |
strMorada_lin1 | string | Morada (linha 1). ex.: Rua A, 100 |
strMorada_lin2 | string | nullableMorada (linha 2). ex.: Parque Industrial |
strLocalidade | string | Localidade. ex.: Leiria |
strPostal | string | nullableCódigo postal. ex.: 2400-000 |
strAbrevSubZona | string | Subzona/rota comercial. ex.: LRA |
bitUseElectronicDocument | string | 1 se usa documento eletrónico. ex.: 1 |
strCodCondPag | string | nullableCódigo das condições de pagamento. ex.: 30 |
bitPortalWeb | string | 1 se tem acesso ao portal web. ex.: 0 |
intSinalTp | string | Tipo de sinal (quando aplicável). ex.: 0 |
intCodCatEntidade | string | nullableCódigo da categoria de entidade. ex.: 1 |
bitAviso_vencimento | string | 1 se envia aviso de vencimento. ex.: 1 |
intCodVendedor | string | nullableCódigo do vendedor associado. ex.: 101 |
strObs | string | nullableObservações gerais. ex.: Cliente preferencial. |
dtmAbertura | string date-time | Data de abertura. ex.: 2024-05-10T10:00:00Z |
dtmAlteracao | string date-time | Data de alteração. ex.: 2025-01-02T09:00:00Z |
Respostas
- 200 Artigo criado com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/clientes' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "2001",
"intCodigo": "2001",
"strNome": "Loja Exemplo, Lda",
"strNumContrib": "PT123456789",
"bitConsumidorFinal": "0",
"strTelefone": "+351 212345678",
"strTelemovel": "+351 912345678",
"strEmail": "[email protected]",
"strMorada_lin1": "Rua A, 100",
"strMorada_lin2": "Parque Industrial",
"strLocalidade": "Leiria",
"strPostal": "2400-000",
"strAbrevSubZona": "LRA",
"bitUseElectronicDocument": "1",
"strCodCondPag": "30",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "1",
"intCodVendedor": "101",
"strObs": "Cliente preferencial.",
"dtmAbertura": "2024-05-10T10:00:00Z",
"dtmAlteracao": "2025-01-02T09:00:00Z"
}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Código existente"
}GET Detalhe de cliente
/clientes/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 200 Detalhes da entidade cliente — array<cliente>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes/10457' \
-H 'X-Api-Key: <a-sua-chave>'[
{
"Id": "74",
"intCodigo": "1006",
"strNome": "Iria do Rosario",
"strNumContrib": "105399647",
"bitConsumidorFinal": "0",
"strTelefone": null,
"strTelemovel": null,
"strEmail": null,
"strMorada_lin1": "Lar Primavida - Rua da Marinheira S/N",
"strMorada_lin2": null,
"strLocalidade": "Amor",
"strPostal": "2400-792",
"strAbrevSubZona": "PRT",
"bitUseElectronicDocument": "0",
"strCodCondPag": "1",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "0",
"intCodVendedor": "0",
"strObs": null,
"dtmAbertura": "2020-04-24 19:47:00",
"dtmAlteracao": "2020-04-24 19:47:00"
}
]{
"success": 0,
"errormsg": "Acesso inválido"
}PUT Atualizar cliente
/clientes/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Corpo do pedido application/json cliente
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do cliente. ex.: 2001 |
intCodigo | string | Código numérico do cliente. ex.: 2001 |
strNome | string | Nome do cliente. ex.: Loja Exemplo, Lda |
strNumContrib | string | NIF/VAT do cliente. ex.: PT123456789 |
bitConsumidorFinal | string | 1 se consumidor final; 0 caso contrário. ex.: 0 |
strTelefone | string | nullableTelefone. ex.: +351 212345678 |
strTelemovel | string | nullableTelemóvel. ex.: +351 912345678 |
strEmail | string | nullableEmail principal. ex.: [email protected] |
strMorada_lin1 | string | Morada (linha 1). ex.: Rua A, 100 |
strMorada_lin2 | string | nullableMorada (linha 2). ex.: Parque Industrial |
strLocalidade | string | Localidade. ex.: Leiria |
strPostal | string | nullableCódigo postal. ex.: 2400-000 |
strAbrevSubZona | string | Subzona/rota comercial. ex.: LRA |
bitUseElectronicDocument | string | 1 se usa documento eletrónico. ex.: 1 |
strCodCondPag | string | nullableCódigo das condições de pagamento. ex.: 30 |
bitPortalWeb | string | 1 se tem acesso ao portal web. ex.: 0 |
intSinalTp | string | Tipo de sinal (quando aplicável). ex.: 0 |
intCodCatEntidade | string | nullableCódigo da categoria de entidade. ex.: 1 |
bitAviso_vencimento | string | 1 se envia aviso de vencimento. ex.: 1 |
intCodVendedor | string | nullableCódigo do vendedor associado. ex.: 101 |
strObs | string | nullableObservações gerais. ex.: Cliente preferencial. |
dtmAbertura | string date-time | Data de abertura. ex.: 2024-05-10T10:00:00Z |
dtmAlteracao | string date-time | Data de alteração. ex.: 2025-01-02T09:00:00Z |
Respostas
- 200 Cliente atualizado com sucesso — clienteUpdateResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X PUT 'https://api.erpsinc.pt/v1.0.0/clientes/10457' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "2001",
"intCodigo": "2001",
"strNome": "Loja Exemplo, Lda",
"strNumContrib": "PT123456789",
"bitConsumidorFinal": "0",
"strTelefone": "+351 212345678",
"strTelemovel": "+351 912345678",
"strEmail": "[email protected]",
"strMorada_lin1": "Rua A, 100",
"strMorada_lin2": "Parque Industrial",
"strLocalidade": "Leiria",
"strPostal": "2400-000",
"strAbrevSubZona": "LRA",
"bitUseElectronicDocument": "1",
"strCodCondPag": "30",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "1",
"intCodVendedor": "101",
"strObs": "Cliente preferencial.",
"dtmAbertura": "2024-05-10T10:00:00Z",
"dtmAlteracao": "2025-01-02T09:00:00Z"
}'{
"success": 1,
"message": "Cliente atualizado",
"errormsg": "string",
"Id": 74,
"data": {
"Id": "2001",
"intCodigo": "2001",
"strNome": "Loja Exemplo, Lda",
"strNumContrib": "PT123456789",
"bitConsumidorFinal": "0",
"strTelefone": "+351 212345678",
"strTelemovel": "+351 912345678",
"strEmail": "[email protected]",
"strMorada_lin1": "Rua A, 100",
"strMorada_lin2": "Parque Industrial",
"strLocalidade": "Leiria",
"strPostal": "2400-000",
"strAbrevSubZona": "LRA",
"bitUseElectronicDocument": "1",
"strCodCondPag": "30",
"bitPortalWeb": "0",
"intSinalTp": "0",
"intCodCatEntidade": "1",
"bitAviso_vencimento": "1",
"intCodVendedor": "101",
"strObs": "Cliente preferencial.",
"dtmAbertura": "2024-05-10T10:00:00Z",
"dtmAlteracao": "2025-01-02T09:00:00Z"
}
}{
"success": 0,
"errormsg": "Cliente não encontrado"
}Clientes - Contactos
Consulta de contactos associados a clientes.
GET Contactos de cliente indisponível
/clientes/{intCodCliente}/contactosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
intCodCliente | path | string | obrigatório |
strCodTpContacto | query | string | |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Detalhes da entidade contactos cliente — array<contacto>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes/5/contactos' \
-H 'X-Api-Key: <a-sua-chave>'[
{
"strChaveEntidade": 2001,
"Id": 5,
"intCodContacto": "C-05",
"strNome": "Ana Silva",
"strCargo": "Compras",
"intCodEntRelacionada": "",
"strNomeEndereco": "Armazém Loja Exemplo",
"strMorada1": "Rua A, 100",
"strMorada2": "",
"strLocalidade": "Leiria",
"strCodPostal": "2400-000",
"strTelEmpresa": "+351 212345678",
"strTelemovel": "+351 912345678",
"strEmail1": "[email protected]",
"strEmail2": "",
"strWebsite": "https://www.lojaexemplo.pt",
"dtmNascimento": "1990-07-21",
"intNumLinha": 1,
"imgFoto": "",
"strCodTpContacto": "GERAL",
"strTelParticular": "+351 912345678",
"strObservacoes": "",
"strLoginAbertura": "api",
"strLoginAlteracao": "api",
"strAbrevZona": "CEN",
"strAbrevSubzona": "LRA",
"strNumContrib": "PT123456789",
"bitInactivo": 0,
"intTipoEntidade": 1,
"dtmAbertura": "2025-01-02 09:00:00.000",
"dtmAlteracao": "2025-01-15 10:30:00.000"
}
]{
"success": 0,
"errormsg": "Acesso inválido"
}Fornecedores
Gestão de fornecedores no ERP.
GET Listar fornecedores
/fornecedoresParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de fornecedores paginada — DataTables<fornecedores>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 5,
"iTotalDisplayRecords": 5,
"aaData": [
{
"Id": "11",
"intCodigo": "5",
"strNome": "encontro de contas",
"strNumContrib": "504624679",
"strTelefone": null,
"strEmail": null,
"strMorada_lin1": "a",
"strMorada_lin2": null,
"strLocalidade": "a",
"strPostal": "3100-000",
"strAbrevSubZona": "LSB",
"intCodCatEntidade": "1",
"strCodCondPag": null,
"strObs": null,
"dtmAbertura": "2016-03-18 00:00:00",
"dtmAlteracao": "2016-03-18 00:00:00"
},
{
"Id": "10",
"intCodigo": "4",
"strNome": "EUROCOVER",
"strNumContrib": "234876999",
"strTelefone": "888888888",
"strEmail": "HFYDGEJ@FGHJK",
"strMorada_lin1": "RUA DA ESQUINA",
"strMorada_lin2": null,
"strLocalidade": "LOURES",
"strPostal": "2788-344",
"strAbrevSubZona": "LSB",
"intCodCatEntidade": "2",
"strCodCondPag": null,
"strObs": null,
"dtmAbertura": "2016-02-04 00:00:00",
"dtmAlteracao": "2016-02-04 00:00:00"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar fornecedor
/fornecedoresCorpo do pedido application/json fornecedor
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do fornecedor. ex.: 3001 |
intCodigo | string | Código do fornecedor. ex.: 3001 |
strNome | string | Nome do fornecedor. ex.: Fornecedor Exemplo, Lda |
strNumContrib | string | NIF/VAT do fornecedor. ex.: PT500108668 |
strTelefone | string | nullableTelefone. ex.: +351 212345678 |
strEmail | string | nullableEmail principal. ex.: [email protected] |
strMorada_lin1 | string | Morada (linha 1). ex.: Rua B, 50 |
strMorada_lin2 | string | nullableMorada (linha 2). ex.: Zona Industrial |
strLocalidade | string | Localidade. ex.: Leiria |
strPostal | string | Código postal. ex.: 2400-111 |
strAbrevSubZona | string | Subzona/rota comercial. ex.: LRA |
strCodCondPag | string | nullableCódigo das condições de pagamento. ex.: 30 |
intCodCatEntidade | string | Código da categoria de entidade. ex.: 1 |
strObs | string | nullableObservações gerais. |
dtmAbertura | string date-time | Data de abertura. ex.: 2025-01-02 09:00:00.000 |
dtmAlteracao | string date-time | Data de alteração. ex.: 2025-01-15 10:30:00.000 |
Respostas
- 200 Artigo criado com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/fornecedores' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "3001",
"intCodigo": "3001",
"strNome": "Fornecedor Exemplo, Lda",
"strNumContrib": "PT500108668",
"strTelefone": "+351 212345678",
"strEmail": "[email protected]",
"strMorada_lin1": "Rua B, 50",
"strMorada_lin2": "Zona Industrial",
"strLocalidade": "Leiria",
"strPostal": "2400-111",
"strAbrevSubZona": "LRA",
"strCodCondPag": "30",
"intCodCatEntidade": "1",
"strObs": "",
"dtmAbertura": "2025-01-02 09:00:00.000",
"dtmAlteracao": "2025-01-15 10:30:00.000"
}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Código existente"
}GET Detalhe de fornecedor
/fornecedores/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 200 Detalhes da entidade fornecedor — array<fornecedor>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores/10457' \
-H 'X-Api-Key: <a-sua-chave>'[
{
"Id": "11",
"intCodigo": "5",
"strNome": "encontro de contas",
"strNumContrib": "504624679",
"strTelefone": null,
"strEmail": null,
"strMorada_lin1": "a",
"strMorada_lin2": null,
"strLocalidade": "a",
"strPostal": "3100-000",
"strAbrevSubZona": "LSB",
"strCodCondPag": null,
"intCodCatEntidade": "1",
"strObs": null,
"dtmAbertura": "2016-03-18 00:00:00",
"dtmAlteracao": "2016-03-18 00:00:00"
}
]{
"success": 0,
"errormsg": "Acesso inválido"
}Fornecedores - Contactos
Consulta de contactos associados a fornecedores.
GET Contactos de fornecedor indisponível
/fornecedores/{intCodigo}/contactosGET /fornecedores?act=contactos&num={intCodigo} (devolve o mesmo array).Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
intCodigo | path | string | obrigatório |
strCodTpContacto | query | string | |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Detalhes da entidade contactos fornecedor — array<contacto>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores/5/contactos' \
-H 'X-Api-Key: <a-sua-chave>'[
{
"strChaveEntidade": 2001,
"Id": 5,
"intCodContacto": "C-05",
"strNome": "Ana Silva",
"strCargo": "Compras",
"intCodEntRelacionada": "",
"strNomeEndereco": "Armazém Loja Exemplo",
"strMorada1": "Rua A, 100",
"strMorada2": "",
"strLocalidade": "Leiria",
"strCodPostal": "2400-000",
"strTelEmpresa": "+351 212345678",
"strTelemovel": "+351 912345678",
"strEmail1": "[email protected]",
"strEmail2": "",
"strWebsite": "https://www.lojaexemplo.pt",
"dtmNascimento": "1990-07-21",
"intNumLinha": 1,
"imgFoto": "",
"strCodTpContacto": "GERAL",
"strTelParticular": "+351 912345678",
"strObservacoes": "",
"strLoginAbertura": "api",
"strLoginAlteracao": "api",
"strAbrevZona": "CEN",
"strAbrevSubzona": "LRA",
"strNumContrib": "PT123456789",
"bitInactivo": 0,
"intTipoEntidade": 1,
"dtmAbertura": "2025-01-02 09:00:00.000",
"dtmAlteracao": "2025-01-15 10:30:00.000"
}
]{
"success": 0,
"errormsg": "Acesso inválido"
}Artigos
Gestão de artigos no ERP.
GET Listar artigos
/artigosq + searchField; por retrocompatibilidade, searchField=strCodArtigo é tratado como alias de strCodigo.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
srchType | query | string equal · not-equal · endswith · startswith | Tipo de comparação a aplicar entre searchField e q. Só é suportado nos endpoints que implementam pesquisa avançada; nos restantes, a API usa correspondência exata.ex.: startswith |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de artigos paginada — DataTables<artigoListagem>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/artigos?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 10,
"iTotalDisplayRecords": 10,
"aaData": [
{
"Id": "247",
"strCodigo": "1.00001",
"intCodInterno": "10002",
"strCodBarras": "5606032200637",
"strAbreviatura": "",
"strCodCategoria": "3",
"strTpArtigo": null,
"strDescricao": "Skimer Boca Curta para Betao",
"fltPCReferencia": ".000000",
"intCodTaxaIvaVenda": "3",
"intCodTaxaIvaCompra": "3",
"strAbrevMedStk": "Un",
"bitNaoMovStk": "0",
"precos": {
"intNumero": "1",
"fltPreco": "300.000000",
"intTpIVA": "0"
},
"bitEVSujeito": "0",
"precosCusto": null,
"familias": {
"strCodFamilia": "1",
"strCodTpNivel": "1"
},
"stocks": [
{
"strCodArmazem": "1",
"fltStockQtd": "-1.000000",
"fltStockReservado": ".000000"
}
]
},
{
"Id": "246",
"strCodigo": "123",
"intCodInterno": "9",
"strCodBarras": "0000000000093",
"strAbreviatura": "",
"strCodCategoria": "3",
"strTpArtigo": null,
"strDescricao": "3333",
"fltPCReferencia": ".000000",
"intCodTaxaIvaVenda": "3",
"intCodTaxaIvaCompra": "3",
"strAbrevMedStk": "Un",
"bitNaoMovStk": "0",
"precos": null,
"bitEVSujeito": "0",
"precosCusto": null,
"familias": null,
"stocks": []
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar artigo
/artigosCorpo do pedido application/json artigo
34 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do artigo. ex.: 12345 |
strCodigo | string | Código único do artigo. ex.: ART-0001 |
intCodInterno | string | Código interno do artigo. ex.: 987 |
strCodBarras | string | nullableCódigo de barras principal do artigo. ex.: 5601234567890 |
strAbreviatura | string | Abreviatura/alias do artigo. ex.: ART1 |
strCodCategoria | string | Código da categoria associada. ex.: CAT-10 |
strTpArtigo | string | nullableTipo de artigo (ex. M – Mercadoria, S – Serviço). ex.: M |
strDescricao | string | Descrição do artigo. ex.: Camisola 100% algodão |
fltPCReferencia | string | Preço de custo de referência. ex.: 8.75 |
intCodTaxaIvaVenda | string | Código da taxa de IVA a aplicar na venda. ex.: 23 |
intCodTaxaIvaCompra | string | Código da taxa de IVA a aplicar na compra. ex.: 23 |
strAbrevMedStk | string | Unidade de medida para stock. ex.: UN |
strAbrevMedVnd | string | Unidade de medida para venda. ex.: UN |
strAbrevMedCmp | string | Unidade de medida para compra. ex.: UN |
bitNaoMovStk | string | 1 se não movimenta stock; 0 caso contrário. ex.: 0 |
imgImagem | string | Imagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia. |
precos | array<object> | nullableLinhas de preços por tabela. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em precos; no detalhe devolve a coleção completa. |
intNumero | string | Identificador/linha de tabela de preços. ex.: 1 |
fltPreco | string | Preço para a tabela indicada. ex.: 12.99 |
intTpIVA | string | Código/tipo de IVA associado ao preço. ex.: 23 |
precosCusto | object | nullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir. |
fltPCMedio | string | Preço de custo médio. ex.: 8.5 |
fltPCUltimo | string | Último preço de custo. ex.: 8.75 |
fltPCMaoObra | string | Custo de mão de obra. ex.: 1.25 |
fltPCMaquina | string | Custo de máquina. ex.: 0.5 |
fltQuantTotal | string | Quantidade total considerada no custo. ex.: 100 |
fltCostTotal | string | Custo total. ex.: 875 |
familias | array<object> | nullableAssociações do artigo a famílias/níveis. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em familias; no detalhe devolve a coleção completa. |
strCodFamilia | string | Código da família. ex.: FAM-ROUPA |
strCodTpNivel | string | Tipo de nível/estrutura da família. ex.: N1 |
stocks | array<object> | Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia. |
strCodArmazem | string | Código do armazém. ex.: ARM-01 |
fltStockQtd | string | Quantidade em stock. ex.: 150 |
fltStockReservado | string | Quantidade reservada. ex.: 10 |
Respostas
- 200 Artigo criado com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/artigos' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "12345",
"strCodigo": "ART-0001",
"intCodInterno": "987",
"strCodBarras": "5601234567890",
"strAbreviatura": "ART1",
"strCodCategoria": "CAT-10",
"strTpArtigo": "M",
"strDescricao": "Camisola 100% algodão",
"fltPCReferencia": "8.75",
"intCodTaxaIvaVenda": "23",
"intCodTaxaIvaCompra": "23",
"strAbrevMedStk": "UN",
"strAbrevMedVnd": "UN",
"strAbrevMedCmp": "UN",
"bitNaoMovStk": "0",
"imgImagem": "",
"precos": [
{
"intNumero": "1",
"fltPreco": "12.99",
"intTpIVA": "23"
}
],
"precosCusto": {
"fltPCMedio": "8.5",
"fltPCUltimo": "8.75",
"fltPCMaoObra": "1.25",
"fltPCMaquina": "0.5",
"fltQuantTotal": "100",
"fltCostTotal": "875"
},
"familias": [
{
"strCodFamilia": "FAM-ROUPA",
"strCodTpNivel": "N1"
}
],
"stocks": [
{
"strCodArmazem": "ARM-01",
"fltStockQtd": "150",
"fltStockReservado": "10"
}
]
}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Artigo existente"
}GET Detalhe de artigo
/artigos/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 404 Registo inexistente (
success=0,errormsg). — object - 200 Detalhes da entidade artigo — artigo
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/artigos/10457' \
-H 'X-Api-Key: <a-sua-chave>'{
"Id": "247",
"strCodigo": "1.00001",
"intCodInterno": "10002",
"strCodBarras": "5606032200637",
"strAbreviatura": "",
"strCodCategoria": "3",
"strTpArtigo": null,
"strDescricao": "Skimer Boca Curta para Betao",
"fltPCReferencia": ".000000",
"intCodTaxaIvaVenda": "3",
"intCodTaxaIvaCompra": "3",
"strAbrevMedStk": "Un",
"strAbrevMedVnd": "Un",
"strAbrevMedCmp": "Un",
"bitNaoMovStk": "0",
"imgImagem": "",
"precos": [
{
"intNumero": "1",
"fltPreco": "300.000000",
"intTpIVA": "0"
},
{
"intNumero": "2",
"fltPreco": "250.000000",
"intTpIVA": "0"
}
],
"precosCusto": null,
"familias": [
{
"strCodFamilia": "1",
"strCodTpNivel": "1"
},
{
"strCodFamilia": "1.2",
"strCodTpNivel": "2"
}
],
"stocks": [
{
"strCodArmazem": "1",
"fltStockQtd": "-1.000000",
"fltStockReservado": ".000000"
}
]
}{
"success": 0,
"errormsg": "registo inexistente"
}PATCH Atualizar artigo
/artigos/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Corpo do pedido application/json artigo
34 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do artigo. ex.: 12345 |
strCodigo | string | Código único do artigo. ex.: ART-0001 |
intCodInterno | string | Código interno do artigo. ex.: 987 |
strCodBarras | string | nullableCódigo de barras principal do artigo. ex.: 5601234567890 |
strAbreviatura | string | Abreviatura/alias do artigo. ex.: ART1 |
strCodCategoria | string | Código da categoria associada. ex.: CAT-10 |
strTpArtigo | string | nullableTipo de artigo (ex. M – Mercadoria, S – Serviço). ex.: M |
strDescricao | string | Descrição do artigo. ex.: Camisola 100% algodão |
fltPCReferencia | string | Preço de custo de referência. ex.: 8.75 |
intCodTaxaIvaVenda | string | Código da taxa de IVA a aplicar na venda. ex.: 23 |
intCodTaxaIvaCompra | string | Código da taxa de IVA a aplicar na compra. ex.: 23 |
strAbrevMedStk | string | Unidade de medida para stock. ex.: UN |
strAbrevMedVnd | string | Unidade de medida para venda. ex.: UN |
strAbrevMedCmp | string | Unidade de medida para compra. ex.: UN |
bitNaoMovStk | string | 1 se não movimenta stock; 0 caso contrário. ex.: 0 |
imgImagem | string | Imagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia. |
precos | array<object> | nullableLinhas de preços por tabela. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em precos; no detalhe devolve a coleção completa. |
intNumero | string | Identificador/linha de tabela de preços. ex.: 1 |
fltPreco | string | Preço para a tabela indicada. ex.: 12.99 |
intTpIVA | string | Código/tipo de IVA associado ao preço. ex.: 23 |
precosCusto | object | nullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir. |
fltPCMedio | string | Preço de custo médio. ex.: 8.5 |
fltPCUltimo | string | Último preço de custo. ex.: 8.75 |
fltPCMaoObra | string | Custo de mão de obra. ex.: 1.25 |
fltPCMaquina | string | Custo de máquina. ex.: 0.5 |
fltQuantTotal | string | Quantidade total considerada no custo. ex.: 100 |
fltCostTotal | string | Custo total. ex.: 875 |
familias | array<object> | nullableAssociações do artigo a famílias/níveis. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em familias; no detalhe devolve a coleção completa. |
strCodFamilia | string | Código da família. ex.: FAM-ROUPA |
strCodTpNivel | string | Tipo de nível/estrutura da família. ex.: N1 |
stocks | array<object> | Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia. |
strCodArmazem | string | Código do armazém. ex.: ARM-01 |
fltStockQtd | string | Quantidade em stock. ex.: 150 |
fltStockReservado | string | Quantidade reservada. ex.: 10 |
Respostas
- 200 Atualização da entidade artigo — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X PATCH 'https://api.erpsinc.pt/v1.0.0/artigos/10457' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "12345",
"strCodigo": "ART-0001",
"intCodInterno": "987",
"strCodBarras": "5601234567890",
"strAbreviatura": "ART1",
"strCodCategoria": "CAT-10",
"strTpArtigo": "M",
"strDescricao": "Camisola 100% algodão",
"fltPCReferencia": "8.75",
"intCodTaxaIvaVenda": "23",
"intCodTaxaIvaCompra": "23",
"strAbrevMedStk": "UN",
"strAbrevMedVnd": "UN",
"strAbrevMedCmp": "UN",
"bitNaoMovStk": "0",
"imgImagem": "",
"precos": [
{
"intNumero": "1",
"fltPreco": "12.99",
"intTpIVA": "23"
}
],
"precosCusto": {
"fltPCMedio": "8.5",
"fltPCUltimo": "8.75",
"fltPCMaoObra": "1.25",
"fltPCMaquina": "0.5",
"fltQuantTotal": "100",
"fltCostTotal": "875"
},
"familias": [
{
"strCodFamilia": "FAM-ROUPA",
"strCodTpNivel": "N1"
}
],
"stocks": [
{
"strCodArmazem": "ARM-01",
"fltStockQtd": "150",
"fltStockReservado": "10"
}
]
}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Artigo não encontrado"
}Referências
Gestão de referências de artigos no ERP.
GET Listar referências
/referenciasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
srchType | query | string equal · not-equal · endswith · startswith | Tipo de comparação a aplicar entre searchField e q. Só é suportado nos endpoints que implementam pesquisa avançada; nos restantes, a API usa correspondência exata.ex.: startswith |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de referências paginada — DataTables<referencia>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/referencias?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 1,
"iTotalDisplayRecords": 1,
"aaData": [
{
"Id": "8",
"strCodigo": "COMB",
"strAbreviatura": "",
"strCodCategoria": "4",
"strTpArtigo": null,
"strDescricao": "GASOLEO",
"strDescricaoCompl": "",
"intTpComposicao": "0",
"bitInactivo": "0",
"intCodTaxaIvaVenda": "4",
"intCodTaxaIvaCompra": "4",
"dtmAbertura": "2015-02-19 00:00:00",
"dtmAlteracao": "2015-02-19 00:00:00",
"strAbrevMedStk": "Un",
"strAbrevMedVnd": "Un",
"bitNaoMovStk": "1",
"strObs": "",
"strCodGrelhaHor": "1",
"strCodGrelhaVer": null,
"intTpPreco": "0",
"artigos": [
{
"Id": "157",
"IdArtigo": "239",
"strCodArtigo": "COMBLIG.",
"strDescricao": "GASOLEOLIGEIRO PASSAGEIROS",
"strCodGrelhaHorLin": "LIG.",
"strCodGrelhaVerLin": "",
"stock": 0
},
{
"Id": "158",
"IdArtigo": "240",
"strCodArtigo": "COMBMERC.",
"strDescricao": "GASOLEOLIGEIRO MERCADORIAS",
"strCodGrelhaHorLin": "MERC.",
"strCodGrelhaVerLin": "",
"stock": 0
},
{
"Id": "159",
"IdArtigo": "241",
"strCodArtigo": "COMBPES.",
"strDescricao": "GASOLEOPESADO MERCADORIAS",
"strCodGrelhaHorLin": "PES.",
"strCodGrelhaVerLin": "",
"stock": 0
}
],
"familias": [],
"precos": []
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}Encomendas
Gestão de encomendas no ERP.
GET Listar encomendas
/encomendaslist de encomendas.php, aceita os parâmetros q, searchField, strAbrevTpDoc, strCodSeccao e strCodExercicio.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
strAbrevTpDoc | query | string | Tipo de documento |
strCodSeccao | query | string | Código da secção |
strCodExercicio | query | string | Código do exercício |
Respostas
- 200 Devolve uma lista de encomendas paginada — DataTables<encomenda>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/encomendas?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 4,
"iTotalDisplayRecords": 4,
"aaData": [
{
"Id": "105",
"strCodSeccao": "1",
"strAbrevTpDoc": "ENCCL",
"strCodExercicio": "2020",
"intNumero": "3",
"strNumero": "2",
"strNumExterno": "999999",
"dtmData": "2020-02-25 00:00:00",
"strHora": "12:35:53",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "3",
"intDireccao": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "1",
"strNumRequisicao": "1222234",
"dtmDataRequisicao": "2020-02-25 00:00:00",
"dtmDataVencimento": "2020-02-25 00:00:00",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "2",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strObs": "Obs Texto",
"strECVDNumContrib": "504624679",
"strECVDNome": "GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA",
"strECVDMorada": "CALDAS DA RAINHA",
"strECVDLocalidade": "CALDAS DA RAINHA",
"strECVDCodPostal": "2500-000",
"strECVDTelefone": null,
"bitECVDRetIRS": "0",
"intCodVendedor": "1",
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"bitComissaoDispLiq": "0",
"dtmComissaoDataDisp": "2020-02-25 00:00:00",
"intTpComissaoDescontos": "0",
"bitIvaIncluido": "1",
"bitRegimeVenda": "0",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "36.590000",
"fltTotalMercadoriaCIVA": "45.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVAIncidencia1": "36.590000",
"fltIVAIncidencia2": ".000000",
"fltIVAValor1": "8.410000",
"fltIVAValor2": ".000000",
"fltTotalIVA": "8.410000",
"fltSubTotal": "36.590000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "45.000000",
"fltTotalPagamentos": ".000000",
"fltTroco": ".000000",
"strAplicacaoOrigem": "ENCP",
"dtmDataAbertura": "2020-02-25 12:35:53.000",
"dtmDataAlteracao": "2020-02-25 12:35:53.000",
"strCodRubrica": null,
"bitArrImpostos": "1",
"dtmDataEntregaCab": "2020-02-25 00:00:00",
"strHoraEntregaCab": "12:35",
"intCodCatEntidade": null,
"intLinhaPreco": "0",
"dtmDataEstado": "2020-02-25 00:00:00",
"strObsEstado": "Teste de Observaçao estado",
"strCodEstadoDoc": "1",
"fltTotalToPay": "45.000000",
"strMotivoIsencao": "",
"strLogin": "Gonçalo",
"strLoginCriacao": "Gonçalo",
"strLoginEstado": "Gonçalo",
"dtmDataAlteracaoEstado": "2020-02-25 12:35:53.000",
"linhas": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "ENCCL",
"strCodExercicio": "2020",
"intNumero": "3",
"intNumLinha": "1",
"intTpLinha": "5",
"strCodArmazem": null,
"strCodArtigo": "MODRF",
"strDescArtigo": "MÃO-DE-OBRA C/ RF IRS",
"strCodLote": null,
"fltQuantidade": "1.000000",
"fltQuantidadePend": "1.000000",
"fltQuantidadeAnul": ".000000",
"fltQuantidadeSatisf": ".000000",
"intNumLinhaReserva": "1",
"fltQtdReservarStk": ".000000",
"fltPrecoUnitario": "45.000000",
"strCodClassMovStk": "10",
"strObs": null,
"fltDesconto1": ".000000",
"fltDesconto2": ".000000",
"fltDesconto3": ".000000",
"fltDescontoValorUnit": ".000000",
"fltDescontoValor": ".000000",
"fltValorLiquido": "36.590000",
"intCodTaxaIVA": "3",
"fltTaxaIVA": "23.000000",
"fltComissaoPerc": ".000000",
"fltComissaoValor": ".000000",
"fltComissaoLinha": ".000000",
"fltValorMercadoriaCIVA": "45.000000",
"fltValorMercadoriaSIVA": "36.590000",
"fltValorDescontosCIVA": ".000000",
"fltValorDescontosSIVA": ".000000",
"fltValorDescontosFinCIVA": ".000000",
"fltValorDescontosFinSIVA": ".000000",
"fltValorAPagar": "45.000000",
"Id": "344",
"CA_Campo01": null,
"strMotivoIsencaoIVA": "",
"strCodOficialMotIVAIsencao": ""
}
]
},
{
"Id": "104",
"strCodSeccao": "1",
"strAbrevTpDoc": "ENCCL",
"strCodExercicio": "2020",
"intNumero": "2",
"strNumero": "2",
"strNumExterno": "999999",
"dtmData": "2020-02-25 00:00:00",
"strHora": "12:35:53",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "3",
"intDireccao": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "1",
"strNumRequisicao": "1222234",
"dtmDataRequisicao": "2020-02-25 00:00:00",
"dtmDataVencimento": "2020-02-25 00:00:00",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "2",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strObs": "Obs Texto",
"strECVDNumContrib": "504624679",
"strECVDNome": "GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA",
"strECVDMorada": "CALDAS DA RAINHA",
"strECVDLocalidade": "CALDAS DA RAINHA",
"strECVDCodPostal": "2500-000",
"strECVDTelefone": null,
"bitECVDRetIRS": "0",
"intCodVendedor": "1",
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"bitComissaoDispLiq": "0",
"dtmComissaoDataDisp": "2020-02-25 00:00:00",
"intTpComissaoDescontos": "0",
"bitIvaIncluido": "1",
"bitRegimeVenda": "0",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "36.590000",
"fltTotalMercadoriaCIVA": "45.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalO
… (exemplo truncado){
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar encomenda
/encomendasCorpo do pedido application/json encomenda
91 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador da encomenda. ex.: 7001 |
strCodSeccao | string | Secção. ex.: VND |
strAbrevTpDoc | string | Tipo de doc (abreviado). ex.: ENC |
strCodExercicio | string | Exercício. ex.: 2025 |
intNumero | string | Número interno. ex.: 45 |
strNumero | string | Número formatado. ex.: ENC/2025/00045 |
strNumExterno | string | Número externo do cliente. ex.: PO-984 |
dtmData | string date | Data do documento. ex.: 2025-11-07 |
strHora | string time | Hora do documento. ex.: 11:30:00 |
bitAnulado | string | 1 se anulado; 0 caso contrário. ex.: 0 |
intTpEntidade | string | Tipo de entidade (1=Cliente, etc.). ex.: 1 |
intCodEntidade | string | Código da entidade. ex.: 2001 |
intDireccao | string | Direção (1=Entrada, -1=Saída). ex.: -1 |
fltDescontoCab | string | Desconto de cabeçalho (% ou valor consoante regra). ex.: 0 |
fltDescontoFin | string | Desconto financeiro. ex.: 0 |
strCodCondPag | string | Condições de pagamento. ex.: 30D |
strNumRequisicao | string | Nº da requisição. |
dtmDataRequisicao | string date | Data da requisição. |
dtmDataVencimento | string date | Data de vencimento. ex.: 2025-12-07 |
strAbrevSubZona | string | Subzona/rota. ex.: LRA |
strAbrevMoeda | string | Moeda. ex.: EUR |
fltCambio | string | Câmbio. ex.: 1.0 |
strMeioExpedicao | string | Meio de expedição. ex.: Camião |
strLocalCarga | string | Local de carga. ex.: Armazém A |
strLocalDescarga | string | Local de descarga. ex.: Cliente |
strObs | string | Observações. ex.: Entregar em palete. |
strECVDNumContrib | string | NIF na morada de entrega. ex.: PT123456789 |
strECVDNome | string | Nome na morada de entrega. ex.: Loja Exemplo |
strECVDMorada | string | Morada de entrega. ex.: Rua X, 1 |
strECVDLocalidade | string | Localidade de entrega. ex.: Leiria |
strECVDCodPostal | string | Código postal de entrega. ex.: 2400-000 |
strECVDTelefone | string | nullableTelefone de entrega. ex.: +351 212345678 |
bitECVDRetIRS | string | 1 se retém IRS. ex.: 0 |
intCodVendedor | string | Vendedor responsável. ex.: 201 |
intTpComissao | string | Tipo de comissão. ex.: 0 |
fltComissaoValor | string | Valor de comissão. ex.: 0 |
fltComissaoPercent | string | Percentagem de comissão. ex.: 0 |
fltComissaoPenaliz | string | Penalização de comissão. ex.: 0 |
fltComissaoValorBase | string | Base de cálculo de comissão. ex.: 0 |
bitComissaoDispLiq | string | Disponibiliza comissão na liquidação. ex.: 0 |
dtmComissaoDataDisp | string date | Data de disponibilização da comissão. |
intTpComissaoDescontos | string | Regras de descontos para comissão. ex.: 0 |
bitIvaIncluido | string | 1 se preços incluem IVA. ex.: 0 |
bitRegimeVenda | string | Regime de venda. ex.: 0 |
fltInfTotalArtigos | string | Nº artigos distintos. ex.: 3 |
fltInfTotalLinhas | string | Nº de linhas. ex.: 3 |
fltInfTotalQtd | string | Quantidade total. ex.: 30 |
fltTotalMercadoriaSIVA | string | Total mercadoria sem IVA. ex.: 300 |
fltTotalMercadoriaCIVA | string | Total mercadoria com IVA. ex.: 369 |
fltTotalDescontosSIVA | string | Descontos sem IVA. ex.: 0 |
fltTotalDescontosCIVA | string | Descontos com IVA. ex.: 0 |
fltTotalDescontosFinSIVA | string | Descontos financeiros S/IVA. ex.: 0 |
fltTotalDescontosFinCIVA | string | Descontos financeiros C/IVA. ex.: 0 |
fltTotalOutrosSIVA | string | Outros valores S/IVA. ex.: 0 |
fltTotalOutrosCIVA | string | Outros valores C/IVA. ex.: 0 |
fltTotalAcertos | string | Acertos. ex.: 0 |
intIVACodTaxa1 | string | Código taxa IVA 1. ex.: 23 |
intIVACodTaxa2 | string | Código taxa IVA 2. ex.: 0 |
fltIVATaxa1 | string | Percentagem taxa IVA 1. ex.: 23 |
fltIVATaxa2 | string | Percentagem taxa IVA 2. ex.: 0 |
fltIVAIncidencia1 | string | Incidência IVA 1. ex.: 300 |
fltIVAIncidencia2 | string | Incidência IVA 2. ex.: 0 |
fltIVAValor1 | string | Valor IVA 1. ex.: 69 |
fltIVAValor2 | string | Valor IVA 2. ex.: 0 |
fltTotalIVA | string | Total IVA. ex.: 69 |
fltSubTotal | string | Subtotal. ex.: 300 |
fltIRSTaxa | string | Taxa IRS. ex.: 0 |
fltIRSIncidencia | string | Incidência IRS. ex.: 0 |
fltIRSValorRetido | string | Valor retido IRS. ex.: 0 |
fltTotal | string | Total do documento. ex.: 369 |
fltTotalPagamentos | string | Total de pagamentos registados. ex.: 0 |
fltTroco | string | Troco. ex.: 0 |
strAplicacaoOrigem | string | Aplicação origem. ex.: Integrador-WS |
dtmDataAbertura | string date-time | Data de abertura. ex.: 2025-11-07T11:20:00Z |
dtmDataAlteracao | string date-time | Data de alteração. ex.: 2025-11-07T11:40:00Z |
strCodRubrica | string | nullableRubrica contabilística (quando aplicável). |
bitArrImpostos | string | Indicadores de impostos (bitwise). ex.: 0 |
dtmDataEntregaCab | string date | Data de entrega prevista. ex.: 2025-11-14 |
strHoraEntregaCab | string time | Hora de entrega prevista. ex.: 16:00:00 |
intCodCatEntidade | integer | nullableCategoria da entidade. ex.: 1 |
intLinhaPreco | string | Linha/tabela de preço aplicada. ex.: 1 |
dtmDataEstado | string date-time | Data do estado atual. ex.: 2025-11-07T11:35:00Z |
strObsEstado | string | Observações do estado. |
strCodEstadoDoc | string | Código do estado do documento. ex.: ABERTO |
fltTotalToPay | string | Total a pagar pendente. ex.: 369 |
strMotivoIsencao | string | Motivo de isenção de IVA (quando aplicável). |
strLogin | string | Utilizador. ex.: nsantos |
strLoginCriacao | string | Utilizador de criação. ex.: nsantos |
strLoginEstado | string | Utilizador que alterou o estado. ex.: msousa |
dtmDataAlteracaoEstado | string date-time | Data/hora de alteração de estado. ex.: 2025-11-07T11:38:00Z |
linhas | array<linhaEncomenda> | Linhas da encomenda. |
Respostas
- 200 Encomenda criada com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/encomendas' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{"Id": "7001", "strCodSeccao": "VND", "strAbrevTpDoc": "ENC", "strCodExercicio": "2025", "intNumero": "45", "strNumero": "ENC/2025/00045", "strNumExterno": "PO-984", "dtmData": "2025-11-07", "strHora": "11:30:00", "bitAnulado": "0", "intTpEntidade": "1", "intCodEntidade": "2001", "intDireccao": "-1", "fltDescontoCab": "0", "fltDescontoFin": "0", "strCodCondPag": "30D", "strNumRequisicao": "", "dtmDataRequisicao": "", "dtmDataVencimento": "2025-12-07", "strAbrevSubZona": "LRA", "strAbrevMoeda": "EUR", "fltCambio": "1.0", "strMeioExpedicao": "Camião", "strLocalCarga": "Armazém A", "strLocalDescarga": "Cliente", "strObs": "Entregar em palete.", "strECVDNumContrib": "PT123456789", "strECVDNome": "Loja Exemplo", "strECVDMorada": "Rua X, 1", "strECVDLocalidade": "Leiria", "strECVDCodPostal": "2400-000", "strECVDTelefone": "+351 212345678", "bitECVDRetIRS": "0", "intCodVendedor": "201", "intTpComissao": "0", "fltComissaoValor": "0", "fltComissaoPercent": "0", "fltComissaoPenaliz": "0", "fltComissaoValorBase": "0", "bitComissaoDispLiq": "0", "dtmComissaoDataDisp": "", "intTpComissaoDescontos": "0", "bitIvaIncluido": "0", "bitRegimeVenda": "0", "fltInfTotalArtigos": "3", "fltInfTotalLinhas": "3", "fltInfTotalQtd": "30", "fltTotalMercadoriaSIVA": "300", "fltTotalMercadoriaCIVA": "369", "fltTotalDescontosSIVA": "0", "fltTotalDescontosCIVA": "0", "fltTotalDescontosFinSIVA": "0", "fltTotalDescontosFinCIVA": "0", "fltTotalOutrosSIVA": "0", "fltTotalOutrosCIVA": "0", "fltTotalAcertos": "0", "intIVACodTaxa1": "23", "intIVACodTaxa2": "0", "fltIVATaxa1": "23", "fltIVATaxa2": "0", "fltIVAIncidencia1": "300", "fltIVAIncidencia2": "0", "fltIVAValor1": "69", "fltIVAValor2": "0", "fltTotalIVA": "69", "fltSubTotal": "300", "fltIRSTaxa": "0", "fltIRSIncidencia": "0", "fltIRSValorRetido": "0", "fltTotal": "369", "fltTotalPagamentos": "0", "fltTroco": "0", "strAplicacaoOrigem": "Integrador-WS", "dtmDataAbertura": "2025-11-07T11:20:00Z", "dtmDataAlteracao": "2025-11-07T11:40:00Z", "strCodRubrica": "", "bitArrImpostos": "0", "dtmDataEntregaCab": "2025-11-14", "strHoraEntregaCab": "16:00:00", "intCodCatEntidade": 1, "intLinhaPreco": "1", "dtmDataEstado": "2025-11-07T11:35:00Z", "strObsEstado": "", "strCodEstadoDoc": "ABERTO", "fltTotalToPay": "369", "strMotivoIsencao": "", "strLogin": "nsantos", "strLoginCriacao": "nsantos", "strLoginEstado": "msousa", "dtmDataAlteracaoEstado": "2025-11-07T11:38:00Z", "linhas": [{"Id": "1", "intNumLinha": "1", "intTpLinha": "1", "strCodArmazem": "ARM-01", "strCodArtigo": "ART-0001", "strDescArtigo": "T-Shirt Azul M", "strCodLote": "", "fltQuantidade": "10", "fltQuantidadeAnul": "0", "fltQuantidadeSatisf": "0", "intNumLinhaReserva": "0", "fltQtdReservarStk": "10", "fltPrecoUnitario": "10", "strCodClassMovStk": "SAI", "fltDesconto1": "0", "fltDesconto2": "0", "fltDesconto3": "0", "fltDescontoValorUnit": "0", "fltDescontoValor": "0", "fltValorLiquido": "100", "intCodTaxaIVA": "23", "fltTaxaIVA": "23", "fltComissaoPerc": "0", "fltComissaoValor": "0", "fltComissaoLinha": "0", "fltValorMercadoriaCIVA": "123", "fltValorMercadoriaSIVA": "100", "fltValorDescontosCIVA": "0", "fltValorDescontosSIVA": "0", "fltValorDescontosFinCIVA": "0", "fltValorDescontosFinSIVA": "0", "fltValorAPagar": "123", "CA_Campo01": "", "strMotivoIsencaoIVA": "", "strCodOficialMotIVAIsencao": ""}]}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Entidade inválida"
}GET Detalhe de encomenda
/encomendas/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 404 Registo inexistente (
success=0,errormsg). — object - 200 Detalhes da entidade encomenda — encomenda
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/encomendas/10457' \
-H 'X-Api-Key: <a-sua-chave>'{
"Id": "105",
"strCodSeccao": "1",
"strAbrevTpDoc": "ENCCL",
"strCodExercicio": "2020",
"intNumero": "3",
"strNumero": "2",
"strNumExterno": "999999",
"dtmData": "2020-02-25 00:00:00",
"strHora": "12:35:53",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "3",
"intDireccao": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "1",
"strNumRequisicao": "1222234",
"dtmDataRequisicao": "2020-02-25 00:00:00",
"dtmDataVencimento": "2020-02-25 00:00:00",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "2",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strObs": "Obs Texto",
"strECVDNumContrib": "504624679",
"strECVDNome": "GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA",
"strECVDMorada": "CALDAS DA RAINHA",
"strECVDLocalidade": "CALDAS DA RAINHA",
"strECVDCodPostal": "2500-000",
"strECVDTelefone": null,
"bitECVDRetIRS": "0",
"intCodVendedor": "1",
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"bitComissaoDispLiq": "0",
"dtmComissaoDataDisp": "2020-02-25 00:00:00",
"intTpComissaoDescontos": "0",
"bitIvaIncluido": "1",
"bitRegimeVenda": "0",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "36.590000",
"fltTotalMercadoriaCIVA": "45.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVAIncidencia1": "36.590000",
"fltIVAIncidencia2": ".000000",
"fltIVAValor1": "8.410000",
"fltIVAValor2": ".000000",
"fltTotalIVA": "8.410000",
"fltSubTotal": "36.590000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "45.000000",
"fltTotalPagamentos": ".000000",
"fltTroco": ".000000",
"strAplicacaoOrigem": "ENCP",
"dtmDataAbertura": "2020-02-25 12:35:53.000",
"dtmDataAlteracao": "2020-02-25 12:35:53.000",
"strCodRubrica": null,
"bitArrImpostos": "1",
"dtmDataEntregaCab": "2020-02-25 00:00:00",
"strHoraEntregaCab": "12:35",
"intCodCatEntidade": null,
"intLinhaPreco": "0",
"dtmDataEstado": "2020-02-25 00:00:00",
"strObsEstado": "Teste de Observaçao estado",
"strCodEstadoDoc": "1",
"fltTotalToPay": "45.000000",
"strMotivoIsencao": "",
"strLogin": "Gonçalo",
"strLoginCriacao": "Gonçalo",
"strLoginEstado": "Gonçalo",
"dtmDataAlteracaoEstado": "2020-02-25 12:35:53.000",
"intPrintCount": "0",
"linhas": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "ENCCL",
"strCodExercicio": "2020",
"intNumero": "3",
"intNumLinha": "1",
"intTpLinha": "5",
"strCodArmazem": null,
"strCodArtigo": "MODRF",
"strDescArtigo": "MÃO-DE-OBRA C/ RF IRS",
"strCodLote": null,
"fltQuantidade": "1.000000",
"fltQuantidadePend": "1.000000",
"fltQuantidadeAnul": ".000000",
"fltQuantidadeSatisf": ".000000",
"intNumLinhaReserva": "1",
"fltQtdReservarStk": ".000000",
"fltPrecoUnitario": "45.000000",
"strCodClassMovStk": "10",
"strObs": null,
"fltDesconto1": ".000000",
"fltDesconto2": ".000000",
"fltDesconto3": ".000000",
"fltDescontoValorUnit": ".000000",
"fltDescontoValor": ".000000",
"fltValorLiquido": "36.590000",
"intCodTaxaIVA": "3",
"fltTaxaIVA": "23.000000",
"fltComissaoPerc": ".000000",
"fltComissaoValor": ".000000",
"fltComissaoLinha": ".000000",
"fltValorMercadoriaCIVA": "45.000000",
"fltValorMercadoriaSIVA": "36.590000",
"fltValorDescontosCIVA": ".000000",
"fltValorDescontosSIVA": ".000000",
"fltValorDescontosFinCIVA": ".000000",
"fltValorDescontosFinSIVA": ".000000",
"fltValorAPagar": "45.000000",
"Id": "344",
"CA_Campo01": null,
"strMotivoIsencaoIVA": "",
"strCodOficialMotIVAIsencao": ""
}
]
}{
"success": 0,
"errormsg": "registo inexistente"
}Compras
Gestão de compras no ERP.
GET Listar compras
/comprasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
strAbrevTpDoc | query | string | Tipo de documento |
strCodSeccao | query | string | Código da secção |
strCodExercicio | query | string | Código do exercício |
Respostas
- 200 Devolve uma lista de compras paginada — DataTables<compra>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/compras?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 21,
"iTotalDisplayRecords": 21,
"aaData": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "V/FAC",
"strCodExercicio": "2015",
"intNumero": "2",
"strNumero": "2",
"strNumExterno": "2",
"dtmData": "2015-08-13",
"bitAnulado": "0",
"intTpEntidade": "2",
"intCodEntidade": "3",
"intCompraEncargo": "0",
"bitDocEncargos": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "1",
"dtmDataVencimento": "2015-08-13 00:00:00",
"strCodEstadoDoc": null,
"intMercado": "1",
"strAbrevSubZona": "ES",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strNumRequisicao": "",
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"dtmDataCarga": "2015-08-13 00:00:00",
"strHoraCarga": "12:28",
"strViatura": null,
"strObs": null,
"bitUrgente": "0",
"strFCDNumContrib": "ESA123456",
"strFCDNome": "INTRACOMUNITARIO",
"strFCDMorada": "A",
"strFCDCodPostal": "1000-000",
"strFCDTelefone": null,
"bitFCDRetIRS": "0",
"strCodRubrica": "CMP",
"bitIvaIncluido": "0",
"fltTotalPagamentos": "5000.000000",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltEncargosValorSIVA": ".000000",
"fltEncargosValorCIVA": ".000000",
"fltEncargosDescontosSIVA": ".000000",
"fltEncargosDescontosCIVA": ".000000",
"fltEncargosIVA": ".000000",
"fltEncargosIRS": ".000000",
"fltEncargosIRSIncid": ".000000",
"fltEncargosTotal": ".000000",
"fltEncargosPorDistribuir": ".000000",
"fltEncargosDistribuido": ".000000",
"fltTotalMercadoriaSIVA": "5000.000000",
"fltTotalMercadoriaCIVA": "6150.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"intIVACodTaxa3": "-1",
"intIVACodTaxa4": "-1",
"intIVACodTaxa5": "-1",
"intIVACodTaxa6": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVATaxa3": ".000000",
"fltIVATaxa4": ".000000",
"fltIVATaxa5": ".000000",
"fltIVATaxa6": ".000000",
"fltIVAIncidencia1": "5000.000000",
"fltIVAIncidencia2": ".000000",
"fltIVAIncidencia3": ".000000",
"fltIVAIncidencia4": ".000000",
"fltIVAIncidencia5": ".000000",
"fltIVAIncidencia6": ".000000",
"fltIVAValor1": "1150.000000",
"fltIVAValor2": ".000000",
"fltIVAValor3": ".000000",
"fltIVAValor4": ".000000",
"fltIVAValor5": ".000000",
"fltIVAValor6": ".000000",
"fltTotalIVA": "1150.000000",
"fltSubTotal": "3850.000000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "5000.000000",
"strAplicacaoOrigem": "CMPP",
"strLogin": "vasco",
"fltValorPago": ".000000",
"fltValorPendente": "5000.000000",
"intSinal": "1",
"bitConversao": "0",
"bitConvertido": "0",
"dtmDataAbertura": "2015-08-13 12:28:21.000",
"dtmDataAlteracao": "2016-02-29 12:09:29.000",
"UpdateStamp": "\u0000\u0000\u0000\u0000\u0000/��",
"Id": "133",
"fltValorIVARegPago": ".000000",
"fltIncidenciaIVARegPago": ".000000",
"fltIVAValorND1": ".000000",
"fltIVAValorND2": ".000000",
"fltIVAValorND3": ".000000",
"fltIVAValorND4": ".000000",
"fltIVAValorND5": ".000000",
"fltIVAValorND6": ".000000",
"fltTotalIVAND": ".000000",
"strIntraCodEntrega": null,
"strIntraCodPais": null,
"strIntraDescPais": null,
"intIntraModTrans": "0",
"strIntraTpTrans": null,
"strIntraCodTrans": null,
"intIntraNatA": "0",
"intIntraNatB": "0",
"intDireccao": "0",
"bitArrImpostos": "1",
"strForteAbrevMoeda": null,
"fltForteCambio": ".000000000000000000",
"bitForteDifCambial": "0",
"bitEVLiquidoComEcovalor": "0",
"fltEVTotalPilhas": ".000000",
"fltEVTotalPneus": ".000000",
"fltEVTotalOleos": ".000000",
"fltEVTotalREEE": ".000000",
"fltEVTotalDAutor": ".000000",
"fltEVTotalNaoDefinido": ".000000",
"fltEVTotal": ".000000",
"bitEVEntidadeIsenta": "1",
"strFEDadosRecep": null,
"bitEfectuaInversaoIVA": "0",
"bitExigivelIVA": "0",
"fltValorIVAPendente": ".000000",
"intCodCatEntidade": "1",
"strFCDLocalidade": "A",
"strHash": "0",
"intHashControl": "0",
"bitUpdateIntegrador": "0",
"bitDocOrigemWEB": "0",
"dtmDataEstado": "2015-08-13 00:00:00",
"strObsEstado": null,
"dtmDataAlteracaoEstado": "2015-08-13 12:28:21.000",
"strLoginEstado": "vasco",
"strATDocCodeID": null,
"strLoginCriacao": "vasco",
"intATDocCodeStatus": null,
"strATDocCodeStatus": null,
"bitCargaEnderecoAdicional": "0",
"strCargaMorada": null,
"strCargaLocalidade": null,
"strCargaCodPostal": null,
"strCargaCodPais": null,
"bitDescargaEnderecoAdicional": "0",
"strDescargaMorada": null,
"strDescargaLocalidade": null,
"strDescargaCodPostal": null,
"strDescargaCodPais": null,
"bitAddYearIdDocAT": null,
"strSaftDocNO": null,
"dtmDataLancamento": "2015-08-13 00:00:00",
"dtmDataMovCTE": "2015-08-13 00:00:00",
"dtmDataMovSTK": "2015-08-13 00:00:00",
"bitIvaCaixaVencido": "0",
"bitIvaCaixaVencidoDC": "0",
"fltDocumentSumTaxes": ".000000",
"fltDocumentSumRetentions": ".000000",
"intTaxTypeCalculation": "0",
"fltValorPagoCmp": ".000000",
"bitGenerateAutomaticSettlements": "0",
"bitNotCalculateRetentions": "0",
"fltTotalToPay": "5000.000000",
"fltDocSumTaxesExpense": ".000000",
"fltDocSumRetentionsExpense": ".000000",
"bitNotCalculateTotals": "0",
"linhas": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "V/FAC",
"strCodExercicio": "2015",
"intNumero": "2",
"intNumLinha": "1",
"intTpLinha": "5",
"strCodArmazem": "1",
"strCodLocalizacao": null,
"strCodArtigo": "4",
"strDescArtigo": "MERCADORIA",
"strCodLote": null,
"fltQuantidade": "1.000000",
"fltPrecoUnitario": "5000.000000",
"fltCustoUnitario": "5000.000000",
"fltValorEncargosInt": ".000000",
"fltValorEncargosExt": ".000000",
"bitNaoMo
… (exemplo truncado){
"success": 0,
"errormsg": "Acesso inválido"
}POST Importar compras (QR code AT)
/comprasCorpo do pedido application/json compraImportRequest
| Campo | Tipo | Descrição |
|---|---|---|
database | string | Base de dados da empresa. ex.: emp_236 |
strAbrevTpDoc | string | obrigatório ex.: VFA |
strCodSeccao | string | obrigatório ex.: 1 |
strCodExercicio | string | Por defeito, o exercício da data do documento. |
intNumero | integer | Número interno; por defeito o próximo do numerador. |
strNumero | string | |
intTpEntidade | integer | ex.: 2 |
intCodEntidade | integer | Código do fornecedor; se omitido é procurado pelo NIF (field_A). |
strAbrevMoeda | string | ex.: EUR |
intSinal | integer | |
fltSubTotal | number | |
fltInfTotalQtd | number | por omissão: 1 |
fltInfTotalLinhas | number | |
fltInfTotalArtigos | number | por omissão: 1 |
documents | array<compraImportDocument> | |
document | compraImportDocument |
Respostas
- 200 Resultado da importação por documento — compraImportResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/compras' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{"database": "emp_236", "strAbrevTpDoc": "VFA", "strCodSeccao": "1", "strCodExercicio": "string", "intNumero": 1, "strNumero": "string", "intTpEntidade": 2, "intCodEntidade": 1, "strAbrevMoeda": "EUR", "intSinal": 1, "fltSubTotal": 1.0, "fltInfTotalQtd": 1, "fltInfTotalLinhas": 1.0, "fltInfTotalArtigos": 1, "documents": [{"field_A": "509999999", "field_F": "2026-11-12", "field_G": "FT 2026A/1543", "field_H": "string", "field_I": 1.0, "field_I3": 1.0, "field_I4": 1.0, "field_I5": 1.0, "field_I6": 1.0, "field_I7": 1.0, "field_I8": 1.0, "field_J": "string", "field_K": "string", "field_N": 1.0, "field_O": 123.0, "field_Q": "string", "field_R": "string", "field_S": "string", "field_T": "string", "strCodExercicio": "string", "intNumero": 1, "strNumero": "string", "linhas": [{"PRODUCT_CODE": "string", "ITEM": "string", "QUANTITY": 1, "UNIT_PRICE": 100.0, "PRICE": 123.0, "PRICE_VAT": 100.0, "IVA_TAXA": 23}], "line_items": [{"PRODUCT_CODE": "string", "ITEM": "string", "QUANTITY": 1, "UNIT_PRICE": 100.0, "PRICE": 123.0, "PRICE_VAT": 100.0, "IVA_TAXA": 23}]}], "document": {"field_A": "509999999", "field_F": "2026-11-12", "field_G": "FT 2026A/1543", "field_H": "string", "field_I": 1.0, "field_I3": 1.0, "field_I4": 1.0, "field_I5": 1.0, "field_I6": 1.0, "field_I7": 1.0, "field_I8": 1.0, "field_J": "string", "field_K": "string", "field_N": 1.0, "field_O": 123.0, "field_Q": "string", "field_R": "string", "field_S": "string", "field_T": "string", "strCodExercicio": "string", "intNumero": 1, "strNumero": "string", "linhas": [{"PRODUCT_CODE": "string", "ITEM": "string", "QUANTITY": 1, "UNIT_PRICE": 100.0, "PRICE": 123.0, "PRICE_VAT": 100.0, "IVA_TAXA": 23}], "line_items": [{"PRODUCT_CODE": "string", "ITEM": "string", "QUANTITY": 1, "UNIT_PRICE": 100.0, "PRICE": 123.0, "PRICE_VAT": 100.0, "IVA_TAXA": 23}]}}'{
"success": 1,
"resultado": {
"novo": [
"string"
],
"exist": [
"string"
],
"error": [
"string"
]
},
"errormsg": "string"
}{
"success": 0,
"errormsg": "Secção e tipo de documento são obrigatórios."
}GET Detalhe de compra
/compras/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 404 Registo inexistente (
success=0,errormsg). — object - 200 Detalhes da entidade compras — compra
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/compras/10457' \
-H 'X-Api-Key: <a-sua-chave>'{
"strCodSeccao": "1",
"strAbrevTpDoc": "V/FAC",
"strCodExercicio": "2015",
"intNumero": "2",
"strNumero": "2",
"strNumExterno": "2",
"dtmData": "2015-08-13 00:00:00",
"bitAnulado": "0",
"intTpEntidade": "2",
"intCodEntidade": "3",
"intCompraEncargo": "0",
"bitDocEncargos": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "1",
"dtmDataVencimento": "2015-08-13 00:00:00",
"strCodEstadoDoc": null,
"intMercado": "1",
"strAbrevSubZona": "ES",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strNumRequisicao": "",
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"dtmDataCarga": "2015-08-13 00:00:00",
"strHoraCarga": "12:28",
"strViatura": null,
"strObs": null,
"bitUrgente": "0",
"strFCDNumContrib": "ESA123456",
"strFCDNome": "INTRACOMUNITARIO",
"strFCDMorada": "A",
"strFCDCodPostal": "1000-000",
"strFCDTelefone": null,
"bitFCDRetIRS": "0",
"strCodRubrica": "CMP",
"bitIvaIncluido": "0",
"fltTotalPagamentos": "5000.000000",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltEncargosValorSIVA": ".000000",
"fltEncargosValorCIVA": ".000000",
"fltEncargosDescontosSIVA": ".000000",
"fltEncargosDescontosCIVA": ".000000",
"fltEncargosIVA": ".000000",
"fltEncargosIRS": ".000000",
"fltEncargosIRSIncid": ".000000",
"fltEncargosTotal": ".000000",
"fltEncargosPorDistribuir": ".000000",
"fltEncargosDistribuido": ".000000",
"fltTotalMercadoriaSIVA": "5000.000000",
"fltTotalMercadoriaCIVA": "6150.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"intIVACodTaxa3": "-1",
"intIVACodTaxa4": "-1",
"intIVACodTaxa5": "-1",
"intIVACodTaxa6": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVATaxa3": ".000000",
"fltIVATaxa4": ".000000",
"fltIVATaxa5": ".000000",
"fltIVATaxa6": ".000000",
"fltIVAIncidencia1": "5000.000000",
"fltIVAIncidencia2": ".000000",
"fltIVAIncidencia3": ".000000",
"fltIVAIncidencia4": ".000000",
"fltIVAIncidencia5": ".000000",
"fltIVAIncidencia6": ".000000",
"fltIVAValor1": "1150.000000",
"fltIVAValor2": ".000000",
"fltIVAValor3": ".000000",
"fltIVAValor4": ".000000",
"fltIVAValor5": ".000000",
"fltIVAValor6": ".000000",
"fltTotalIVA": "1150.000000",
"fltSubTotal": "3850.000000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "5000.000000",
"strAplicacaoOrigem": "CMPP",
"strLogin": "vasco",
"fltValorPago": ".000000",
"fltValorPendente": "5000.000000",
"intSinal": "1",
"bitConversao": "0",
"bitConvertido": "0",
"dtmDataAbertura": "2015-08-13 12:28:21.000",
"dtmDataAlteracao": "2016-02-29 12:09:29.000",
"UpdateStamp": "\u0000\u0000\u0000\u0000\u0000/��",
"Id": "133",
"fltValorIVARegPago": ".000000",
"fltIncidenciaIVARegPago": ".000000",
"fltIVAValorND1": ".000000",
"fltIVAValorND2": ".000000",
"fltIVAValorND3": ".000000",
"fltIVAValorND4": ".000000",
"fltIVAValorND5": ".000000",
"fltIVAValorND6": ".000000",
"fltTotalIVAND": ".000000",
"strIntraCodEntrega": null,
"strIntraCodPais": null,
"strIntraDescPais": null,
"intIntraModTrans": "0",
"strIntraTpTrans": null,
"strIntraCodTrans": null,
"intIntraNatA": "0",
"intIntraNatB": "0",
"intDireccao": "0",
"bitArrImpostos": "1",
"strForteAbrevMoeda": null,
"fltForteCambio": ".000000000000000000",
"bitForteDifCambial": "0",
"bitEVLiquidoComEcovalor": "0",
"fltEVTotalPilhas": ".000000",
"fltEVTotalPneus": ".000000",
"fltEVTotalOleos": ".000000",
"fltEVTotalREEE": ".000000",
"fltEVTotalDAutor": ".000000",
"fltEVTotalNaoDefinido": ".000000",
"fltEVTotal": ".000000",
"bitEVEntidadeIsenta": "1",
"strFEDadosRecep": null,
"bitEfectuaInversaoIVA": "0",
"bitExigivelIVA": "0",
"fltValorIVAPendente": ".000000",
"intCodCatEntidade": "1",
"strFCDLocalidade": "A",
"strHash": "0",
"intHashControl": "0",
"bitUpdateIntegrador": "0",
"bitDocOrigemWEB": "0",
"dtmDataEstado": "2015-08-13 00:00:00",
"strObsEstado": null,
"dtmDataAlteracaoEstado": "2015-08-13 12:28:21.000",
"strLoginEstado": "vasco",
"strATDocCodeID": null,
"strLoginCriacao": "vasco",
"intATDocCodeStatus": null,
"strATDocCodeStatus": null,
"bitCargaEnderecoAdicional": "0",
"strCargaMorada": null,
"strCargaLocalidade": null,
"strCargaCodPostal": null,
"strCargaCodPais": null,
"bitDescargaEnderecoAdicional": "0",
"strDescargaMorada": null,
"strDescargaLocalidade": null,
"strDescargaCodPostal": null,
"strDescargaCodPais": null,
"bitAddYearIdDocAT": null,
"strSaftDocNO": null,
"dtmDataLancamento": "2015-08-13 00:00:00",
"dtmDataMovCTE": "2015-08-13 00:00:00",
"dtmDataMovSTK": "2015-08-13 00:00:00",
"bitIvaCaixaVencido": "0",
"bitIvaCaixaVencidoDC": "0",
"fltDocumentSumTaxes": ".000000",
"fltDocumentSumRetentions": ".000000",
"intTaxTypeCalculation": "0",
"fltValorPagoCmp": ".000000",
"bitGenerateAutomaticSettlements": "0",
"bitNotCalculateRetentions": "0",
"fltTotalToPay": "5000.000000",
"fltDocSumTaxesExpense": ".000000",
"fltDocSumRetentionsExpense": ".000000",
"bitNotCalculateTotals": "0",
"intPrintCount": "0",
"strMoradaLin2": null,
"strMotivoIsencao": null,
"str1MotivoIsencao": null,
"str1CodOficialMotIVAIsencao": null,
"strFCDEmail": null,
"bitPartiallyIntegrated": "0",
"strATCUD": null,
"strQRCODE": null,
"dtmDataExpFactAT": null,
"bitIsCancellationOrRectification": "0",
"bitAnuladoAnt": "0",
"bitCostsByExitCosting": "0",
"bitCompensationAllLines": "0",
"bitNotPrintsPricesAndTaxes": "0",
"fltRetentionReductedOutstandingValue": ".000000",
"fltRetentionReductedOutstandingValuePend": ".000000",
"bitFullyCompensatedSourceDocs": "0",
"strStateTaxNumber": null,
"strOperationType": null,
"linhas": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "V/FAC",
"strCodExercicio": "2015",
"intNumero": "2",
"intNumLinha": "1",
"intTpLinha": "5",
"strCodArmazem": "1",
"strCodLocalizacao": null,
"strCodArtigo": "4",
"strDescArtigo": "MERCADORIA",
"strCodLote": null,
"fltQuantidade": "1.000000",
"fltPrecoUnitario": "5000.000000",
"fltCustoUnitario": "5000.000000",
"fltValorEncargosInt": ".000000",
"fltValorEncargosExt": ".000000",
"bitNaoMovStk": "0",
"bitConversao": "0",
"intNumLinhaEncargo": "1",
"strCodClassMovStk": null,
"intTipoAssociacao": "0",
"intLinhaAssociacao": "0",
"intLinhaReferencia": "0",
"bitSujeit
… (exemplo truncado){
"success": 0,
"errormsg": "registo inexistente"
}Vendas
Gestão de vendas no ERP.
GET Listar vendas
/vendasact=getDetail com num.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
srchType | query | string equal · not-equal · endswith · startswith | Tipo de comparação a aplicar entre searchField e q. Só é suportado nos endpoints que implementam pesquisa avançada; nos restantes, a API usa correspondência exata.ex.: startswith |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
strAbrevTpDoc | query | string | Tipo de documento |
act | query | string | acção |
num | query | integer | ID interno do registo para detalhe (act=getDetail) |
docType | query | array<string> | Lista de tipos de documento para filtrar |
Respostas
- 200 Devolve listagem paginada (DataTables) ou detalhe de venda — DataTables<venda>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/vendas?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 19,
"iTotalDisplayRecords": 19,
"aaData": [
{
"Id": "300",
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2019",
"intNumero": "1",
"strNumero": "FACT 119/1",
"strNumExterno": null,
"dtmData": "2019-10-03",
"strHora": "11:21:34",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "3",
"intDireccao": "1",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "3",
"dtmDataVencimento": "2019-11-02 00:00:00",
"strCodEstadoDoc": null,
"intMercado": "0",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"dtmDataCarga": "2019-10-03 00:00:00",
"strHoraCarga": "11:21",
"strViatura": null,
"strObs": null,
"strCVDNumContrib": "504624679",
"strCVDNome": "GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA",
"strCVDMorada": "ABC",
"strCVDCodPostal": "1000-000",
"strCVDTelefone": null,
"strCVDLocalidade": "DEF",
"strCVDEmail": null,
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"dtmComissaoDataDisp": "2019-10-03 00:00:00",
"intTpComissaoDescontos": "0",
"strCodRubrica": null,
"fltTotalPagamentos": ".000000",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "5.000000",
"fltTotalMercadoriaCIVA": "6.150000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"fltTotalIEC": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"intIVACodTaxa3": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVATaxa3": ".000000",
"fltIVAIncidencia1": "5.000000",
"fltIVAIncidencia2": ".000000",
"fltIVAValor1": "1.150000",
"fltIVAValor2": ".000000",
"fltIVAValor3": ".000000",
"fltTotalIVA": "1.150000",
"fltValorIVARegPago": ".000000",
"fltIncidenciaIVARegPago": ".000000",
"fltSubTotal": "5.000000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "6.150000",
"fltTroco": ".000000",
"fltValorPago": ".000000",
"fltValorPendente": "6.150000",
"intSinal": "1",
"strAplicacaoOrigem": "VNDP",
"strLogin": "vasco2",
"dtmDataAbertura": "2019-10-03 11:21:34.000",
"dtmDataAlteracao": "2019-10-03 11:21:34.000",
"fltSinalPagoEncomenda": ".000000",
"intNumeroPessoas": null,
"dtmDataEntrega": null,
"strAbrevMoedaPagTroco": "EUR",
"intCodVendedor": null,
"fltCambioPagTroco": "1.000000000000000000",
"fltTrocoMoedaDoc": ".000000",
"fltDiferencaArred": ".000000",
"fltTotalValorValeDescontoSIVA": ".000000",
"fltTotalValorValeDescontoCIVA": ".000000",
"intNumValeDescontoEmitido": null,
"strFENumEtiqueta": null,
"fltValorIVAPendente": ".000000",
"strDescritivoPagamento": null,
"intCodCatEntidade": null,
"strHash": "JpymIaZM1JKuawJWcRplhRgekEYtcSx2SYsb3YdoSBMtv4rB9JGoVi7fBeVy+0QvKZfi5fvRXTrkcR5kZZb3IyCJ7HmhpOWYpiXRD7v3hpFQ41bhLh2H3sL9E+F/vP+vtK/eSFSynETFKNfFxALda9ebKtkAaxdjV06AmTDE0yg=",
"intHashControl": "1",
"strCodSecContrato": null,
"strCodTpContrato": null,
"strCodExercContrato": null,
"intNumeroContrato": null,
"intLinhaPreco": "0",
"strMoradaLin2": null,
"dtmDataValidadeContrato": null,
"intEstadoContrato": "0",
"dtmDataEstado": "2019-10-03 00:00:00",
"strObsEstado": null,
"intNumProcessamento": "0",
"intCodEstabHotel": null,
"intNumQuartoHotel": null,
"intLinhaHospede": null,
"strMotivoIsencao": ""
},
{
"Id": "297",
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2016",
"intNumero": "4",
"strNumero": "FACT 116/4",
"strNumExterno": null,
"dtmData": "2016-12-31",
"strHora": "09:11:26",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "5",
"intDireccao": "0",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "3",
"dtmDataVencimento": "2017-01-30 00:00:00",
"strCodEstadoDoc": null,
"intMercado": "0",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"dtmDataCarga": "2016-12-31 00:00:00",
"strHoraCarga": "09:11",
"strViatura": null,
"strObs": null,
"strCVDNumContrib": "CONSUMIDOR FINAL",
"strCVDNome": "TESTE CONSUMIDOR FINAL",
"strCVDMorada": "POIMBAL",
"strCVDCodPostal": "3100-000",
"strCVDTelefone": null,
"strCVDLocalidade": "POMBAL",
"strCVDEmail": null,
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"dtmComissaoDataDisp": "2016-12-31 00:00:00",
"intTpComissaoDescontos": "0",
"strCodRubrica": null,
"fltTotalPagamentos": ".000000",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "1500.000000",
"fltTotalMercadoriaCIVA": "1845.000000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"fltTotalIEC": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"intIVACodTaxa3": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVATaxa3": ".000000",
"fltIVAIncidencia1": "1500.000000",
"fltIVAIncidencia2": ".000000",
"fltIVAValor1": "345.000000",
"fltIVAValor2": ".000000",
"fltIVAValor3": ".000000",
"fltTotalIVA": "345.000000",
"fltValorIVARegPago": ".000000",
"fltIncidenciaIVARegPago": ".000000",
"fltSubTotal": "1500.000000",
"fltIRSTaxa": ".000000",
"
… (exemplo truncado){
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar venda
/vendasCorpo do pedido application/json venda
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | Identificador interno da venda. ex.: 101 |
intNumero | string | Número interno do documento. ex.: 245 |
strAbrevTpDoc | string | Abreviatura do tipo de documento. ex.: FAC |
strCodSeccao | string | Código da secção. ex.: VND |
strCodExercicio | string | Código do exercício. ex.: 2026 |
strNumero | string | Número formatado do documento. ex.: FAC/2026/00245 |
strNumExterno | string | nullableNúmero externo do documento. ex.: WEB-245 |
dtmData | string date | Data do documento. ex.: 2026-03-08 |
intTpEntidade | string | Tipo de entidade. ex.: 1 |
intCodEntidade | string | Código da entidade. ex.: 2001 |
strAbrevSubZona | string | Subzona associada à entidade/documento. ex.: LRA |
strAbrevMoeda | string | Moeda do documento. ex.: EUR |
intCodVendedor | integer | nullableVendedor associado. ex.: 201 |
strObs | string | nullableObservações do documento. |
fltTotal | string | Total do documento. ex.: 123.45 |
strCodEstadoDoc | string | nullableEstado do documento. ex.: ABERTO |
linhas | array<object> | Linhas da venda. |
Respostas
- 200 Venda criada com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/vendas' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"Id": "101",
"intNumero": "245",
"strAbrevTpDoc": "FAC",
"strCodSeccao": "VND",
"strCodExercicio": "2026",
"strNumero": "FAC/2026/00245",
"strNumExterno": "WEB-245",
"dtmData": "2026-03-08",
"intTpEntidade": "1",
"intCodEntidade": "2001",
"strAbrevSubZona": "LRA",
"strAbrevMoeda": "EUR",
"intCodVendedor": 201,
"strObs": "",
"fltTotal": "123.45",
"strCodEstadoDoc": "ABERTO",
"linhas": [
{}
]
}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Campos obrigatórios em falta"
}GET Detalhe de venda
/vendas/{id}act=getDetail&num={id})Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 404 Registo inexistente (
success=0,errormsg). — object - 200 Detalhes da entidade venda — venda
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/vendas/10457' \
-H 'X-Api-Key: <a-sua-chave>'{
"Id": "300",
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2019",
"intNumero": "1",
"strNumero": "FACT 119/1",
"strNumExterno": null,
"dtmData": "2019-10-03 00:00:00",
"strHora": "11:21:34",
"bitAnulado": "0",
"intTpEntidade": "0",
"intCodEntidade": "3",
"intDireccao": "1",
"fltDescontoCab": ".000000",
"fltDescontoFin": ".000000",
"strCodCondPag": "3",
"dtmDataVencimento": "2019-11-02 00:00:00",
"strCodEstadoDoc": null,
"intMercado": "0",
"strAbrevSubZona": "LSB",
"strAbrevMoeda": "EUR",
"fltCambio": "1.000000000000000000",
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"dtmDataCarga": "2019-10-03 00:00:00",
"strHoraCarga": "11:21",
"strViatura": null,
"strObs": null,
"strCVDNumContrib": "504624679",
"strCVDNome": "GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA",
"strCVDMorada": "ABC",
"strCVDCodPostal": "1000-000",
"strCVDTelefone": null,
"strCVDLocalidade": "DEF",
"strCVDEmail": null,
"intTpComissao": "0",
"fltComissaoValor": ".000000",
"fltComissaoPercent": ".000000",
"fltComissaoPenaliz": ".000000",
"fltComissaoValorBase": ".000000",
"dtmComissaoDataDisp": "2019-10-03 00:00:00",
"intTpComissaoDescontos": "0",
"strCodRubrica": null,
"fltTotalPagamentos": ".000000",
"fltInfTotalArtigos": "1.000000",
"fltInfTotalLinhas": "1.000000",
"fltInfTotalQtd": "1.000000",
"fltTotalMercadoriaSIVA": "5.000000",
"fltTotalMercadoriaCIVA": "6.150000",
"fltTotalDescontosSIVA": ".000000",
"fltTotalDescontosCIVA": ".000000",
"fltTotalDescontosFinSIVA": ".000000",
"fltTotalDescontosFinCIVA": ".000000",
"fltTotalOutrosSIVA": ".000000",
"fltTotalOutrosCIVA": ".000000",
"fltTotalAcertos": ".000000",
"fltTotalIEC": ".000000",
"intIVACodTaxa1": "3",
"intIVACodTaxa2": "-1",
"intIVACodTaxa3": "-1",
"fltIVATaxa1": "23.000000",
"fltIVATaxa2": ".000000",
"fltIVATaxa3": ".000000",
"fltIVAIncidencia1": "5.000000",
"fltIVAIncidencia2": ".000000",
"fltIVAValor1": "1.150000",
"fltIVAValor2": ".000000",
"fltIVAValor3": ".000000",
"fltTotalIVA": "1.150000",
"fltValorIVARegPago": ".000000",
"fltIncidenciaIVARegPago": ".000000",
"fltSubTotal": "5.000000",
"fltIRSTaxa": ".000000",
"fltIRSIncidencia": ".000000",
"fltIRSValorRetido": ".000000",
"fltTotal": "6.150000",
"fltTroco": ".000000",
"fltValorPago": ".000000",
"fltValorPendente": "6.150000",
"intSinal": "1",
"strAplicacaoOrigem": "VNDP",
"strLogin": "vasco2",
"dtmDataAbertura": "2019-10-03 11:21:34.000",
"dtmDataAlteracao": "2019-10-03 11:21:34.000",
"fltSinalPagoEncomenda": ".000000",
"intNumeroPessoas": null,
"dtmDataEntrega": null,
"strAbrevMoedaPagTroco": "EUR",
"intCodVendedor": null,
"fltCambioPagTroco": "1.000000000000000000",
"fltTrocoMoedaDoc": ".000000",
"fltDiferencaArred": ".000000",
"fltTotalValorValeDescontoSIVA": ".000000",
"fltTotalValorValeDescontoCIVA": ".000000",
"intNumValeDescontoEmitido": null,
"strFENumEtiqueta": null,
"fltValorIVAPendente": ".000000",
"strDescritivoPagamento": null,
"intCodCatEntidade": null,
"strHash": "JpymIaZM1JKuawJWcRplhRgekEYtcSx2SYsb3YdoSBMtv4rB9JGoVi7fBeVy+0QvKZfi5fvRXTrkcR5kZZb3IyCJ7HmhpOWYpiXRD7v3hpFQ41bhLh2H3sL9E+F/vP+vtK/eSFSynETFKNfFxALda9ebKtkAaxdjV06AmTDE0yg=",
"intHashControl": "1",
"strCodSecContrato": null,
"strCodTpContrato": null,
"strCodExercContrato": null,
"intNumeroContrato": null,
"intLinhaPreco": "0",
"strMoradaLin2": null,
"dtmDataValidadeContrato": null,
"intEstadoContrato": "0",
"dtmDataEstado": "2019-10-03 00:00:00",
"strObsEstado": null,
"intNumProcessamento": "0",
"intCodEstabHotel": null,
"intNumQuartoHotel": null,
"intLinhaHospede": null,
"strMotivoIsencao": "",
"linhas": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2019",
"intNumero": "1",
"intNumLinha": "1",
"intTpLinha": "5",
"strCodArmazem": null,
"strCodLocalizacao": null,
"strCodArtigo": "1",
"strDescArtigo": "GASÓLEO",
"strCodLote": null,
"intEdicao": "0",
"fltQuantidade": "1.000000",
"fltCustoUnitario": "3.000000",
"fltPrecoUnitario": "5.000000",
"fltCustoTotal": "3.000000",
"intConversaoIdNum": "0",
"intTpMargem": "0",
"fltMargemMinima": ".000000",
"strCodClassMovStk": null,
"intTipoAssociacao": "0",
"intLinhaAssociacao": "0",
"intLinhaReferencia": "0",
"strFormula": null,
"fltMedidaQtd": ".000000",
"fltMedida1": ".000000",
"fltMedida2": ".000000",
"fltMedida3": ".000000",
"strCodArmazemOri": null,
"strCodLocalizacaoOri": null,
"fltDesconto1": ".000000",
"fltDesconto2": ".000000",
"fltDesconto3": ".000000",
"fltDescontoValorUnit": ".000000",
"fltDescontoValor": ".000000",
"strDocumOrigem": null,
"fltValorLiquido": "5.000000",
"intCodTaxaIVA": "3"
}
]
}{
"success": 0,
"errormsg": "registo inexistente"
}Stocks
Gestão de movimentos de stock no ERP.
GET Listar movimentos de stock
/stocksParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
strAbrevTpDoc | query | string | Tipo de documento |
strCodSeccao | query | string | Código da secção |
strCodExercicio | query | string | Código do exercício |
Respostas
- 200 Devolve uma lista de encomendas paginada — DataTables<stock>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/stocks?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 33,
"iTotalDisplayRecords": 33,
"aaData": [
{
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2019",
"intNumero": "1",
"strNumero": "FACT 119/1",
"dtmData": "2019-10-03 00:00:00",
"bitAnulado": "0",
"strCodArmazemOriDef": null,
"strCodLocalizacaoOriDef": null,
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strViatura": "",
"strObs": "",
"fltTotal": ".000000",
"UpdateStamp": "00000000002c156d",
"dtmDataAbertura": null,
"dtmDataAlteracao": "2019-10-03 00:00:00",
"Id": "408",
"strLogin": "vasco2",
"strAplicacaoOrigem": "VNDP",
"dtmDataCarga": "2019-10-03 00:00:00",
"strHoraCarga": "00:00",
"strForteAbrevMoeda": null,
"fltForteCambio": ".000000000000000000",
"bitSafeMode": null,
"bitUpdateIntegrador": "0",
"strCodProjectoOrigem": null,
"linhas": [],
"dtmDateDoc": "2019-10-03 00:00:00.000",
"bitCostsByExitCosting": "0",
"intProjectLineOri": null
},
{
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2016",
"intNumero": "4",
"strNumero": "FACT 116/4",
"dtmData": "2016-12-31 00:00:00",
"bitAnulado": "0",
"strCodArmazemOriDef": null,
"strCodLocalizacaoOriDef": null,
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strViatura": "",
"strObs": "",
"fltTotal": ".000000",
"UpdateStamp": "00000000002a4205",
"dtmDataAbertura": null,
"dtmDataAlteracao": "2017-07-06 00:00:00",
"Id": "407",
"strLogin": "vasco2",
"strAplicacaoOrigem": "VNDP",
"dtmDataCarga": "2016-12-31 00:00:00",
"strHoraCarga": "09:11",
"strForteAbrevMoeda": null,
"fltForteCambio": ".000000000000000000",
"bitSafeMode": null,
"bitUpdateIntegrador": "0",
"strCodProjectoOrigem": null,
"linhas": [],
"dtmDateDoc": null,
"bitCostsByExitCosting": "0",
"intProjectLineOri": null
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Criar movimento de stock
/stocksCorpo do pedido application/json stock
33 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador único do registo de stock. ex.: 501 |
strCodSeccao | string | Código da secção/departamento. ex.: Geral |
strAbrevTpDoc | string | Abreviatura do tipo de documento (ENT_A, SAI_B). ex.: ENT_A |
strCodExercicio | string | Código do exercício (ano). ex.: 2025 |
intNumero | string | Número interno do documento. ex.: 123 |
strNumero | string | Número formatado do documento. ex.: ENT_A/2025/00123 |
dtmData | string date-time | Data do documento. ex.: 2025-11-07T10:00:00Z |
bitAnulado | string | Indica se o documento está anulado. ex.: False |
strCodArmazemOriDef | string | nullableArmazém de origem por defeito. ex.: ARM-01 |
strCodLocalizacaoOriDef | string | nullableLocalização de origem por defeito. ex.: A1-01-01 |
strMeioExpedicao | string | nullableMeio de expedição (ex. camião). ex.: Camião |
strLocalCarga | string | Local da carga. ex.: Fábrica A |
strLocalDescarga | string | Local da descarga. ex.: Armazém Central |
strViatura | string | Identificação da viatura. ex.: AA-00-BB |
strObs | string | Observações gerais. ex.: Conferir quantidades na receção. |
fltTotal | string | Total do documento (valor). ex.: 1500.55 |
UpdateStamp | string date-time | Stamp/ETag de atualização. ex.: 2025-11-07T10:01:22Z |
dtmDataAbertura | string date-time | nullableData de abertura. ex.: 2025-11-07T09:55:00Z |
dtmDataAlteracao | string date-time | Data da última alteração. ex.: 2025-11-07T10:05:00Z |
strLogin | string | Utilizador responsável. ex.: nsantos |
strAplicacaoOrigem | string | Aplicação origem. ex.: Integrador-WS |
dtmDataCarga | string date-time | Data/hora de carga no sistema. ex.: 2025-11-07T10:02:00Z |
strHoraCarga | string time | Hora da carga (texto). ex.: 10:02:00 |
strForteAbrevMoeda | string | nullableMoeda forte abreviada. ex.: EUR |
fltForteCambio | string | Taxa de câmbio aplicada. ex.: 1.0 |
bitSafeMode | boolean | nullableDocumento criado em modo seguro. ex.: true |
bitUpdateIntegrador | string | Atualizado via integrador. ex.: True |
strCodProjectoOrigem | string | nullableCódigo do projeto de origem. ex.: PRJ-001 |
intPrintCount | string | Número de impressões. ex.: 2 |
dtmDateDoc | string date-time | nullableData efetiva do documento. ex.: 2025-11-07T00:00:00Z |
bitCostsByExitCosting | string | Custos valorizados por custo de saída. ex.: False |
intProjectLineOri | integer | nullableLinha do projeto de origem. ex.: 0 |
linhas | array<linhaStock> | Linhas do movimento de stock. |
Respostas
- 200 Encomenda criada com sucesso — operacaoResultado
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/stocks' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{"Id": "501", "strCodSeccao": "Geral", "strAbrevTpDoc": "ENT_A", "strCodExercicio": "2025", "intNumero": "123", "strNumero": "ENT_A/2025/00123", "dtmData": "2025-11-07T10:00:00Z", "bitAnulado": "False", "strCodArmazemOriDef": "ARM-01", "strCodLocalizacaoOriDef": "A1-01-01", "strMeioExpedicao": "Camião", "strLocalCarga": "Fábrica A", "strLocalDescarga": "Armazém Central", "strViatura": "AA-00-BB", "strObs": "Conferir quantidades na receção.", "fltTotal": "1500.55", "UpdateStamp": "2025-11-07T10:01:22Z", "dtmDataAbertura": "2025-11-07T09:55:00Z", "dtmDataAlteracao": "2025-11-07T10:05:00Z", "strLogin": "nsantos", "strAplicacaoOrigem": "Integrador-WS", "dtmDataCarga": "2025-11-07T10:02:00Z", "strHoraCarga": "10:02:00", "strForteAbrevMoeda": "EUR", "fltForteCambio": "1.0", "bitSafeMode": true, "bitUpdateIntegrador": "True", "strCodProjectoOrigem": "PRJ-001", "intPrintCount": "2", "dtmDateDoc": "2025-11-07T00:00:00Z", "bitCostsByExitCosting": "False", "intProjectLineOri": 0, "linhas": [{"Id": "1", "strCodSeccao": "Geral", "strAbrevTpDoc": "ENT_A", "strCodExercicio": "2025", "intNumero": "123", "intNumLinha": "1", "strCodArmazem": "ARM-01", "strCodLocalizacao": "A1-01-01", "strCodArtigo": "ART-0001", "strCodLote": "L2025-11", "fltQuantidade": "50", "fltSinal": "1", "fltValorUnitario": "10.5", "fltSubTotal": "525", "strObs": "Receção com palete.", "strCodClassMovStk": "ENT", "intTipoAssociacao": "0", "intLinhaAssociacao": "0", "intLinhaReferencia": "0", "strFormula": "", "fltMedidaQtd": "50", "fltMedida1": "0", "fltMedida2": "0", "fltMedida3": "0", "bitTransferencia": "False", "strCodArmazemOri": "ARM-00", "strCodLocalizacaoOri": "R0-00-00", "dtmDataValor": "2025-11-07T00:00:00Z", "intNumLinhaDocOri": "0", "intNumLinhaDocOriComp": "0", "intEdicao": "1", "CA_Campo01": "", "CA_Campo02": "", "CA_Campo03": "", "CA_Campo04": "", "CA_Campo05": "", "CA_Campo06": "", "CA_Campo07": "", "CA_Campo08": "", "CA_Campo09": "", "CA_Campo10": "", "strCodDepartamento": "LOG", "dtmDataRecStock": "2025-11-07T12:00:00Z", "strCodMarca": "GEN", "strCodModelo": "2025", "strCodVersao": "v1", "strCodNivel": "N1", "intIdDuplicacao": "0", "fltGOPQtdAtribuida": "0", "intNumLinhaOrig": "0", "strCodProjecto": "PRJ-001", "intProjectLine": 0, "fltQtyReserveToStock": "0", "strProjectCodeOri": "", "intProjectLineOri": 0}]}'{
"success": 1,
"message": "Registo criado",
"errormsg": "Código existente",
"Id": 105,
"log": "string"
}{
"success": 0,
"errormsg": "Código existente"
}GET Detalhe de movimento de stock
/stocks/{id}Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
id | path | string | obrigatório |
Respostas
- 404 Registo inexistente (
success=0,errormsg). — object - 200 Detalhes da entidade stock — stock
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/stocks/10457' \
-H 'X-Api-Key: <a-sua-chave>'{
"strCodSeccao": "1",
"strAbrevTpDoc": "FACT",
"strCodExercicio": "2019",
"intNumero": "1",
"strNumero": "FACT 119/1",
"dtmData": "2019-10-03 00:00:00",
"bitAnulado": "0",
"strCodArmazemOriDef": null,
"strCodLocalizacaoOriDef": null,
"strMeioExpedicao": "1",
"strLocalCarga": "Morada do remetente",
"strLocalDescarga": "Morada do destinatário",
"strViatura": "",
"strObs": "",
"fltTotal": ".000000",
"UpdateStamp": "\u0000\u0000\u0000\u0000\u0000,\u0015m",
"dtmDataAbertura": null,
"dtmDataAlteracao": "2019-10-03 00:00:00",
"Id": "408",
"strLogin": "vasco2",
"strAplicacaoOrigem": "VNDP",
"dtmDataCarga": "2019-10-03 00:00:00",
"strHoraCarga": "00:00",
"strForteAbrevMoeda": null,
"fltForteCambio": ".000000000000000000",
"bitSafeMode": null,
"bitUpdateIntegrador": "0",
"strCodProjectoOrigem": null,
"intPrintCount": "0",
"dtmDateDoc": "2019-10-03 00:00:00.000",
"bitCostsByExitCosting": "0",
"intProjectLineOri": null,
"linhas": []
}{
"success": 0,
"errormsg": "registo inexistente"
}Tabelas
Tabelas de estruturas existentes no ERP para consultas diversas.
GET Tabela exercicios
/tabelas/exerciciosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
dtmInicio | query | string date | data de Inicio |
dtmFim | query | string date | data de Fim |
Respostas
- 200 Devolve uma lista de exercicios paginada — DataTables<exercicio>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/exercicios?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 18,
"iTotalDisplayRecords": 18,
"aaData": [
{
"Id": "22",
"strCodigo": "2020",
"dtmInicio": "2020-01-01 00:00:00.000",
"dtmFim": "2020-12-31 00:00:00.000"
},
{
"Id": "21",
"strCodigo": "2019",
"dtmInicio": "2019-01-01 00:00:00.000",
"dtmFim": "2019-12-31 00:00:00.000"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela zonas
/tabelas/zonasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de zonas paginada — DataTables<zona>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/zonas?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 4,
"iTotalDisplayRecords": 4,
"aaData": [
{
"Id": "4",
"strAbreviatura": "AMER",
"strDescricao": "América do Norte",
"strAbrevPais": null
},
{
"Id": "3",
"strAbreviatura": "UE",
"strDescricao": "União Europeia",
"strAbrevPais": "UE"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela subzonas
/tabelas/subzonasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de subzonas paginada — DataTables<subzona>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/subzonas?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 8,
"iTotalDisplayRecords": 8,
"aaData": [
{
"Id": "8",
"strAbreviatura": "PRT",
"strDescricao": "PORTO",
"strAbrevPais": "PT",
"strAbrevZona": "NORTE"
},
{
"Id": "7",
"strAbreviatura": "RU",
"strDescricao": "INGLATERRA",
"strAbrevPais": "GB",
"strAbrevZona": "UE"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela taxasiva
/tabelas/taxasivaParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de taxas de iva paginada — DataTables<taxasiva>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/taxasiva?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 9,
"iTotalDisplayRecords": 9,
"aaData": [
{
"Id": "10",
"intCodigo": "9",
"strDescricao": "IVA COMBUST NÃO DEDUTÍVEL",
"fltTaxa": "23.000000",
"strCodISONorma2": "PT"
},
{
"Id": "9",
"intCodigo": "8",
"strDescricao": "Não sujeito",
"fltTaxa": ".000000",
"strCodISONorma2": "PT"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela cat-entidades
/tabelas/cat-entidadesParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de categorias de entidades paginada — DataTables<catentidades>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/cat-entidades?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 6,
"iTotalDisplayRecords": 6,
"aaData": [
{
"Id": "6",
"intCodigo": "6",
"strDescricao": "ENTIDADES - OUTRAS PARTES RELACIONADAS"
},
{
"Id": "5",
"intCodigo": "5",
"strDescricao": "ENTIDADES - EMPREENDIMENTOS CONJUNTOS"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela funcionarios
/tabelas/funcionariosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de categorias de entidades paginada — DataTables<funcionarios>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/funcionarios?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 1,
"iTotalDisplayRecords": 1,
"aaData": [
{
"Id": 101,
"intCodigo": "101",
"strNome": "João Dias"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela vendedores
/tabelas/vendedoresParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de categorias de entidades paginada — DataTables<vendedores>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/vendedores?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 1,
"iTotalDisplayRecords": 1,
"aaData": [
{
"Id": "4",
"intCodigo": "1",
"strNome": "Vendedor Demo",
"strMoradaLin1": "",
"strMoradaLin2": "",
"strLocalidade": "",
"strPostal": "",
"strTelefone": "",
"strBI": "",
"dtmBI": null,
"strArqBI": "",
"strNumContrib": "",
"strAbrevSubZona": "PRT"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela numeradores
/tabelas/numeradoresParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
strAbrevTpDoc | query | string | Tipo de documento |
strCodSeccao | query | string | Código da secção |
strCodExercicio | query | string | Código do exercício |
Respostas
- 200 Devolve uma lista de numeradores paginada — DataTables<numeradores>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/numeradores?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 3590,
"iTotalDisplayRecords": 3590,
"aaData": [
{
"Id": "6746",
"strAbrevTpDoc": "-2",
"strCodSeccao": "-1",
"strCodExercicio": "2020",
"intNum_Mes00": "0",
"intTpNumerador": "25",
"strFormato": "####/!AAAA!"
},
{
"Id": "6745",
"strAbrevTpDoc": "RESHT",
"strCodSeccao": "2",
"strCodExercicio": "2020",
"intNum_Mes00": "0",
"intTpNumerador": "26",
"strFormato": ""
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela familias
/tabelas/familiasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de famílias paginada — DataTables<familia>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/familias?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 6,
"iTotalDisplayRecords": 6,
"aaData": [
{
"Id": "23",
"strCodigo": "1.3",
"strDescricao": "Boca de Impulsão",
"strCodTpFamilia": "2"
},
{
"Id": "22",
"strCodigo": "2.1",
"strDescricao": "Telas Armadas",
"strCodTpFamilia": "2"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela tipofamilias
/tabelas/tipofamiliasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipo de famílias paginada — DataTables<tipofamilia>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tipofamilias?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 2,
"iTotalDisplayRecords": 2,
"aaData": [
{
"Id": "11",
"strCodigo": "2",
"strDescricao": "Sub Familia",
"intNivel": "2"
},
{
"Id": "10",
"strCodigo": "1",
"strDescricao": "Familia",
"intNivel": "1"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela tipoartigos
/tabelas/tipoartigosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipo de artigos paginada — DataTables<tipoartigo>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tipoartigos?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 6,
"iTotalDisplayRecords": 6,
"aaData": [
{
"Id": "6",
"strCodigo": "10",
"strDescricao": "Serviços"
},
{
"Id": "5",
"strCodigo": "5",
"strDescricao": "Revistas, Jornais e Outros"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela meiosexpedicao
/tabelas/meiosexpedicaoParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de meios de expedição paginada — DataTables<meioexpedicao>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/meiosexpedicao?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 3,
"iTotalDisplayRecords": 3,
"aaData": [
{
"Id": "3",
"strCodigo": "3",
"strDescricao": "Transportadora"
},
{
"Id": "2",
"strCodigo": "2",
"strDescricao": "V/Carro"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela categorias
/tabelas/categoriasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de categorias paginada — DataTables<categoria>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/categorias?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 5,
"iTotalDisplayRecords": 5,
"aaData": [
{
"Id": "5",
"strCodigo": "5",
"strDescricao": "Activos Biológicos",
"bitNaoMovStk": "0"
},
{
"Id": "4",
"strCodigo": "4",
"strDescricao": "Serviços",
"bitNaoMovStk": "1"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela tiposcontactos
/tabelas/tiposcontactosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipos de contactos paginada — DataTables<tiposdecontacto>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tiposcontactos?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 4,
"iTotalDisplayRecords": 4,
"aaData": [
{
"Id": "4",
"strCodigo": "4",
"strDescricao": "Responsavel Armazém"
},
{
"Id": "3",
"strCodigo": "3",
"strDescricao": "Distribuição"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela codBarras
/tabelas/codBarrasParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipos decódigos de barras paginada — DataTables<codbarras>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/codBarras?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 1,
"iTotalDisplayRecords": 1,
"aaData": [
{
"Id": 10,
"strCodArtigo": "ART-0001",
"strCodBarras": "5609876543210",
"fltQuantidade": 6
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Tabela tiposDocumentos
/tabelas/tiposDocumentosParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
order | query | string | Ordenação dos resultados (ex Id;DESC) |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Devolve uma lista de tipos de documentos — DataTables<tiposDocumentos>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tiposDocumentos?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 116,
"iTotalDisplayRecords": 116,
"aaData": [
{
"Id": "161",
"strAbreviatura": "ORCEP",
"strDescricao": "Orçamento Apresentar ao Pagador",
"strCodArmazem": null,
"strCodClassMovStk": null,
"intTpEntidade": "0"
},
{
"Id": "160",
"strAbreviatura": "ORCOP",
"strDescricao": "Orçamento Apresentar Pagador",
"strCodArmazem": null,
"strCodClassMovStk": null,
"intTpEntidade": "0"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}GET Configuração da empresa
/tabelas/configEmpresaTbl_Configuracao_Empresa), em formato DataTables.Parâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
limit | query | integer | Número máximo de registos a devolver. Se omitido, a API usa 100 como valor por omissão na maioria dos endpoints de listagem.ex.: 100 |
offset | query | integer | Paginação. Em /contabilidade/* é o número de registos a saltar (offset=100 com limit=100 devolve a 2.ª página). Nos restantes endpoints é o número da página, a começar em 0 (salta offset × limit registos: offset=1 com limit=100 devolve a 2.ª página).ex.: 0 |
q | query | string | Valor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.ex.: ABC-001 |
searchField | query | string | Nome do campo da entidade sobre o qual aplicar o filtro. Tem de corresponder a um campo suportado pelo endpoint; caso contrário, o filtro é ignorado. ex.: strCodigo |
Respostas
- 200 Lista paginada de parâmetros — DataTables<configEmpresa>
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/configEmpresa?limit=100&offset=0' \
-H 'X-Api-Key: <a-sua-chave>'{
"sEcho": 0,
"iTotalRecords": 853,
"iTotalDisplayRecords": 853,
"aaData": [
{
"Id": "1324",
"strValor": "2023-08-19 10:36:13"
},
{
"Id": "1323",
"strValor": "1"
}
]
}{
"success": 0,
"errormsg": "Acesso inválido"
}Anexos Digitais
Consulta de anexos digitais associados a entidades/documentos.
GET Consultar anexos digitais
/anexosdigitaisParâmetros
| Nome | Em | Tipo | Descrição |
|---|---|---|---|
strChave1 | query | string | |
strChave2 | query | string | |
strChave3 | query | string | |
intNumero | query | integer | |
intTipoEntidade | query | integer |
Respostas
- 200 Resultado da consulta de anexos digitais — anexosDigitaisResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X GET 'https://api.erpsinc.pt/v1.0.0/anexosdigitais' \
-H 'X-Api-Key: <a-sua-chave>'{
"success": 1,
"filters": {
"strChave1": null,
"strChave2": null,
"strChave3": null,
"intNumero": null,
"intTipoEntidade": null
},
"totalEntidades": 0,
"totalAnexos": 0,
"entidades": [],
"anexos": []
}{
"success": 0,
"errormsg": "Acesso inválido"
}POST Eliminar anexo digital
/anexosdigitaisact (ex. delete)Corpo do pedido application/json anexosDigitaisActionRequest
| Campo | Tipo | Descrição |
|---|---|---|
act | string delete | obrigatório |
id | string | Identificador (GUID) do anexo digital. ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9 |
idCab | string | Alias de id.ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9 |
Respostas
- 200 Operação executada com sucesso — anexosDigitaisActionResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/anexosdigitais' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"act": "delete",
"id": "D3A30537-8F0C-4C66-BD44-2A5C7682A9F9",
"idCab": "D3A30537-8F0C-4C66-BD44-2A5C7682A9F9"
}'{
"success": 1,
"message": "string",
"errormsg": "string",
"id": "string",
"deletedAnexos": 1,
"deletedEntidades": 1,
"act": "string"
}{
"success": 0,
"errormsg": "Campo obrigatório em falta: id"
}Picker
Operações auxiliares para processos de picker e WebDAV.
POST Operações picker
/pickeract (conferDoc, updateBarcode, webdav, batch)Corpo do pedido application/json pickerRequest
| Campo | Tipo | Descrição |
|---|---|---|
act | string conferDoc · updateBarcode · webdav · batch | obrigatório |
barcode | string | |
erp_code | string | |
cloudDirectory | string | |
server | string | |
fileName | string | |
filename | string | |
mime | string | |
login | string | |
password | string | |
fileContentBase64 | string | |
fileContent | string | |
nomeficheiro | string | |
ficheiro_tipo | string | |
linhas | integer | |
tipo_interno | string | |
tipo | string | |
destinatario | string | |
ficheiro_base64 | string | |
ficheiro_conteudo | string | |
ficheiro | string binary |
Respostas
- 200 Operação executada com sucesso — pickerResponse
- 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com
success=0eerrormsg. — object
curl -X POST 'https://api.erpsinc.pt/v1.0.0/picker' \
-H 'X-Api-Key: <a-sua-chave>' \
-H 'Content-Type: application/json' \
-d '{
"act": "conferDoc",
"barcode": "string",
"erp_code": "string",
"cloudDirectory": "string",
"server": "string",
"fileName": "string",
"filename": "string",
"mime": "string",
"login": "string",
"password": "string",
"fileContentBase64": "string",
"fileContent": "string",
"nomeficheiro": "string",
"ficheiro_tipo": "string",
"linhas": 1,
"tipo_interno": "string",
"tipo": "string",
"destinatario": "string",
"ficheiro_base64": "string",
"ficheiro_conteudo": "string",
"ficheiro": "string"
}'{
"success": 1,
"message": "Código de barras atualizado com sucesso",
"mensagem": "Registo adicionado",
"path": "string",
"debug": {}
}{
"success": 0,
"mensagem": "Nenhum conteúdo recebido."
}Schemas
Estruturas de dados usadas nos pedidos e respostas.
SCHEMA anexosDigitaisActionRequest
| Campo | Tipo | Descrição |
|---|---|---|
act | string delete | obrigatório |
id | string | Identificador (GUID) do anexo digital. ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9 |
idCab | string | Alias de id.ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9 |
SCHEMA anexosDigitaisActionResponse
| Campo | Tipo | Descrição |
|---|---|---|
success | integer | ex.: 1 |
message | string | |
errormsg | string | |
id | string | |
deletedAnexos | integer | |
deletedEntidades | integer | |
act | string |
SCHEMA anexosDigitaisResponse
42 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
success | integer | ex.: 1 |
filters | object | |
strChave1 | string | nullable |
strChave2 | string | nullable |
strChave3 | string | nullable |
intNumero | string | nullable |
intTipoEntidade | string | nullable |
totalEntidades | integer | |
totalAnexos | integer | |
entidades | array<object> | |
idCab | string | nullable |
intTipoEntidade | string | nullable |
strChave1 | string | nullable |
strChave2 | string | nullable |
strChave3 | string | nullable |
intNumero | string | nullable |
strChaveComp | string | nullable |
bitFiscalArchive | string | nullable |
bitFiscalArchiveHist | string | nullable |
strAdicionalDescription | string | nullable |
anexos | array<object> | |
id | string | nullable |
strCodDocumentacao | string | nullable |
dtmDataEmissao | string | nullable |
strRef | string | nullable |
strObs | string | nullable |
strLocal | string | nullable |
intCodSituacao | string | nullable |
dtmDataSituacao | string | nullable |
strLogin | string | nullable |
strIdFicheiro | string | nullable |
Ficheiro | string byte | nullableConteúdo do ficheiro em Base64. |
bitIsForSend | string | nullable |
bitWithElectronicSignature | string | nullable |
AutoId | string | nullable |
strCtrlConsistency | string | nullable |
bitConsistent | string | nullable |
strDocArchiveNumber | string | nullable |
bitDocArchiveNumber | string | nullable |
bitFromInbox | string | nullable |
strDocInfo | string | nullable |
errormsg | string |
SCHEMA artigo
artigos.php.35 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do artigo. ex.: 12345 |
strCodigo | string | Código único do artigo. ex.: ART-0001 |
intCodInterno | string | Código interno do artigo. ex.: 987 |
strCodBarras | string | nullableCódigo de barras principal do artigo. ex.: 5601234567890 |
strAbreviatura | string | Abreviatura/alias do artigo. ex.: ART1 |
strCodCategoria | string | Código da categoria associada. ex.: CAT-10 |
strTpArtigo | string | nullableTipo de artigo (ex. M – Mercadoria, S – Serviço). ex.: M |
strDescricao | string | Descrição do artigo. ex.: Camisola 100% algodão |
fltPCReferencia | string | Preço de custo de referência. ex.: 8.75 |
intCodTaxaIvaVenda | string | Código da taxa de IVA a aplicar na venda. ex.: 23 |
intCodTaxaIvaCompra | string | Código da taxa de IVA a aplicar na compra. ex.: 23 |
strAbrevMedStk | string | Unidade de medida para stock. ex.: UN |
strAbrevMedVnd | string | Unidade de medida para venda. ex.: UN |
strAbrevMedCmp | string | Unidade de medida para compra. ex.: UN |
bitNaoMovStk | string | 1 se não movimenta stock; 0 caso contrário. ex.: 0 |
imgImagem | string | Imagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia. |
precos | array<object> | nullableLinhas de preços por tabela. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em precos; no detalhe devolve a coleção completa. |
intNumero | string | Identificador/linha de tabela de preços. ex.: 1 |
fltPreco | string | Preço para a tabela indicada. ex.: 12.99 |
intTpIVA | string | Código/tipo de IVA associado ao preço. ex.: 23 |
precosCusto | object | nullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir. |
fltPCMedio | string | Preço de custo médio. ex.: 8.5 |
fltPCUltimo | string | Último preço de custo. ex.: 8.75 |
fltPCMaoObra | string | Custo de mão de obra. ex.: 1.25 |
fltPCMaquina | string | Custo de máquina. ex.: 0.5 |
fltQuantTotal | string | Quantidade total considerada no custo. ex.: 100 |
fltCostTotal | string | Custo total. ex.: 875 |
familias | array<object> | nullableAssociações do artigo a famílias/níveis. No GET /artigos, a listagem costuma devolver apenas o primeiro registo em familias; no detalhe devolve a coleção completa. |
strCodFamilia | string | Código da família. ex.: FAM-ROUPA |
strCodTpNivel | string | Tipo de nível/estrutura da família. ex.: N1 |
stocks | array<object> | Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia. |
strCodArmazem | string | Código do armazém. ex.: ARM-01 |
fltStockQtd | string | Quantidade em stock. ex.: 150 |
fltStockReservado | string | Quantidade reservada. ex.: 10 |
bitEVSujeito | string | só leitura ex.: 0 |
SCHEMA artigoListagem
GET /artigos (listagem). Difere do detalhe em precos e familias, que aqui são o primeiro registo (objeto) e não a coleção.35 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do artigo. ex.: 12345 |
strCodigo | string | Código único do artigo. ex.: ART-0001 |
intCodInterno | string | Código interno do artigo. ex.: 987 |
strCodBarras | string | nullableCódigo de barras principal do artigo. ex.: 5601234567890 |
strAbreviatura | string | Abreviatura/alias do artigo. ex.: ART1 |
strCodCategoria | string | Código da categoria associada. ex.: CAT-10 |
strTpArtigo | string | nullableTipo de artigo (ex. M – Mercadoria, S – Serviço). ex.: M |
strDescricao | string | Descrição do artigo. ex.: Camisola 100% algodão |
fltPCReferencia | string | Preço de custo de referência. ex.: 8.75 |
intCodTaxaIvaVenda | string | Código da taxa de IVA a aplicar na venda. ex.: 23 |
intCodTaxaIvaCompra | string | Código da taxa de IVA a aplicar na compra. ex.: 23 |
strAbrevMedStk | string | Unidade de medida para stock. ex.: UN |
strAbrevMedVnd | string | Unidade de medida para venda. ex.: UN |
strAbrevMedCmp | string | Unidade de medida para compra. ex.: UN |
bitNaoMovStk | string | 1 se não movimenta stock; 0 caso contrário. ex.: 0 |
imgImagem | string | Imagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia. |
precos | object | nullablePrimeiro registo de precos (no detalhe GET /artigos/{id} é devolvida a coleção completa). |
intNumero | string | Identificador/linha de tabela de preços. ex.: 1 |
fltPreco | string | Preço para a tabela indicada. ex.: 12.99 |
intTpIVA | string | Código/tipo de IVA associado ao preço. ex.: 23 |
precosCusto | object | nullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir. |
fltPCMedio | string | Preço de custo médio. ex.: 8.5 |
fltPCUltimo | string | Último preço de custo. ex.: 8.75 |
fltPCMaoObra | string | Custo de mão de obra. ex.: 1.25 |
fltPCMaquina | string | Custo de máquina. ex.: 0.5 |
fltQuantTotal | string | Quantidade total considerada no custo. ex.: 100 |
fltCostTotal | string | Custo total. ex.: 875 |
familias | object | nullablePrimeiro registo de familias (no detalhe GET /artigos/{id} é devolvida a coleção completa). |
strCodFamilia | string | Código da família. ex.: FAM-ROUPA |
strCodTpNivel | string | Tipo de nível/estrutura da família. ex.: N1 |
stocks | array<object> | Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia. |
strCodArmazem | string | Código do armazém. ex.: ARM-01 |
fltStockQtd | string | Quantidade em stock. ex.: 150 |
fltStockReservado | string | Quantidade reservada. ex.: 10 |
bitEVSujeito | string | só leitura ex.: 0 |
SCHEMA categoria
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador. ex.: 10 |
strCodigo | string | Código da categoria. ex.: CAT-10 |
strDescricao | string | Descrição da categoria. ex.: Têxtil |
bitNaoMovStk | string | Indicador 'não movimenta stock' (0/1 como string). ex.: 0 |
SCHEMA catentidades
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador. ex.: 1 |
intCodigo | string | Código da categoria. ex.: A |
strDescricao | string | Descrição. ex.: A - Preferencial |
SCHEMA cliente
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador interno do cliente. ex.: 2001 |
intCodigo | string | Código numérico do cliente. ex.: 2001 |
strNome | string | Nome do cliente. ex.: Loja Exemplo, Lda |
strNumContrib | string | NIF/VAT do cliente. ex.: PT123456789 |
bitConsumidorFinal | string | 1 se consumidor final; 0 caso contrário. ex.: 0 |
strTelefone | string | nullableTelefone. ex.: +351 212345678 |
strTelemovel | string | nullableTelemóvel. ex.: +351 912345678 |
strEmail | string | nullableEmail principal. ex.: [email protected] |
strMorada_lin1 | string | Morada (linha 1). ex.: Rua A, 100 |
strMorada_lin2 | string | nullableMorada (linha 2). ex.: Parque Industrial |
strLocalidade | string | Localidade. ex.: Leiria |
strPostal | string | nullableCódigo postal. ex.: 2400-000 |
strAbrevSubZona | string | Subzona/rota comercial. ex.: LRA |
bitUseElectronicDocument | string | 1 se usa documento eletrónico. ex.: 1 |
strCodCondPag | string | nullableCódigo das condições de pagamento. ex.: 30 |
bitPortalWeb | string | 1 se tem acesso ao portal web. ex.: 0 |
intSinalTp | string | Tipo de sinal (quando aplicável). ex.: 0 |
intCodCatEntidade | string | nullableCódigo da categoria de entidade. ex.: 1 |
bitAviso_vencimento | string | 1 se envia aviso de vencimento. ex.: 1 |
intCodVendedor | string | nullableCódigo do vendedor associado. ex.: 101 |
strObs | string | nullableObservações gerais. ex.: Cliente preferencial. |
dtmAbertura | string date-time | Data de abertura. ex.: 2024-05-10T10:00:00Z |
dtmAlteracao | string date-time | Data de alteração. ex.: 2025-01-02T09:00:00Z |
SCHEMA clienteUpdateResponse
| Campo | Tipo | Descrição |
|---|---|---|
success | integer | ex.: 1 |
message | string | ex.: Cliente atualizado |
errormsg | string | |
Id | integer | ex.: 74 |
data | cliente | nullableCliente após a atualização. |
SCHEMA codbarras
| Campo | Tipo | Descrição |
|---|---|---|
Id | integer | obrigatórioIdentificador da linha de código de barras. ex.: 10 |
strCodArtigo | string | Código do artigo. ex.: ART-0001 |
strCodBarras | string | Código de barras. ex.: 5609876543210 |
fltQuantidade | number | Quantidade por código de barras (embalagem). ex.: 6 |
SCHEMA compra
compras.php, incluindo importação por documents/QR.222 campos — mostrar
| Campo | Tipo | Descrição |
|---|---|---|
Id | string | obrigatórioIdentificador da compra. ex.: 8001 |
strCodSeccao | string | Secção. ex.: CMP |
strAbrevTpDoc | string | Tipo de doc (abreviado). ex.: NDC |
strCodExercicio | string | Exercício. ex.: 2025 |
intNumero | string | Número interno. ex.: 12 |
strNumero | string | Número formatado. ex.: NDC/2025/00012 |
strNumExterno | string | Nº do fornecedor. ex.: INV-2025-88 |
dtmData | string date | Data do documento. ex.: 2025-11-06 |
strHora | string time | Hora do documento. ex.: 15:30:00 |
bitAnulado | string | 1 se anulado; 0 caso contrário. ex.: 0 |
intTpEntidade | string | Tipo de entidade (2=Fornecedor, etc.). ex.: 2 |
intCodEntidade | string | Código da entidade. ex.: 3001 |
intDireccao | string | Direção (1=Entrada, -1=Saída). ex.: 1 |
fltDescontoCab | string | Desconto de cabeçalho. ex.: 0 |
fltDescontoFin | string | Desconto financeiro. ex.: 0 |
strCodCondPag | string | Condições de pagamento. ex.: 30D |
strNumRequisicao | string | Nº da requisição. |
dtmDataRequisicao | string date | Data da requisição. |
dtmDataVencimento | string date | Data de vencimento. ex.: 2025-12-06 |
strAbrevSubZona | string | Subzona/rota. ex.: LRA |
strAbrevMoeda | string | Moeda. ex.: EUR |
fltCambio | string | Câmbio. ex.: 1 |
strMeioExpedicao | string | nullableMeio de expedição. ex.: Transportadora |
strLocalCarga | string | nullableLocal de carga. ex.: Fornecedor |
strLocalDescarga | string | nullableLocal de descarga. ex.: Armazém A |
strObs | string | nullableObservações. ex.: Urgente |
strECVDNumContrib | string | NIF no documento do fornecedor. ex.: PT987654321 |
strECVDNome | string | Nome no doc fornecedor. ex.: Fornecedor Exemplo |
strECVDMorada | string | Morada no doc fornecedor. ex.: Av. Y, 10 |
strECVDLocalidade | string | Localidade no doc fornecedor. ex.: Porto |
strECVDCodPostal | string | Código postal. ex.: 4000-000 |
strECVDTelefone | string | Telefone fornecedor. ex.: +351 222222222 |
bitECVDRetIRS | integer | 1 se retém IRS. ex.: 0 |
intCodVendedor | integer | Código do vendedor (se aplicável). ex.: 0 |
intTpComissao | integer | Tipo de comissão. ex.: 0 |
fltComissaoValor | number | Valor de comissão. ex.: 0 |
fltComissaoPercent | number | Percentagem de comissão. ex.: 0 |
fltComissaoPenaliz | number | Penalização de comissão. ex.: 0 |
fltComissaoValorBase | number | Base de comissão. ex.: 0 |
bitComissaoDispLiq | integer | Disponibiliza comissão em liquidação. ex.: 0 |
dtmComissaoDataDisp | string date | Data da disponibilização da comissão. |
intTpComissaoDescontos | integer | Regras de descontos p/ comissão. ex.: 0 |
bitIvaIncluido | string | 1 se preços incluem IVA. ex.: 0 |
bitRegimeVenda | integer | Regime. ex.: 0 |
fltInfTotalArtigos | string | Nº de artigos distintos. ex.: 2 |
fltInfTotalLinhas | string | Nº de linhas. ex.: 2 |
fltInfTotalQtd | string | Quantidade total. ex.: 100 |
fltTotalMercadoriaSIVA | string | Total s/ IVA. ex.: 1000 |
fltTotalMercadoriaCIVA | string | Total c/ IVA. ex.: 1230 |
fltTotalDescontosSIVA | string | Descontos s/ IVA. ex.: 0 |
fltTotalDescontosCIVA | string | Descontos c/ IVA. ex.: 0 |
fltTotalDescontosFinSIVA | string | Desc. financeiros s/ IVA. ex.: 0 |
fltTotalDescontosFinCIVA | string | Desc. financeiros c/ IVA. ex.: 0 |
fltTotalOutrosSIVA | string | Outros s/ IVA. ex.: 0 |
fltTotalOutrosCIVA | string | Outros c/ IVA. ex.: 0 |
fltTotalAcertos | string | Acertos. ex.: 0 |
intIVACodTaxa1 | string | Código taxa IVA 1. ex.: 23 |
intIVACodTaxa2 | string | Código taxa IVA 2. ex.: 0 |
fltIVATaxa1 | string | Percentagem IVA 1. ex.: 23 |
fltIVATaxa2 | string | Percentagem IVA 2. ex.: 0 |
fltIVAIncidencia1 | string | Incidência IVA 1. ex.: 1000 |
fltIVAIncidencia2 | string | Incidência IVA 2. ex.: 0 |
fltIVAValor1 | string | Valor IVA 1. ex.: 230 |
fltIVAValor2 | string | Valor IVA 2. ex.: 0 |
fltTotalIVA | string | Total IVA. ex.: 230 |
fltSubTotal | string | Subtotal. ex.: 1000 |
fltIRSTaxa | string | Taxa IRS. ex.: 0 |
fltIRSIncidencia | string | Incidência IRS. ex.: 0 |
fltIRSValorRetido | string | Valor retido IRS. ex.: 0 |
fltTotal | string | Total do documento. ex.: 1230 |
fltTotalPagamentos | string | Total de pagamentos registados. ex.: 0 |
fltTroco | number | Troco. ex.: 0 |
strAplicacaoOrigem | string | Aplicação origem. ex.: Integrador-WS |
dtmDataAbertura | string date-time | Data de abertura. ex.: 2025-11-06T15:00:00Z |
dtmDataAlteracao | string date-time | Data de alteração. ex.: 2025-11-06T15:40:00Z |
strCodRubrica | string | nullableRubrica contabilística. |
bitArrImpostos | string | Indicadores de impostos (bitwise). ex.: 0 |
dtmDataEntregaCab | string date | Data prevista de receção. ex.: 2025-11-10 |
strHoraEntregaCab | string time | Hora prevista de receção. ex.: 14:00:00 |
intCodCatEntidade | string | nullableCategoria da entidade. ex.: 1 |
intLinhaPreco | integer | Linha/tabela de preço aplicada. ex.: 1 |
dtmDataEstado | string date-time | Data do estado. ex.: 2025-11-06T15:30:00Z |
strObsEstado | string | nullableObservações do estado. |
strCodEstadoDoc | string | nullableEstado do documento. ex.: ABERTO |
fltTotalToPay | string | Total por pagar. ex.: 1230 |
strMotivoIsencao | string | nullableMotivo de isenção de IVA (se aplicável). |
strLogin | string | Utilizador. ex.: nsantos |
strLoginCriacao | string | Utilizador de criação. ex.: nsantos |
strLoginEstado | string | Utilizador que alterou o estado. ex.: mferreira |
dtmDataAlteracaoEstado | string date-time | Data/hora de alteração de estado. ex.: 2025-11-06T15:35:00Z |
linhas | array<linhaCompra> | Linhas do documento de compra. |
intCompraEncargo | string | só leitura ex.: 0 |
bitDocEncargos | string | só leitura ex.: 0 |
intMercado | string | só leitura ex.: 1 |
dtmDataCarga | string | só leitura ex.: 2015-08-13 00:00:00 |
strHoraCarga | string | só leitura ex.: 12:28 |
strViatura | string | nullable só leitura |
bitUrgente | string | só leitura ex.: 0 |
strFCDNumContrib | string | só leitura ex.: ESA123456 |
strFCDNome | string | só leitura ex.: INTRACOMUNITARIO |
strFCDMorada | string | só leitura ex.: A |
strFCDCodPostal | string | só leitura ex.: 1000-000 |
strFCDTelefone | string | nullable só leitura |
bitFCDRetIRS | string | só leitura ex.: 0 |
fltEncargosValorSIVA | string | só leitura ex.: .000000 |
fltEncargosValorCIVA | string | só leitura ex.: .000000 |
fltEncargosDescontosSIVA | string | só leitura ex.: .000000 |
fltEncargosDescontosCIVA | string | só leitura ex.: .000000 |
fltEncargosIVA | string | só leitura ex.: .000000 |
fltEncargosIRS | string | só leitura ex.: .000000 |
fltEncargosIRSIncid | string | só leitura ex.: .000000 |
fltEncargosTotal | string | só leitura ex.: .000000 |
fltEncargosPorDistribuir | string | só leitura ex.: .000000 |
fltEncargosDistribuido | string | só leitura ex.: .000000 |
intIVACodTaxa3 | string | só leitura ex.: -1 |
intIVACodTaxa4 | string | só leitura ex.: -1 |
intIVACodTaxa5 | string | só leitura ex.: -1 |
intIVACodTaxa6 | string | só leitura ex.: -1 |
fltIVATaxa3 | string | só leitura ex.: .000000 |
fltIVATaxa4 | string | só leitura ex.: .000000 |
fltIVATaxa5 | string | só leitura ex.: .000000 |
fltIVATaxa6 | string | só leitura ex.: .000000 |
fltIVAIncidencia3 | string | só leitura ex.: .000000 |
fltIVAIncidencia4 | string | só leitura ex.: .000000 |
fltIVAIncidencia5 | string | só leitura ex.: .000000 |
fltIVAIncidencia6 | string | só leitura ex.: .000000 |
fltIVAValor3 | string | só leitura ex.: .000000 |
fltIVAValor4 | string | só leitura ex.: .000000 |
fltIVAValor5 | string | só leitura ex.: .000000 |
fltIVAValor6 | string | só leitura ex.: .000000 |
fltValorPago | string | só leitura ex.: .000000 |
fltValorPendente | string | só leitura ex.: 5000.000000 |
intSinal | string | só leitura ex.: 1 |
bitConversao | string | só leitura ex.: 0 |
bitConvertido | string | só leitura ex.: 0 |
UpdateStamp | string | só leitura ex.: |