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.

Exemplo
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 db na query (ex. ?db=emp_236).
  • POST / PUT / PATCH: campo database (ou db) 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:

Envelope DataTables
{
  "sEcho": 0,
  "iTotalRecords": 898,
  "iTotalDisplayRecords": 898,
  "aaData": [
    {
      "Id": "74",
      "intCodigo": "1006",
      "strNome": "Exemplo"
    }
  ]
}
ParâmetroDescrição
limitRegistos por página (por omissão 100).
offsetEm /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 + searchFieldFiltro por igualdade num campo da listagem (ex. ?searchField=strNumContrib&q=509999999). Alguns endpoints aceitam srchType (equal, not-equal, startswith).
orderOrdenação campo;ASC|DESC (ex. Id;DESC).
Tipos de dados. Nas listagens e detalhes vindos diretamente das tabelas do ERP, todos os valores são devolvidos como texto (ex. "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.

Erro
{
  "success": 0,
  "errormsg": "registo inexistente"
}
HTTPSignificado
200Pedido processado. Ver success (1 = sucesso, 0 = erro com errormsg/message).
400Pedido mal formado ou parâmetro obrigatório em falta.
403API Key em falta ou inválida.
413Limite excedido (ex. mais de 50 documentos num pedido de lançamentos).
500Erro 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:

  1. Escolher a empresa — GET /contabilidade/listDBemp.
  2. 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.
  3. Validar a entidade — GET /contabilidade/entidades?nif=. Se o fornecedor não tiver conta corrente, criá-la com POST /contabilidade/planocontas (act=ensureSupplierAccount).
  4. Simular — POST /contabilidade/lancamentos com "validarApenas": true: devolve todos os erros por linha sem gravar.
  5. Enviar — o mesmo pedido com "validarApenas": false. Cada documento devolve created, exists (reenvio — não duplica) ou error.
  6. Confirmar — GET /contabilidade/lancamentos?id= ou ?numeroDocumento=&nif= para obter o número atribuído no Eticadata.
Regras. Débito = crédito por documento · gravação atómica por documento · idempotência por NIF + tipo + número de documento · lançamentos não são alterados (anula-se e reenvia-se) · apenas EUR · máximo 50 documentos por pedido · anexo PDF até 10 MB.

Contabilidade

Endpoints de consulta/importação de contabilidade.

GET Listar empresas (bases de dados)

GET/contabilidade/listDBemp
Devolve uma listagem de BD de empresas existentes na CTB

Respostas

  • 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/listDBemp' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de BD de empresas
{
  "success": 1,
  "data": [
    {
      "emp": "emp_001",
      "value": "emp_001"
    },
    {
      "emp": "emp_101",
      "value": "emp_101"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Listar diários

GET/contabilidade/diarios
Devolve uma listagem de diários da contabilidade

Parâmetros

NomeEmTipoDescrição
dbquerystringBase dados da empresa
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Devolve uma lista de diários na CTB
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tipos documentais eInvoice

GET/contabilidade/eInvoice_TpDocs
Devolve uma listagem dos tipos documentais eInvoice configurados na contabilidade (Tbl_eInvoice_TpDocs).

Parâmetros

NomeEmTipoDescrição
dbquerystringBase dados da empresa
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Devolve uma lista de tipos documentais eInvoice
{
  "sEcho": 0,
  "iTotalRecords": 5,
  "iTotalDisplayRecords": 5,
  "aaData": [
    {
      "strTpDoc": "Nota de débito",
      "strAbrevTpDoc": "",
      "strListDocs": ""
    },
    {
      "strTpDoc": "Nota de crédito",
      "strAbrevTpDoc": "",
      "strListDocs": ""
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Listar movimentos contabilísticos

GET/contabilidade/movimentos
Devolve uma listagem de movimentos de contabilidade. Cada registo pode incluir linhas e mov_cc (movimentos de centro de custo).

Parâmetros

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
intCodDiarioquerystringCódigo do diario
intNum_DiarioquerystringCódigo do diario
intMesquerystringMês do diario
strDataquerystring dateData do Doc
strAbrevTpDocquerystringTipo de documento
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Devolve uma lista de Movimentos na CTB paginada
{
  "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": []
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Importar/eliminar movimentos (legado)

POST/contabilidade/movimentos
Operações sobre movimentos de contabilidade por act (importMovim, deleteMovim). Em deleteMovim, a API elimina Movimentos_Ctb_Lin, Mov_CC e depois Movimentos_Ctb_Cab.

Corpo do pedido application/json ctbMovimentosActionRequest

CampoTipoDescrição
dbstringBase de dados/tenant alvo. Obrigatório em deleteMovim para evitar fallback para a BD por defeito.
ex.: emp_236
databasestringAlias de db. Obrigatório em deleteMovim quando db não for enviado.
ex.: emp_236
actstring importMovim · deleteMovim · deleteMovimento · deleteobrigatório
IdintegerIdentificador interno do movimento (alternativa à chave composta para deleteMovim).
ex.: 10021
idintegerAlias de Id.
ex.: 10021
strCodExerciciostringCódigo do exercício. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 2025
intCodDiariointegerCódigo do diário. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 8
intMesintegerMês do movimento. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 1
intNum_DiariointegerNúmero do diário. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 10001
intNumDiariointegerAlias de intNum_Diario.
ex.: 10001
codDiariointegerCódigo do diário a usar em importMovim. Se omitido, o endpoint usa 8.
ex.: 8
documentsarray<ctbImportMovimentoDocument>Coleção de documentos para importMovim.
accountarray<ctbImportMovimentoLine>Alias legado de linhas contabilísticas quando o pedido envia um único documento no corpo raiz.
linesarray<ctbImportMovimentoLine>Linhas contabilísticas quando o pedido envia um único documento no corpo raiz.
field_AstringNIF/Tax payer do documento externo no modo legado de importMovim.
ex.: 500108668
field_CstringDescrição do documento externo.
ex.: Fatura fornecedor
field_Fstring dateData do documento externo.
ex.: 2026-03-08
field_GstringNúmero externo/documento externo.
ex.: FAC-2026/123
field_NstringTotal de IVA no documento externo.
ex.: 6.00
field_OstringTotal do documento externo.
ex.: 106.00
docTypestringTipo documental de contabilidade a gravar.
ex.: V/FAC
file_attachmentctbFileAttachmentAnexo 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=0 e errormsg. — object
Pedido (curl)
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"}}'
200 · Operação executada com sucesso
{
  "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": {}
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Consultar lançamentos contabilísticos

GET/contabilidade/lancamentos
Consulta lançamentos por id (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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
idqueryintegerId interno do lançamento (lancamento.id devolvido na criação).
ex.: 10457
numeroDocumentoquerystringNúmero do documento de origem (correspondência exata).
ex.: FT 2026A/1543
nifquerystringNIF da entidade (com ou sem prefixo PT).
ex.: 509999999
tipoDocumentoquerystring
ex.: FT
incluirLinhasquerybooleanIncluir 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=0 e errormsg. — object
  • 401 API Key em falta ou inválida
Pedido (curl)
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>'
200 · Lançamentos encontrados (lista vazia se não existir nenhum)
{
  "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
            }
          ]
        }
      ]
    }
  ]
}
400 · Erro: Indique 'id' ou 'numeroDocumento'.
{
  "success": 0,
  "message": "Indique 'id' ou 'numeroDocumento'."
}

POST Criar lançamentos contabilísticos (importMovim v2)

POST/contabilidade/lancamentos
Cria um ou mais lançamentos contabilísticos no Eticadata (Movimentos_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 + numeroDocumento dentro da empresa. Um reenvio não cria duplicados: devolve status=exists com os dados do lançamento já existente (não é tratado como erro).
  • Período: exercício e mês são derivados de dataLancamento (ou dataDocumento se omitida). Se periodo for 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=true executa todas as validações sem gravar (status=validated).
Respostas HTTP: 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

CampoTipoDescrição
actstring importMovimV2Opcional neste endpoint.
por omissão: importMovimV2
databasestringobrigatórioBase de dados da empresa (ver /contabilidade/listDBemp).
ex.: emp_236
validarApenasbooleanSe true, executa todas as validações sem gravar.
por omissão: False
documentosarray<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=0 e errormsg. — object
  • 401 API Key em falta ou inválida
  • 413 Excedido o limite de documentos por pedido ou o tamanho do anexo
Pedido (curl)
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..."
      }
    }
  ]
}'
200 · Um documento criado, um já existente e um com erros
{
  "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"
        }
      ]
    }
  ]
}
400 · Erro: Campo 'documentos' em falta ou vazio.
{
  "success": 0,
  "message": "Campo 'documentos' em falta ou vazio."
}

GET Plano de contas

GET/contabilidade/planocontas
Contas do plano de contas de um exercício (Tbl_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
strContaquerystringConta (correspondência exata).
ex.: 62221
strDescricaoquerystringDescrição (correspondência exata).
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista paginada de contas
{
  "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
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Garantir conta de fornecedor

POST/contabilidade/planocontas
act=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

CampoTipoDescrição
actstring ensureSupplierAccountobrigatório
dbstringobrigatórioBase de dados da empresa (ex. emp_158).
strNIFstringobrigatórioNIF do fornecedor.
strNomestringNome do fornecedor (descrição da conta, até 80 caracteres). Obrigatório quando a conta tem de ser criada.
datadocstring dateobrigatórioData do documento; define o exercício.

Respostas

  • 200 Conta existente ou criada (success=0 com errormsg em caso de erro) — object
  • 400 Pedido inválido ou erro de negócio. Muitos endpoints devolvem HTTP 200 com success=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Conta existente ou criada (`success=0` com `errormsg` em caso de erro)
{
  "success": 1,
  "created": 1,
  "strConta": "string",
  "strDescricao": "string",
  "strNumContrib": "string",
  "strCodExercicio": "string",
  "exercicios_criados": [
    "string"
  ],
  "mensagem": "string",
  "errormsg": "string"
}
200 · Erro: NIF inválido.
{
  "success": 0,
  "errormsg": "NIF inválido."
}

GET Centros de custo

GET/contabilidade/centroscusto
Centros de custo de um exercício (Tbl_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
datadocquerystring dateData (YYYY-MM-DD) usada para determinar o exercício quando strCodExercicio não é enviado.
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista paginada de centros de custo
{
  "sEcho": 0,
  "iTotalRecords": 8,
  "iTotalDisplayRecords": 8,
  "aaData": [
    {
      "strConta": "8",
      "strDescricao": "Descrição exemplo",
      "bitmovimenta": "1"
    },
    {
      "strConta": "7",
      "strDescricao": "Descrição exemplo",
      "bitmovimenta": "1"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Códigos e taxas de IVA

GET/contabilidade/taxasiva
Códigos de IVA (Tbl_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista paginada de códigos de IVA
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Exercícios e estado

GET/contabilidade/periodos
Exercícios contabilísticos e respetivo estado. O Eticadata não guarda estado por mês: o bloqueio é ao nível do exercício (bloqueado=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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
dataquerystring dateDevolve 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/periodos?db=emp_236' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Lista de exercícios
{
  "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"
    }
  ]
}
400 · Erro: Parâmetro 'data' inválido (formato YYYY-MM-DD).
{
  "success": 0,
  "message": "Parâmetro 'data' inválido (formato YYYY-MM-DD)."
}

GET Tipos de documento

GET/contabilidade/tiposdocumentos
Tipos de documento do ERP (Tbl_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

NomeEmTipoDescrição
dbquerystringBase 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/tiposdocumentos?db=emp_236' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Lista de tipos de documento
{
  "success": 1,
  "data": [
    {
      "tipoDocumento": "ABT",
      "descricao": "ABATE IMO OBSOLETO",
      "diario": null,
      "eInvoice": []
    },
    {
      "tipoDocumento": "ALIEN",
      "descricao": "Alienação",
      "diario": null,
      "eInvoice": []
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Pesquisar entidades por NIF

GET/contabilidade/entidades
Devolve os clientes, fornecedores e contas do plano de contas (21x clientes, 22x fornecedores, outras) associados a um NIF. As contas são as do exercício indicado em exercicio, 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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
nifquerystringobrigatórioNIF (com ou sem prefixo de país).
ex.: PT509999999
tipoEntidadequerystring cliente · fornecedor
exercicioquerystring
ex.: 2026
dataquerystring 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/entidades?db=emp_236&nif=509999999' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Entidades e contas encontradas (listas vazias se não existirem)
{
  "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"
      }
    ]
  }
}
400 · Erro: Parâmetro 'nif' obrigatório.
{
  "success": 0,
  "message": "Parâmetro 'nif' obrigatório."
}

GET Contas sugeridas por tipo de documento

GET/contabilidade/LigacaoCteTipoDoc
Linhas de ligação contabilística (Tbl_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
datadocquerystringData do documento (YYYY-MM-DD); define o exercício se strCodExercicio for omitido.
ex.: 2026-07-01
strNIFquerystringNIF da entidade.
ex.: 509999999
strTpDocquerystringTipo de documento (ex. FT, NC, FR).
ex.: FT
strContaEntidadePrefixquerystringPrefixo 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/contabilidade/LigacaoCteTipoDoc?db=emp_236&strCodExercicio=2026' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Linhas de ligação
{
  "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
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Taxonomias SNC do plano de contas

GET/contabilidade/taxonomias
Correspondência conta ↔ código de taxonomia SNC (Tbl_Plano_Contas_Taxonomies), em formato DataTables.

Parâmetros

NomeEmTipoDescrição
dbquerystringBase dados da empresa
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
limitqueryintegerNú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
offsetqueryintegerPaginaçã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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista paginada de taxonomias
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Balancete (saldos por conta/mês)

GET/contabilidade/saldos
Balancete: saldos da contabilidade por conta e mês (tabela Ctb_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
intMesquerystringMês do diario
intMes2queryintegerÚltimo mês do intervalo (inclusive). Se omitido, igual a intMes.
strContaquerystringFiltro 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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista de saldos por conta/mês
{
  "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
    }
  ]
}
400 · Erro: Parametro obrigatorio em falta: strCodExercicio
{
  "success": 0,
  "errormsg": "Parametro obrigatorio em falta: strCodExercicio"
}

GET Declaração periódica de IVA

GET/contabilidade/declperiodica
Valores da Declaração Periódica de IVA gerada no ERP (tabela Tbl_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strPeriodoquerystringobrigatórioPeríodo da DP no formato YYYYMMDDYYYYMMDD (1º dia + último dia)
strAnexoquerystringAnexo 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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista de campos da DP com o respetivo valor
{
  "success": 1,
  "data": [
    {
      "intCodigo": 1,
      "strAnexo": "1",
      "fltValor": 0
    },
    {
      "intCodigo": 2,
      "strAnexo": "1",
      "fltValor": 0
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Totais por diário e documento

GET/contabilidade/movimentosdiarios
Totais dos movimentos contabilísticos de um mês agrupados por diário, número de documento (strNum_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

NomeEmTipoDescrição
dbquerystringBase dados da empresa
strCodExercicioquerystringCódigo do exercício
intMesqueryintegerobrigatórioMês dos movimentos (1-12; 0 = abertura)
intCodDiarioquerystringCódigo do diario
strDeb_Crequerystring D · CFiltrar 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=0 e errormsg. — object
Pedido (curl)
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>'
200 · Lista de totais por diário/documento/lado
{
  "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
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Clientes

Gestão de clientes no ERP.

GET Listar clientes

GET/clientes
Devolve uma listagem de clientes existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de clientes paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar cliente

POST/clientes
Permite a criação de um novo cliente

Corpo do pedido application/json cliente

CampoTipoDescrição
IdstringobrigatórioIdentificador interno do cliente.
ex.: 2001
intCodigostringCódigo numérico do cliente.
ex.: 2001
strNomestringNome do cliente.
ex.: Loja Exemplo, Lda
strNumContribstringNIF/VAT do cliente.
ex.: PT123456789
bitConsumidorFinalstring1 se consumidor final; 0 caso contrário.
ex.: 0
strTelefonestringnullableTelefone.
ex.: +351 212345678
strTelemovelstringnullableTelemóvel.
ex.: +351 912345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua A, 100
strMorada_lin2stringnullableMorada (linha 2).
ex.: Parque Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringnullableCódigo postal.
ex.: 2400-000
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
bitUseElectronicDocumentstring1 se usa documento eletrónico.
ex.: 1
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
bitPortalWebstring1 se tem acesso ao portal web.
ex.: 0
intSinalTpstringTipo de sinal (quando aplicável).
ex.: 0
intCodCatEntidadestringnullableCódigo da categoria de entidade.
ex.: 1
bitAviso_vencimentostring1 se envia aviso de vencimento.
ex.: 1
intCodVendedorstringnullableCódigo do vendedor associado.
ex.: 101
strObsstringnullableObservações gerais.
ex.: Cliente preferencial.
dtmAberturastring date-timeData de abertura.
ex.: 2024-05-10T10:00:00Z
dtmAlteracaostring date-timeData 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=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Artigo criado com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Código existente
{
  "success": 0,
  "errormsg": "Código existente"
}

GET Detalhe de cliente

GET/clientes/{id}
Devolve informações sobre um cliente a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade cliente
[
  {
    "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"
  }
]
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

PUT Atualizar cliente

PUT/clientes/{id}
Atualiza os campos editáveis de um cliente a partir do seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigatório

Corpo do pedido application/json cliente

CampoTipoDescrição
IdstringobrigatórioIdentificador interno do cliente.
ex.: 2001
intCodigostringCódigo numérico do cliente.
ex.: 2001
strNomestringNome do cliente.
ex.: Loja Exemplo, Lda
strNumContribstringNIF/VAT do cliente.
ex.: PT123456789
bitConsumidorFinalstring1 se consumidor final; 0 caso contrário.
ex.: 0
strTelefonestringnullableTelefone.
ex.: +351 212345678
strTelemovelstringnullableTelemóvel.
ex.: +351 912345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua A, 100
strMorada_lin2stringnullableMorada (linha 2).
ex.: Parque Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringnullableCódigo postal.
ex.: 2400-000
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
bitUseElectronicDocumentstring1 se usa documento eletrónico.
ex.: 1
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
bitPortalWebstring1 se tem acesso ao portal web.
ex.: 0
intSinalTpstringTipo de sinal (quando aplicável).
ex.: 0
intCodCatEntidadestringnullableCódigo da categoria de entidade.
ex.: 1
bitAviso_vencimentostring1 se envia aviso de vencimento.
ex.: 1
intCodVendedorstringnullableCódigo do vendedor associado.
ex.: 101
strObsstringnullableObservações gerais.
ex.: Cliente preferencial.
dtmAberturastring date-timeData de abertura.
ex.: 2024-05-10T10:00:00Z
dtmAlteracaostring date-timeData 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=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Cliente atualizado com sucesso
{
  "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"
  }
}
200 · Erro: Cliente não encontrado
{
  "success": 0,
  "errormsg": "Cliente não encontrado"
}

Clientes - Contactos

Consulta de contactos associados a clientes.

GET Contactos de cliente indisponível

GET/clientes/{intCodCliente}/contactos
Devolve informações sobre os contactos do cliente a partir de seu código. ⚠️ Ainda sem implementação no servidor (a rota devolve 404).

Parâmetros

NomeEmTipoDescrição
intCodClientepathstringobrigatório
strCodTpContactoquerystring
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/clientes/5/contactos' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade contactos cliente
[
  {
    "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"
  }
]
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Fornecedores

Gestão de fornecedores no ERP.

GET Listar fornecedores

GET/fornecedores
Devolve uma listagem de fornecedores existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de fornecedores paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar fornecedor

POST/fornecedores
Permite a criação de um novo fornecedor

Corpo do pedido application/json fornecedor

CampoTipoDescrição
IdstringobrigatórioIdentificador interno do fornecedor.
ex.: 3001
intCodigostringCódigo do fornecedor.
ex.: 3001
strNomestringNome do fornecedor.
ex.: Fornecedor Exemplo, Lda
strNumContribstringNIF/VAT do fornecedor.
ex.: PT500108668
strTelefonestringnullableTelefone.
ex.: +351 212345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua B, 50
strMorada_lin2stringnullableMorada (linha 2).
ex.: Zona Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringCódigo postal.
ex.: 2400-111
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
intCodCatEntidadestringCódigo da categoria de entidade.
ex.: 1
strObsstringnullableObservações gerais.
dtmAberturastring date-timeData de abertura.
ex.: 2025-01-02 09:00:00.000
dtmAlteracaostring date-timeData 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=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Artigo criado com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Código existente
{
  "success": 0,
  "errormsg": "Código existente"
}

GET Detalhe de fornecedor

GET/fornecedores/{id}
Devolve informações sobre um fornecedor a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade fornecedor
[
  {
    "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"
  }
]
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Fornecedores - Contactos

Consulta de contactos associados a fornecedores.

GET Contactos de fornecedor indisponível

GET/fornecedores/{intCodigo}/contactos
Devolve informações sobre os contactos do fornecedor a partir de seu código. ⚠️ A rota com caminho devolve 404 no servidor; usar GET /fornecedores?act=contactos&num={intCodigo} (devolve o mesmo array).

Parâmetros

NomeEmTipoDescrição
intCodigopathstringobrigatório
strCodTpContactoquerystring
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/fornecedores/5/contactos' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade contactos fornecedor
[
  {
    "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"
  }
]
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Artigos

Gestão de artigos no ERP.

GET Listar artigos

GET/artigos
Devolve uma listagem paginada de artigos existentes no ERP. Suporta filtro por q + searchField; por retrocompatibilidade, searchField=strCodArtigo é tratado como alias de strCodigo.

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
srchTypequerystring equal · not-equal · endswith · startswithTipo 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
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/artigos?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de artigos paginada
{
  "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": []
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar artigo

POST/artigos
Permite a criação de um novo artigo

Corpo do pedido application/json artigo

34 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do artigo.
ex.: 12345
strCodigostringCódigo único do artigo.
ex.: ART-0001
intCodInternostringCódigo interno do artigo.
ex.: 987
strCodBarrasstringnullableCódigo de barras principal do artigo.
ex.: 5601234567890
strAbreviaturastringAbreviatura/alias do artigo.
ex.: ART1
strCodCategoriastringCódigo da categoria associada.
ex.: CAT-10
strTpArtigostringnullableTipo de artigo (ex. M – Mercadoria, S – Serviço).
ex.: M
strDescricaostringDescrição do artigo.
ex.: Camisola 100% algodão
fltPCReferenciastringPreço de custo de referência.
ex.: 8.75
intCodTaxaIvaVendastringCódigo da taxa de IVA a aplicar na venda.
ex.: 23
intCodTaxaIvaComprastringCódigo da taxa de IVA a aplicar na compra.
ex.: 23
strAbrevMedStkstringUnidade de medida para stock.
ex.: UN
strAbrevMedVndstringUnidade de medida para venda.
ex.: UN
strAbrevMedCmpstringUnidade de medida para compra.
ex.: UN
bitNaoMovStkstring1 se não movimenta stock; 0 caso contrário.
ex.: 0
imgImagemstringImagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia.
precosarray<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.
intNumerostringIdentificador/linha de tabela de preços.
ex.: 1
fltPrecostringPreço para a tabela indicada.
ex.: 12.99
intTpIVAstringCódigo/tipo de IVA associado ao preço.
ex.: 23
precosCustoobjectnullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir.
fltPCMediostringPreço de custo médio.
ex.: 8.5
fltPCUltimostringÚltimo preço de custo.
ex.: 8.75
fltPCMaoObrastringCusto de mão de obra.
ex.: 1.25
fltPCMaquinastringCusto de máquina.
ex.: 0.5
fltQuantTotalstringQuantidade total considerada no custo.
ex.: 100
fltCostTotalstringCusto total.
ex.: 875
familiasarray<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.
strCodFamiliastringCódigo da família.
ex.: FAM-ROUPA
strCodTpNivelstringTipo de nível/estrutura da família.
ex.: N1
stocksarray<object>Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia.
strCodArmazemstringCódigo do armazém.
ex.: ARM-01
fltStockQtdstringQuantidade em stock.
ex.: 150
fltStockReservadostringQuantidade 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=0 e errormsg. — object
Pedido (curl)
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"
    }
  ]
}'
200 · Artigo criado com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Artigo existente
{
  "success": 0,
  "errormsg": "Artigo existente"
}

GET Detalhe de artigo

GET/artigos/{id}
Devolve informações sobre um artigo a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/artigos/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade artigo
{
  "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"
    }
  ]
}
200 · Erro: registo inexistente
{
  "success": 0,
  "errormsg": "registo inexistente"
}

PATCH Atualizar artigo

PATCH/artigos/{id}
Atualiza informações sobre um artigo a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigatório

Corpo do pedido application/json artigo

34 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do artigo.
ex.: 12345
strCodigostringCódigo único do artigo.
ex.: ART-0001
intCodInternostringCódigo interno do artigo.
ex.: 987
strCodBarrasstringnullableCódigo de barras principal do artigo.
ex.: 5601234567890
strAbreviaturastringAbreviatura/alias do artigo.
ex.: ART1
strCodCategoriastringCódigo da categoria associada.
ex.: CAT-10
strTpArtigostringnullableTipo de artigo (ex. M – Mercadoria, S – Serviço).
ex.: M
strDescricaostringDescrição do artigo.
ex.: Camisola 100% algodão
fltPCReferenciastringPreço de custo de referência.
ex.: 8.75
intCodTaxaIvaVendastringCódigo da taxa de IVA a aplicar na venda.
ex.: 23
intCodTaxaIvaComprastringCódigo da taxa de IVA a aplicar na compra.
ex.: 23
strAbrevMedStkstringUnidade de medida para stock.
ex.: UN
strAbrevMedVndstringUnidade de medida para venda.
ex.: UN
strAbrevMedCmpstringUnidade de medida para compra.
ex.: UN
bitNaoMovStkstring1 se não movimenta stock; 0 caso contrário.
ex.: 0
imgImagemstringImagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia.
precosarray<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.
intNumerostringIdentificador/linha de tabela de preços.
ex.: 1
fltPrecostringPreço para a tabela indicada.
ex.: 12.99
intTpIVAstringCódigo/tipo de IVA associado ao preço.
ex.: 23
precosCustoobjectnullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir.
fltPCMediostringPreço de custo médio.
ex.: 8.5
fltPCUltimostringÚltimo preço de custo.
ex.: 8.75
fltPCMaoObrastringCusto de mão de obra.
ex.: 1.25
fltPCMaquinastringCusto de máquina.
ex.: 0.5
fltQuantTotalstringQuantidade total considerada no custo.
ex.: 100
fltCostTotalstringCusto total.
ex.: 875
familiasarray<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.
strCodFamiliastringCódigo da família.
ex.: FAM-ROUPA
strCodTpNivelstringTipo de nível/estrutura da família.
ex.: N1
stocksarray<object>Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia.
strCodArmazemstringCódigo do armazém.
ex.: ARM-01
fltStockQtdstringQuantidade em stock.
ex.: 150
fltStockReservadostringQuantidade 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=0 e errormsg. — object
Pedido (curl)
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"
    }
  ]
}'
200 · Atualização da entidade artigo
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Artigo não encontrado
{
  "success": 0,
  "errormsg": "Artigo não encontrado"
}

Referências

Gestão de referências de artigos no ERP.

GET Listar referências

GET/referencias
Devolve uma listagem de referências existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
srchTypequerystring equal · not-equal · endswith · startswithTipo 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
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/referencias?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de referências paginada
{
  "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": []
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Encomendas

Gestão de encomendas no ERP.

GET Listar encomendas

GET/encomendas
Devolve uma listagem de encomendas existentes no ERP. No modo list de encomendas.php, aceita os parâmetros q, searchField, strAbrevTpDoc, strCodSeccao e strCodExercicio.

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
strAbrevTpDocquerystringTipo de documento
strCodSeccaoquerystringCódigo da secção
strCodExercicioquerystringCó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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/encomendas?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de encomendas paginada
{
  "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)
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar encomenda

POST/encomendas
Permite a criação de uma nova encomenda

Corpo do pedido application/json encomenda

91 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador da encomenda.
ex.: 7001
strCodSeccaostringSecção.
ex.: VND
strAbrevTpDocstringTipo de doc (abreviado).
ex.: ENC
strCodExerciciostringExercício.
ex.: 2025
intNumerostringNúmero interno.
ex.: 45
strNumerostringNúmero formatado.
ex.: ENC/2025/00045
strNumExternostringNúmero externo do cliente.
ex.: PO-984
dtmDatastring dateData do documento.
ex.: 2025-11-07
strHorastring timeHora do documento.
ex.: 11:30:00
bitAnuladostring1 se anulado; 0 caso contrário.
ex.: 0
intTpEntidadestringTipo de entidade (1=Cliente, etc.).
ex.: 1
intCodEntidadestringCódigo da entidade.
ex.: 2001
intDireccaostringDireção (1=Entrada, -1=Saída).
ex.: -1
fltDescontoCabstringDesconto de cabeçalho (% ou valor consoante regra).
ex.: 0
fltDescontoFinstringDesconto financeiro.
ex.: 0
strCodCondPagstringCondições de pagamento.
ex.: 30D
strNumRequisicaostringNº da requisição.
dtmDataRequisicaostring dateData da requisição.
dtmDataVencimentostring dateData de vencimento.
ex.: 2025-12-07
strAbrevSubZonastringSubzona/rota.
ex.: LRA
strAbrevMoedastringMoeda.
ex.: EUR
fltCambiostringCâmbio.
ex.: 1.0
strMeioExpedicaostringMeio de expedição.
ex.: Camião
strLocalCargastringLocal de carga.
ex.: Armazém A
strLocalDescargastringLocal de descarga.
ex.: Cliente
strObsstringObservações.
ex.: Entregar em palete.
strECVDNumContribstringNIF na morada de entrega.
ex.: PT123456789
strECVDNomestringNome na morada de entrega.
ex.: Loja Exemplo
strECVDMoradastringMorada de entrega.
ex.: Rua X, 1
strECVDLocalidadestringLocalidade de entrega.
ex.: Leiria
strECVDCodPostalstringCódigo postal de entrega.
ex.: 2400-000
strECVDTelefonestringnullableTelefone de entrega.
ex.: +351 212345678
bitECVDRetIRSstring1 se retém IRS.
ex.: 0
intCodVendedorstringVendedor responsável.
ex.: 201
intTpComissaostringTipo de comissão.
ex.: 0
fltComissaoValorstringValor de comissão.
ex.: 0
fltComissaoPercentstringPercentagem de comissão.
ex.: 0
fltComissaoPenalizstringPenalização de comissão.
ex.: 0
fltComissaoValorBasestringBase de cálculo de comissão.
ex.: 0
bitComissaoDispLiqstringDisponibiliza comissão na liquidação.
ex.: 0
dtmComissaoDataDispstring dateData de disponibilização da comissão.
intTpComissaoDescontosstringRegras de descontos para comissão.
ex.: 0
bitIvaIncluidostring1 se preços incluem IVA.
ex.: 0
bitRegimeVendastringRegime de venda.
ex.: 0
fltInfTotalArtigosstringNº artigos distintos.
ex.: 3
fltInfTotalLinhasstringNº de linhas.
ex.: 3
fltInfTotalQtdstringQuantidade total.
ex.: 30
fltTotalMercadoriaSIVAstringTotal mercadoria sem IVA.
ex.: 300
fltTotalMercadoriaCIVAstringTotal mercadoria com IVA.
ex.: 369
fltTotalDescontosSIVAstringDescontos sem IVA.
ex.: 0
fltTotalDescontosCIVAstringDescontos com IVA.
ex.: 0
fltTotalDescontosFinSIVAstringDescontos financeiros S/IVA.
ex.: 0
fltTotalDescontosFinCIVAstringDescontos financeiros C/IVA.
ex.: 0
fltTotalOutrosSIVAstringOutros valores S/IVA.
ex.: 0
fltTotalOutrosCIVAstringOutros valores C/IVA.
ex.: 0
fltTotalAcertosstringAcertos.
ex.: 0
intIVACodTaxa1stringCódigo taxa IVA 1.
ex.: 23
intIVACodTaxa2stringCódigo taxa IVA 2.
ex.: 0
fltIVATaxa1stringPercentagem taxa IVA 1.
ex.: 23
fltIVATaxa2stringPercentagem taxa IVA 2.
ex.: 0
fltIVAIncidencia1stringIncidência IVA 1.
ex.: 300
fltIVAIncidencia2stringIncidência IVA 2.
ex.: 0
fltIVAValor1stringValor IVA 1.
ex.: 69
fltIVAValor2stringValor IVA 2.
ex.: 0
fltTotalIVAstringTotal IVA.
ex.: 69
fltSubTotalstringSubtotal.
ex.: 300
fltIRSTaxastringTaxa IRS.
ex.: 0
fltIRSIncidenciastringIncidência IRS.
ex.: 0
fltIRSValorRetidostringValor retido IRS.
ex.: 0
fltTotalstringTotal do documento.
ex.: 369
fltTotalPagamentosstringTotal de pagamentos registados.
ex.: 0
fltTrocostringTroco.
ex.: 0
strAplicacaoOrigemstringAplicação origem.
ex.: Integrador-WS
dtmDataAberturastring date-timeData de abertura.
ex.: 2025-11-07T11:20:00Z
dtmDataAlteracaostring date-timeData de alteração.
ex.: 2025-11-07T11:40:00Z
strCodRubricastringnullableRubrica contabilística (quando aplicável).
bitArrImpostosstringIndicadores de impostos (bitwise).
ex.: 0
dtmDataEntregaCabstring dateData de entrega prevista.
ex.: 2025-11-14
strHoraEntregaCabstring timeHora de entrega prevista.
ex.: 16:00:00
intCodCatEntidadeintegernullableCategoria da entidade.
ex.: 1
intLinhaPrecostringLinha/tabela de preço aplicada.
ex.: 1
dtmDataEstadostring date-timeData do estado atual.
ex.: 2025-11-07T11:35:00Z
strObsEstadostringObservações do estado.
strCodEstadoDocstringCódigo do estado do documento.
ex.: ABERTO
fltTotalToPaystringTotal a pagar pendente.
ex.: 369
strMotivoIsencaostringMotivo de isenção de IVA (quando aplicável).
strLoginstringUtilizador.
ex.: nsantos
strLoginCriacaostringUtilizador de criação.
ex.: nsantos
strLoginEstadostringUtilizador que alterou o estado.
ex.: msousa
dtmDataAlteracaoEstadostring date-timeData/hora de alteração de estado.
ex.: 2025-11-07T11:38:00Z
linhasarray<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=0 e errormsg. — object
Pedido (curl)
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": ""}]}'
200 · Encomenda criada com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Entidade inválida
{
  "success": 0,
  "errormsg": "Entidade inválida"
}

GET Detalhe de encomenda

GET/encomendas/{id}
Devolve informações sobre uma encomenda a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/encomendas/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade encomenda
{
  "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": ""
    }
  ]
}
200 · Erro: registo inexistente
{
  "success": 0,
  "errormsg": "registo inexistente"
}

Compras

Gestão de compras no ERP.

GET Listar compras

GET/compras
Devolve uma listagem de compras existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
strAbrevTpDocquerystringTipo de documento
strCodSeccaoquerystringCódigo da secção
strCodExercicioquerystringCó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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/compras?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de compras paginada
{
  "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)
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Importar compras (QR code AT)

POST/compras
Permite a criação de uma nova compra

Corpo do pedido application/json compraImportRequest

CampoTipoDescrição
databasestringBase de dados da empresa.
ex.: emp_236
strAbrevTpDocstringobrigatório
ex.: VFA
strCodSeccaostringobrigatório
ex.: 1
strCodExerciciostringPor defeito, o exercício da data do documento.
intNumerointegerNúmero interno; por defeito o próximo do numerador.
strNumerostring
intTpEntidadeinteger
ex.: 2
intCodEntidadeintegerCódigo do fornecedor; se omitido é procurado pelo NIF (field_A).
strAbrevMoedastring
ex.: EUR
intSinalinteger
fltSubTotalnumber
fltInfTotalQtdnumber
por omissão: 1
fltInfTotalLinhasnumber
fltInfTotalArtigosnumber
por omissão: 1
documentsarray<compraImportDocument>
documentcompraImportDocument

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=0 e errormsg. — object
Pedido (curl)
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}]}}'
200 · Resultado da importação por documento
{
  "success": 1,
  "resultado": {
    "novo": [
      "string"
    ],
    "exist": [
      "string"
    ],
    "error": [
      "string"
    ]
  },
  "errormsg": "string"
}
200 · Erro: Secção e tipo de documento são obrigatórios.
{
  "success": 0,
  "errormsg": "Secção e tipo de documento são obrigatórios."
}

GET Detalhe de compra

GET/compras/{id}
Devolve informações sobre uma compras a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/compras/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade compras
{
  "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)
200 · Erro: registo inexistente
{
  "success": 0,
  "errormsg": "registo inexistente"
}

Vendas

Gestão de vendas no ERP.

GET Listar vendas

GET/vendas
Devolve uma listagem de vendas existentes no ERP. Para detalhe de uma venda pode usar act=getDetail com num.

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
srchTypequerystring equal · not-equal · endswith · startswithTipo 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
searchFieldquerystringNome 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
strAbrevTpDocquerystringTipo de documento
actquerystringacção
numqueryintegerID interno do registo para detalhe (act=getDetail)
docTypequeryarray<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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/vendas?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve listagem paginada (DataTables) ou detalhe de venda
{
  "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)
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar venda

POST/vendas
Permite a criação de uma nova venda

Corpo do pedido application/json venda

CampoTipoDescrição
IdstringIdentificador interno da venda.
ex.: 101
intNumerostringNúmero interno do documento.
ex.: 245
strAbrevTpDocstringAbreviatura do tipo de documento.
ex.: FAC
strCodSeccaostringCódigo da secção.
ex.: VND
strCodExerciciostringCódigo do exercício.
ex.: 2026
strNumerostringNúmero formatado do documento.
ex.: FAC/2026/00245
strNumExternostringnullableNúmero externo do documento.
ex.: WEB-245
dtmDatastring dateData do documento.
ex.: 2026-03-08
intTpEntidadestringTipo de entidade.
ex.: 1
intCodEntidadestringCódigo da entidade.
ex.: 2001
strAbrevSubZonastringSubzona associada à entidade/documento.
ex.: LRA
strAbrevMoedastringMoeda do documento.
ex.: EUR
intCodVendedorintegernullableVendedor associado.
ex.: 201
strObsstringnullableObservações do documento.
fltTotalstringTotal do documento.
ex.: 123.45
strCodEstadoDocstringnullableEstado do documento.
ex.: ABERTO
linhasarray<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=0 e errormsg. — object
Pedido (curl)
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": [
    {}
  ]
}'
200 · Venda criada com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Campos obrigatórios em falta
{
  "success": 0,
  "errormsg": "Campos obrigatórios em falta"
}

GET Detalhe de venda

GET/vendas/{id}
Devolve detalhes de uma venda por ID (equivalente a act=getDetail&num={id})

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/vendas/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade venda
{
  "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"
    }
  ]
}
200 · Erro: registo inexistente
{
  "success": 0,
  "errormsg": "registo inexistente"
}

Stocks

Gestão de movimentos de stock no ERP.

GET Listar movimentos de stock

GET/stocks
Devolve uma listagem de stocks existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
strAbrevTpDocquerystringTipo de documento
strCodSeccaoquerystringCódigo da secção
strCodExercicioquerystringCó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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/stocks?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de encomendas paginada
{
  "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
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Criar movimento de stock

POST/stocks
Permite a criação de um novo movimento de stock

Corpo do pedido application/json stock

33 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador único do registo de stock.
ex.: 501
strCodSeccaostringCódigo da secção/departamento.
ex.: Geral
strAbrevTpDocstringAbreviatura do tipo de documento (ENT_A, SAI_B).
ex.: ENT_A
strCodExerciciostringCódigo do exercício (ano).
ex.: 2025
intNumerostringNúmero interno do documento.
ex.: 123
strNumerostringNúmero formatado do documento.
ex.: ENT_A/2025/00123
dtmDatastring date-timeData do documento.
ex.: 2025-11-07T10:00:00Z
bitAnuladostringIndica se o documento está anulado.
ex.: False
strCodArmazemOriDefstringnullableArmazém de origem por defeito.
ex.: ARM-01
strCodLocalizacaoOriDefstringnullableLocalização de origem por defeito.
ex.: A1-01-01
strMeioExpedicaostringnullableMeio de expedição (ex. camião).
ex.: Camião
strLocalCargastringLocal da carga.
ex.: Fábrica A
strLocalDescargastringLocal da descarga.
ex.: Armazém Central
strViaturastringIdentificação da viatura.
ex.: AA-00-BB
strObsstringObservações gerais.
ex.: Conferir quantidades na receção.
fltTotalstringTotal do documento (valor).
ex.: 1500.55
UpdateStampstring date-timeStamp/ETag de atualização.
ex.: 2025-11-07T10:01:22Z
dtmDataAberturastring date-timenullableData de abertura.
ex.: 2025-11-07T09:55:00Z
dtmDataAlteracaostring date-timeData da última alteração.
ex.: 2025-11-07T10:05:00Z
strLoginstringUtilizador responsável.
ex.: nsantos
strAplicacaoOrigemstringAplicação origem.
ex.: Integrador-WS
dtmDataCargastring date-timeData/hora de carga no sistema.
ex.: 2025-11-07T10:02:00Z
strHoraCargastring timeHora da carga (texto).
ex.: 10:02:00
strForteAbrevMoedastringnullableMoeda forte abreviada.
ex.: EUR
fltForteCambiostringTaxa de câmbio aplicada.
ex.: 1.0
bitSafeModebooleannullableDocumento criado em modo seguro.
ex.: true
bitUpdateIntegradorstringAtualizado via integrador.
ex.: True
strCodProjectoOrigemstringnullableCódigo do projeto de origem.
ex.: PRJ-001
intPrintCountstringNúmero de impressões.
ex.: 2
dtmDateDocstring date-timenullableData efetiva do documento.
ex.: 2025-11-07T00:00:00Z
bitCostsByExitCostingstringCustos valorizados por custo de saída.
ex.: False
intProjectLineOriintegernullableLinha do projeto de origem.
ex.: 0
linhasarray<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=0 e errormsg. — object
Pedido (curl)
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}]}'
200 · Encomenda criada com sucesso
{
  "success": 1,
  "message": "Registo criado",
  "errormsg": "Código existente",
  "Id": 105,
  "log": "string"
}
200 · Erro: Código existente
{
  "success": 0,
  "errormsg": "Código existente"
}

GET Detalhe de movimento de stock

GET/stocks/{id}
Devolve informações sobre um movimento de stock a partir de seu ID exclusivo

Parâmetros

NomeEmTipoDescrição
idpathstringobrigató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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/stocks/10457' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Detalhes da entidade stock
{
  "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": []
}
200 · Erro: registo inexistente
{
  "success": 0,
  "errormsg": "registo inexistente"
}

Tabelas

Tabelas de estruturas existentes no ERP para consultas diversas.

GET Tabela exercicios

GET/tabelas/exercicios
Devolve uma listagem de exercicios existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
dtmInicioquerystring datedata de Inicio
dtmFimquerystring datedata 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/exercicios?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de exercicios paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela zonas

GET/tabelas/zonas
Devolve uma listagem de zonas existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/zonas?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de zonas paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela subzonas

GET/tabelas/subzonas
Devolve uma listagem de subzonas existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/subzonas?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de subzonas paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela taxasiva

GET/tabelas/taxasiva
Devolve uma listagem de taxas de iva existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/taxasiva?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de taxas de iva paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela cat-entidades

GET/tabelas/cat-entidades
Devolve uma listagem de categorias de entidades existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/cat-entidades?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de categorias de entidades paginada
{
  "sEcho": 0,
  "iTotalRecords": 6,
  "iTotalDisplayRecords": 6,
  "aaData": [
    {
      "Id": "6",
      "intCodigo": "6",
      "strDescricao": "ENTIDADES - OUTRAS PARTES RELACIONADAS"
    },
    {
      "Id": "5",
      "intCodigo": "5",
      "strDescricao": "ENTIDADES - EMPREENDIMENTOS CONJUNTOS"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela funcionarios

GET/tabelas/funcionarios
Devolve uma listagem de funcionários existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/funcionarios?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de categorias de entidades paginada
{
  "sEcho": 0,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": [
    {
      "Id": 101,
      "intCodigo": "101",
      "strNome": "João Dias"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela vendedores

GET/tabelas/vendedores
Devolve uma listagem de vendedores existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/vendedores?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de categorias de entidades paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela numeradores

GET/tabelas/numeradores
Devolve uma listagem de numeradores de docs existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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
strAbrevTpDocquerystringTipo de documento
strCodSeccaoquerystringCódigo da secção
strCodExercicioquerystringCó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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/numeradores?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de numeradores paginada
{
  "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": ""
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela familias

GET/tabelas/familias
Devolve uma listagem de famílias existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/familias?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de famílias paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela tipofamilias

GET/tabelas/tipofamilias
Devolve uma listagem de tipo de famílias existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tipofamilias?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de tipo de famílias paginada
{
  "sEcho": 0,
  "iTotalRecords": 2,
  "iTotalDisplayRecords": 2,
  "aaData": [
    {
      "Id": "11",
      "strCodigo": "2",
      "strDescricao": "Sub Familia",
      "intNivel": "2"
    },
    {
      "Id": "10",
      "strCodigo": "1",
      "strDescricao": "Familia",
      "intNivel": "1"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela tipoartigos

GET/tabelas/tipoartigos
Devolve uma listagem de tipo de artigos existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tipoartigos?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de tipo de artigos paginada
{
  "sEcho": 0,
  "iTotalRecords": 6,
  "iTotalDisplayRecords": 6,
  "aaData": [
    {
      "Id": "6",
      "strCodigo": "10",
      "strDescricao": "Serviços"
    },
    {
      "Id": "5",
      "strCodigo": "5",
      "strDescricao": "Revistas, Jornais e Outros"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela meiosexpedicao

GET/tabelas/meiosexpedicao
Devolve uma listagem de meios de expedição existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/meiosexpedicao?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de meios de expedição paginada
{
  "sEcho": 0,
  "iTotalRecords": 3,
  "iTotalDisplayRecords": 3,
  "aaData": [
    {
      "Id": "3",
      "strCodigo": "3",
      "strDescricao": "Transportadora"
    },
    {
      "Id": "2",
      "strCodigo": "2",
      "strDescricao": "V/Carro"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela categorias

GET/tabelas/categorias
Devolve uma listagem de tipos de categorias no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/categorias?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de categorias paginada
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela tiposcontactos

GET/tabelas/tiposcontactos
Devolve uma listagem de tipos de contactos existentes no ERP

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tiposcontactos?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de tipos de contactos paginada
{
  "sEcho": 0,
  "iTotalRecords": 4,
  "iTotalDisplayRecords": 4,
  "aaData": [
    {
      "Id": "4",
      "strCodigo": "4",
      "strDescricao": "Responsavel Armazém"
    },
    {
      "Id": "3",
      "strCodigo": "3",
      "strDescricao": "Distribuição"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela codBarras

GET/tabelas/codBarras
Devolve uma listagem de tipos de códigos de barras do artigo

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/codBarras?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de tipos decódigos de barras paginada
{
  "sEcho": 0,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": [
    {
      "Id": 10,
      "strCodArtigo": "ART-0001",
      "strCodBarras": "5609876543210",
      "fltQuantidade": 6
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Tabela tiposDocumentos

GET/tabelas/tiposDocumentos
Devolve uma listagem de tipos de documentos

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
orderquerystringOrdenação dos resultados (ex Id;DESC)
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/tiposDocumentos?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Devolve uma lista de tipos de documentos
{
  "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"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

GET Configuração da empresa

GET/tabelas/configEmpresa
Parâmetros de configuração da empresa (Tbl_Configuracao_Empresa), em formato DataTables.

Parâmetros

NomeEmTipoDescrição
limitqueryintegerNú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
offsetqueryintegerPaginaçã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
qquerystringValor a pesquisar/filtrar. Normalmente deve ser enviado em conjunto com searchField; se q estiver vazio, o filtro não é aplicado.
ex.: ABC-001
searchFieldquerystringNome 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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/tabelas/configEmpresa?limit=100&offset=0' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Lista paginada de parâmetros
{
  "sEcho": 0,
  "iTotalRecords": 853,
  "iTotalDisplayRecords": 853,
  "aaData": [
    {
      "Id": "1324",
      "strValor": "2023-08-19 10:36:13"
    },
    {
      "Id": "1323",
      "strValor": "1"
    }
  ]
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

Anexos Digitais

Consulta de anexos digitais associados a entidades/documentos.

GET Consultar anexos digitais

GET/anexosdigitais
Consulta anexos digitais e respetivas entidades com filtros opcionais

Parâmetros

NomeEmTipoDescrição
strChave1querystring
strChave2querystring
strChave3querystring
intNumeroqueryinteger
intTipoEntidadequeryinteger

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=0 e errormsg. — object
Pedido (curl)
curl -X GET 'https://api.erpsinc.pt/v1.0.0/anexosdigitais' \
  -H 'X-Api-Key: <a-sua-chave>'
200 · Resultado da consulta de anexos digitais
{
  "success": 1,
  "filters": {
    "strChave1": null,
    "strChave2": null,
    "strChave3": null,
    "intNumero": null,
    "intTipoEntidade": null
  },
  "totalEntidades": 0,
  "totalAnexos": 0,
  "entidades": [],
  "anexos": []
}
403 · Erro: API Key inválida
{
  "success": 0,
  "errormsg": "Acesso inválido"
}

POST Eliminar anexo digital

POST/anexosdigitais
Operações de anexos digitais por act (ex. delete)

Corpo do pedido application/json anexosDigitaisActionRequest

CampoTipoDescrição
actstring deleteobrigatório
idstringIdentificador (GUID) do anexo digital.
ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9
idCabstringAlias 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=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Operação executada com sucesso
{
  "success": 1,
  "message": "string",
  "errormsg": "string",
  "id": "string",
  "deletedAnexos": 1,
  "deletedEntidades": 1,
  "act": "string"
}
200 · Erro: Campo obrigatório em falta: id
{
  "success": 0,
  "errormsg": "Campo obrigatório em falta: id"
}

Picker

Operações auxiliares para processos de picker e WebDAV.

POST Operações picker

POST/picker
Endpoint de operações picker por act (conferDoc, updateBarcode, webdav, batch)

Corpo do pedido application/json pickerRequest

CampoTipoDescrição
actstring conferDoc · updateBarcode · webdav · batchobrigatório
barcodestring
erp_codestring
cloudDirectorystring
serverstring
fileNamestring
filenamestring
mimestring
loginstring
passwordstring
fileContentBase64string
fileContentstring
nomeficheirostring
ficheiro_tipostring
linhasinteger
tipo_internostring
tipostring
destinatariostring
ficheiro_base64string
ficheiro_conteudostring
ficheirostring 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=0 e errormsg. — object
Pedido (curl)
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"
}'
200 · Operação executada com sucesso
{
  "success": 1,
  "message": "Código de barras atualizado com sucesso",
  "mensagem": "Registo adicionado",
  "path": "string",
  "debug": {}
}
200 · Erro: Nenhum conteúdo recebido.
{
  "success": 0,
  "mensagem": "Nenhum conteúdo recebido."
}

Schemas

Estruturas de dados usadas nos pedidos e respostas.

SCHEMA anexosDigitaisActionRequest

Pedido para operações em anexos digitais.
CampoTipoDescrição
actstring deleteobrigatório
idstringIdentificador (GUID) do anexo digital.
ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9
idCabstringAlias de id.
ex.: D3A30537-8F0C-4C66-BD44-2A5C7682A9F9

SCHEMA anexosDigitaisActionResponse

Resposta de operações em anexos digitais.
CampoTipoDescrição
successinteger
ex.: 1
messagestring
errormsgstring
idstring
deletedAnexosinteger
deletedEntidadesinteger
actstring

SCHEMA anexosDigitaisResponse

Resultado da consulta de anexos digitais.
42 campos — mostrar
CampoTipoDescrição
successinteger
ex.: 1
filtersobject
strChave1stringnullable
strChave2stringnullable
strChave3stringnullable
intNumerostringnullable
intTipoEntidadestringnullable
totalEntidadesinteger
totalAnexosinteger
entidadesarray<object>
idCabstringnullable
intTipoEntidadestringnullable
strChave1stringnullable
strChave2stringnullable
strChave3stringnullable
intNumerostringnullable
strChaveCompstringnullable
bitFiscalArchivestringnullable
bitFiscalArchiveHiststringnullable
strAdicionalDescriptionstringnullable
anexosarray<object>
idstringnullable
strCodDocumentacaostringnullable
dtmDataEmissaostringnullable
strRefstringnullable
strObsstringnullable
strLocalstringnullable
intCodSituacaostringnullable
dtmDataSituacaostringnullable
strLoginstringnullable
strIdFicheirostringnullable
Ficheirostring bytenullableConteúdo do ficheiro em Base64.
bitIsForSendstringnullable
bitWithElectronicSignaturestringnullable
AutoIdstringnullable
strCtrlConsistencystringnullable
bitConsistentstringnullable
strDocArchiveNumberstringnullable
bitDocArchiveNumberstringnullable
bitFromInboxstringnullable
strDocInfostringnullable
errormsgstring

SCHEMA artigo

Artigo (SKU) do catálogo do ERP, com os campos usados pelos endpoints de listagem, detalhe, criação e edição em artigos.php.
35 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do artigo.
ex.: 12345
strCodigostringCódigo único do artigo.
ex.: ART-0001
intCodInternostringCódigo interno do artigo.
ex.: 987
strCodBarrasstringnullableCódigo de barras principal do artigo.
ex.: 5601234567890
strAbreviaturastringAbreviatura/alias do artigo.
ex.: ART1
strCodCategoriastringCódigo da categoria associada.
ex.: CAT-10
strTpArtigostringnullableTipo de artigo (ex. M – Mercadoria, S – Serviço).
ex.: M
strDescricaostringDescrição do artigo.
ex.: Camisola 100% algodão
fltPCReferenciastringPreço de custo de referência.
ex.: 8.75
intCodTaxaIvaVendastringCódigo da taxa de IVA a aplicar na venda.
ex.: 23
intCodTaxaIvaComprastringCódigo da taxa de IVA a aplicar na compra.
ex.: 23
strAbrevMedStkstringUnidade de medida para stock.
ex.: UN
strAbrevMedVndstringUnidade de medida para venda.
ex.: UN
strAbrevMedCmpstringUnidade de medida para compra.
ex.: UN
bitNaoMovStkstring1 se não movimenta stock; 0 caso contrário.
ex.: 0
imgImagemstringImagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia.
precosarray<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.
intNumerostringIdentificador/linha de tabela de preços.
ex.: 1
fltPrecostringPreço para a tabela indicada.
ex.: 12.99
intTpIVAstringCódigo/tipo de IVA associado ao preço.
ex.: 23
precosCustoobjectnullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir.
fltPCMediostringPreço de custo médio.
ex.: 8.5
fltPCUltimostringÚltimo preço de custo.
ex.: 8.75
fltPCMaoObrastringCusto de mão de obra.
ex.: 1.25
fltPCMaquinastringCusto de máquina.
ex.: 0.5
fltQuantTotalstringQuantidade total considerada no custo.
ex.: 100
fltCostTotalstringCusto total.
ex.: 875
familiasarray<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.
strCodFamiliastringCódigo da família.
ex.: FAM-ROUPA
strCodTpNivelstringTipo de nível/estrutura da família.
ex.: N1
stocksarray<object>Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia.
strCodArmazemstringCódigo do armazém.
ex.: ARM-01
fltStockQtdstringQuantidade em stock.
ex.: 150
fltStockReservadostringQuantidade reservada.
ex.: 10
bitEVSujeitostringsó leitura
ex.: 0

SCHEMA artigoListagem

Artigo tal como devolvido em 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
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do artigo.
ex.: 12345
strCodigostringCódigo único do artigo.
ex.: ART-0001
intCodInternostringCódigo interno do artigo.
ex.: 987
strCodBarrasstringnullableCódigo de barras principal do artigo.
ex.: 5601234567890
strAbreviaturastringAbreviatura/alias do artigo.
ex.: ART1
strCodCategoriastringCódigo da categoria associada.
ex.: CAT-10
strTpArtigostringnullableTipo de artigo (ex. M – Mercadoria, S – Serviço).
ex.: M
strDescricaostringDescrição do artigo.
ex.: Camisola 100% algodão
fltPCReferenciastringPreço de custo de referência.
ex.: 8.75
intCodTaxaIvaVendastringCódigo da taxa de IVA a aplicar na venda.
ex.: 23
intCodTaxaIvaComprastringCódigo da taxa de IVA a aplicar na compra.
ex.: 23
strAbrevMedStkstringUnidade de medida para stock.
ex.: UN
strAbrevMedVndstringUnidade de medida para venda.
ex.: UN
strAbrevMedCmpstringUnidade de medida para compra.
ex.: UN
bitNaoMovStkstring1 se não movimenta stock; 0 caso contrário.
ex.: 0
imgImagemstringImagem/foto associada ao artigo em base64. Quando não existir, o endpoint devolve string vazia.
precosobjectnullablePrimeiro registo de precos (no detalhe GET /artigos/{id} é devolvida a coleção completa).
intNumerostringIdentificador/linha de tabela de preços.
ex.: 1
fltPrecostringPreço para a tabela indicada.
ex.: 12.99
intTpIVAstringCódigo/tipo de IVA associado ao preço.
ex.: 23
precosCustoobjectnullablePreço de custo obtido de Tbl_Gce_ArtigosPrecosCusto; devolve sempre apenas o primeiro registo encontrado, ou null se não existir.
fltPCMediostringPreço de custo médio.
ex.: 8.5
fltPCUltimostringÚltimo preço de custo.
ex.: 8.75
fltPCMaoObrastringCusto de mão de obra.
ex.: 1.25
fltPCMaquinastringCusto de máquina.
ex.: 0.5
fltQuantTotalstringQuantidade total considerada no custo.
ex.: 100
fltCostTotalstringCusto total.
ex.: 875
familiasobjectnullablePrimeiro registo de familias (no detalhe GET /artigos/{id} é devolvida a coleção completa).
strCodFamiliastringCódigo da família.
ex.: FAM-ROUPA
strCodTpNivelstringTipo de nível/estrutura da família.
ex.: N1
stocksarray<object>Saldos de stock por armazém. Se bitNaoMovStk=1, o endpoint devolve normalmente uma lista vazia.
strCodArmazemstringCódigo do armazém.
ex.: ARM-01
fltStockQtdstringQuantidade em stock.
ex.: 150
fltStockReservadostringQuantidade reservada.
ex.: 10
bitEVSujeitostringsó leitura
ex.: 0

SCHEMA categoria

Categoria de artigos.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 10
strCodigostringCódigo da categoria.
ex.: CAT-10
strDescricaostringDescrição da categoria.
ex.: Têxtil
bitNaoMovStkstringIndicador 'não movimenta stock' (0/1 como string).
ex.: 0

SCHEMA catentidades

Categoria de entidade (cliente/fornecedor).
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
intCodigostringCódigo da categoria.
ex.: A
strDescricaostringDescrição.
ex.: A - Preferencial

SCHEMA cliente

Entidade cliente.
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do cliente.
ex.: 2001
intCodigostringCódigo numérico do cliente.
ex.: 2001
strNomestringNome do cliente.
ex.: Loja Exemplo, Lda
strNumContribstringNIF/VAT do cliente.
ex.: PT123456789
bitConsumidorFinalstring1 se consumidor final; 0 caso contrário.
ex.: 0
strTelefonestringnullableTelefone.
ex.: +351 212345678
strTelemovelstringnullableTelemóvel.
ex.: +351 912345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua A, 100
strMorada_lin2stringnullableMorada (linha 2).
ex.: Parque Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringnullableCódigo postal.
ex.: 2400-000
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
bitUseElectronicDocumentstring1 se usa documento eletrónico.
ex.: 1
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
bitPortalWebstring1 se tem acesso ao portal web.
ex.: 0
intSinalTpstringTipo de sinal (quando aplicável).
ex.: 0
intCodCatEntidadestringnullableCódigo da categoria de entidade.
ex.: 1
bitAviso_vencimentostring1 se envia aviso de vencimento.
ex.: 1
intCodVendedorstringnullableCódigo do vendedor associado.
ex.: 101
strObsstringnullableObservações gerais.
ex.: Cliente preferencial.
dtmAberturastring date-timeData de abertura.
ex.: 2024-05-10T10:00:00Z
dtmAlteracaostring date-timeData de alteração.
ex.: 2025-01-02T09:00:00Z

SCHEMA clienteUpdateResponse

CampoTipoDescrição
successinteger
ex.: 1
messagestring
ex.: Cliente atualizado
errormsgstring
Idinteger
ex.: 74
dataclientenullableCliente após a atualização.

SCHEMA codbarras

Códigos de barras alternativos por artigo.
CampoTipoDescrição
IdintegerobrigatórioIdentificador da linha de código de barras.
ex.: 10
strCodArtigostringCódigo do artigo.
ex.: ART-0001
strCodBarrasstringCódigo de barras.
ex.: 5609876543210
fltQuantidadenumberQuantidade por código de barras (embalagem).
ex.: 6

SCHEMA compra

Documento de compra (cabeçalho) com linhas. O endpoint aceita/devolve ainda outros campos ERP presentes em compras.php, incluindo importação por documents/QR.
222 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador da compra.
ex.: 8001
strCodSeccaostringSecção.
ex.: CMP
strAbrevTpDocstringTipo de doc (abreviado).
ex.: NDC
strCodExerciciostringExercício.
ex.: 2025
intNumerostringNúmero interno.
ex.: 12
strNumerostringNúmero formatado.
ex.: NDC/2025/00012
strNumExternostringNº do fornecedor.
ex.: INV-2025-88
dtmDatastring dateData do documento.
ex.: 2025-11-06
strHorastring timeHora do documento.
ex.: 15:30:00
bitAnuladostring1 se anulado; 0 caso contrário.
ex.: 0
intTpEntidadestringTipo de entidade (2=Fornecedor, etc.).
ex.: 2
intCodEntidadestringCódigo da entidade.
ex.: 3001
intDireccaostringDireção (1=Entrada, -1=Saída).
ex.: 1
fltDescontoCabstringDesconto de cabeçalho.
ex.: 0
fltDescontoFinstringDesconto financeiro.
ex.: 0
strCodCondPagstringCondições de pagamento.
ex.: 30D
strNumRequisicaostringNº da requisição.
dtmDataRequisicaostring dateData da requisição.
dtmDataVencimentostring dateData de vencimento.
ex.: 2025-12-06
strAbrevSubZonastringSubzona/rota.
ex.: LRA
strAbrevMoedastringMoeda.
ex.: EUR
fltCambiostringCâmbio.
ex.: 1
strMeioExpedicaostringnullableMeio de expedição.
ex.: Transportadora
strLocalCargastringnullableLocal de carga.
ex.: Fornecedor
strLocalDescargastringnullableLocal de descarga.
ex.: Armazém A
strObsstringnullableObservações.
ex.: Urgente
strECVDNumContribstringNIF no documento do fornecedor.
ex.: PT987654321
strECVDNomestringNome no doc fornecedor.
ex.: Fornecedor Exemplo
strECVDMoradastringMorada no doc fornecedor.
ex.: Av. Y, 10
strECVDLocalidadestringLocalidade no doc fornecedor.
ex.: Porto
strECVDCodPostalstringCódigo postal.
ex.: 4000-000
strECVDTelefonestringTelefone fornecedor.
ex.: +351 222222222
bitECVDRetIRSinteger1 se retém IRS.
ex.: 0
intCodVendedorintegerCódigo do vendedor (se aplicável).
ex.: 0
intTpComissaointegerTipo de comissão.
ex.: 0
fltComissaoValornumberValor de comissão.
ex.: 0
fltComissaoPercentnumberPercentagem de comissão.
ex.: 0
fltComissaoPenaliznumberPenalização de comissão.
ex.: 0
fltComissaoValorBasenumberBase de comissão.
ex.: 0
bitComissaoDispLiqintegerDisponibiliza comissão em liquidação.
ex.: 0
dtmComissaoDataDispstring dateData da disponibilização da comissão.
intTpComissaoDescontosintegerRegras de descontos p/ comissão.
ex.: 0
bitIvaIncluidostring1 se preços incluem IVA.
ex.: 0
bitRegimeVendaintegerRegime.
ex.: 0
fltInfTotalArtigosstringNº de artigos distintos.
ex.: 2
fltInfTotalLinhasstringNº de linhas.
ex.: 2
fltInfTotalQtdstringQuantidade total.
ex.: 100
fltTotalMercadoriaSIVAstringTotal s/ IVA.
ex.: 1000
fltTotalMercadoriaCIVAstringTotal c/ IVA.
ex.: 1230
fltTotalDescontosSIVAstringDescontos s/ IVA.
ex.: 0
fltTotalDescontosCIVAstringDescontos c/ IVA.
ex.: 0
fltTotalDescontosFinSIVAstringDesc. financeiros s/ IVA.
ex.: 0
fltTotalDescontosFinCIVAstringDesc. financeiros c/ IVA.
ex.: 0
fltTotalOutrosSIVAstringOutros s/ IVA.
ex.: 0
fltTotalOutrosCIVAstringOutros c/ IVA.
ex.: 0
fltTotalAcertosstringAcertos.
ex.: 0
intIVACodTaxa1stringCódigo taxa IVA 1.
ex.: 23
intIVACodTaxa2stringCódigo taxa IVA 2.
ex.: 0
fltIVATaxa1stringPercentagem IVA 1.
ex.: 23
fltIVATaxa2stringPercentagem IVA 2.
ex.: 0
fltIVAIncidencia1stringIncidência IVA 1.
ex.: 1000
fltIVAIncidencia2stringIncidência IVA 2.
ex.: 0
fltIVAValor1stringValor IVA 1.
ex.: 230
fltIVAValor2stringValor IVA 2.
ex.: 0
fltTotalIVAstringTotal IVA.
ex.: 230
fltSubTotalstringSubtotal.
ex.: 1000
fltIRSTaxastringTaxa IRS.
ex.: 0
fltIRSIncidenciastringIncidência IRS.
ex.: 0
fltIRSValorRetidostringValor retido IRS.
ex.: 0
fltTotalstringTotal do documento.
ex.: 1230
fltTotalPagamentosstringTotal de pagamentos registados.
ex.: 0
fltTroconumberTroco.
ex.: 0
strAplicacaoOrigemstringAplicação origem.
ex.: Integrador-WS
dtmDataAberturastring date-timeData de abertura.
ex.: 2025-11-06T15:00:00Z
dtmDataAlteracaostring date-timeData de alteração.
ex.: 2025-11-06T15:40:00Z
strCodRubricastringnullableRubrica contabilística.
bitArrImpostosstringIndicadores de impostos (bitwise).
ex.: 0
dtmDataEntregaCabstring dateData prevista de receção.
ex.: 2025-11-10
strHoraEntregaCabstring timeHora prevista de receção.
ex.: 14:00:00
intCodCatEntidadestringnullableCategoria da entidade.
ex.: 1
intLinhaPrecointegerLinha/tabela de preço aplicada.
ex.: 1
dtmDataEstadostring date-timeData do estado.
ex.: 2025-11-06T15:30:00Z
strObsEstadostringnullableObservações do estado.
strCodEstadoDocstringnullableEstado do documento.
ex.: ABERTO
fltTotalToPaystringTotal por pagar.
ex.: 1230
strMotivoIsencaostringnullableMotivo de isenção de IVA (se aplicável).
strLoginstringUtilizador.
ex.: nsantos
strLoginCriacaostringUtilizador de criação.
ex.: nsantos
strLoginEstadostringUtilizador que alterou o estado.
ex.: mferreira
dtmDataAlteracaoEstadostring date-timeData/hora de alteração de estado.
ex.: 2025-11-06T15:35:00Z
linhasarray<linhaCompra>Linhas do documento de compra.
intCompraEncargostringsó leitura
ex.: 0
bitDocEncargosstringsó leitura
ex.: 0
intMercadostringsó leitura
ex.: 1
dtmDataCargastringsó leitura
ex.: 2015-08-13 00:00:00
strHoraCargastringsó leitura
ex.: 12:28
strViaturastringnullable só leitura
bitUrgentestringsó leitura
ex.: 0
strFCDNumContribstringsó leitura
ex.: ESA123456
strFCDNomestringsó leitura
ex.: INTRACOMUNITARIO
strFCDMoradastringsó leitura
ex.: A
strFCDCodPostalstringsó leitura
ex.: 1000-000
strFCDTelefonestringnullable só leitura
bitFCDRetIRSstringsó leitura
ex.: 0
fltEncargosValorSIVAstringsó leitura
ex.: .000000
fltEncargosValorCIVAstringsó leitura
ex.: .000000
fltEncargosDescontosSIVAstringsó leitura
ex.: .000000
fltEncargosDescontosCIVAstringsó leitura
ex.: .000000
fltEncargosIVAstringsó leitura
ex.: .000000
fltEncargosIRSstringsó leitura
ex.: .000000
fltEncargosIRSIncidstringsó leitura
ex.: .000000
fltEncargosTotalstringsó leitura
ex.: .000000
fltEncargosPorDistribuirstringsó leitura
ex.: .000000
fltEncargosDistribuidostringsó leitura
ex.: .000000
intIVACodTaxa3stringsó leitura
ex.: -1
intIVACodTaxa4stringsó leitura
ex.: -1
intIVACodTaxa5stringsó leitura
ex.: -1
intIVACodTaxa6stringsó leitura
ex.: -1
fltIVATaxa3stringsó leitura
ex.: .000000
fltIVATaxa4stringsó leitura
ex.: .000000
fltIVATaxa5stringsó leitura
ex.: .000000
fltIVATaxa6stringsó leitura
ex.: .000000
fltIVAIncidencia3stringsó leitura
ex.: .000000
fltIVAIncidencia4stringsó leitura
ex.: .000000
fltIVAIncidencia5stringsó leitura
ex.: .000000
fltIVAIncidencia6stringsó leitura
ex.: .000000
fltIVAValor3stringsó leitura
ex.: .000000
fltIVAValor4stringsó leitura
ex.: .000000
fltIVAValor5stringsó leitura
ex.: .000000
fltIVAValor6stringsó leitura
ex.: .000000
fltValorPagostringsó leitura
ex.: .000000
fltValorPendentestringsó leitura
ex.: 5000.000000
intSinalstringsó leitura
ex.: 1
bitConversaostringsó leitura
ex.: 0
bitConvertidostringsó leitura
ex.: 0
UpdateStampstringsó leitura
ex.: /��
fltValorIVARegPagostringsó leitura
ex.: .000000
fltIncidenciaIVARegPagostringsó leitura
ex.: .000000
fltIVAValorND1stringsó leitura
ex.: .000000
fltIVAValorND2stringsó leitura
ex.: .000000
fltIVAValorND3stringsó leitura
ex.: .000000
fltIVAValorND4stringsó leitura
ex.: .000000
fltIVAValorND5stringsó leitura
ex.: .000000
fltIVAValorND6stringsó leitura
ex.: .000000
fltTotalIVANDstringsó leitura
ex.: .000000
strIntraCodEntregastringnullable só leitura
strIntraCodPaisstringnullable só leitura
strIntraDescPaisstringnullable só leitura
intIntraModTransstringsó leitura
ex.: 0
strIntraTpTransstringnullable só leitura
strIntraCodTransstringnullable só leitura
intIntraNatAstringsó leitura
ex.: 0
intIntraNatBstringsó leitura
ex.: 0
strForteAbrevMoedastringnullable só leitura
fltForteCambiostringsó leitura
ex.: .000000000000000000
bitForteDifCambialstringsó leitura
ex.: 0
bitEVLiquidoComEcovalorstringsó leitura
ex.: 0
fltEVTotalPilhasstringsó leitura
ex.: .000000
fltEVTotalPneusstringsó leitura
ex.: .000000
fltEVTotalOleosstringsó leitura
ex.: .000000
fltEVTotalREEEstringsó leitura
ex.: .000000
fltEVTotalDAutorstringsó leitura
ex.: .000000
fltEVTotalNaoDefinidostringsó leitura
ex.: .000000
fltEVTotalstringsó leitura
ex.: .000000
bitEVEntidadeIsentastringsó leitura
ex.: 1
strFEDadosRecepstringnullable só leitura
bitEfectuaInversaoIVAstringsó leitura
ex.: 0
bitExigivelIVAstringsó leitura
ex.: 0
fltValorIVAPendentestringsó leitura
ex.: .000000
strFCDLocalidadestringsó leitura
ex.: A
strHashstringsó leitura
ex.: 0
intHashControlstringsó leitura
ex.: 0
bitUpdateIntegradorstringsó leitura
ex.: 0
bitDocOrigemWEBstringsó leitura
ex.: 0
strATDocCodeIDstringnullable só leitura
intATDocCodeStatusstringnullable só leitura
strATDocCodeStatusstringnullable só leitura
bitCargaEnderecoAdicionalstringsó leitura
ex.: 0
strCargaMoradastringnullable só leitura
strCargaLocalidadestringnullable só leitura
strCargaCodPostalstringnullable só leitura
strCargaCodPaisstringnullable só leitura
ex.: PT
bitDescargaEnderecoAdicionalstringsó leitura
ex.: 0
strDescargaMoradastringnullable só leitura
strDescargaLocalidadestringnullable só leitura
strDescargaCodPostalstringnullable só leitura
strDescargaCodPaisstringnullable só leitura
ex.: PT
bitAddYearIdDocATstringnullable só leitura
strSaftDocNOstringnullable só leitura
dtmDataLancamentostringsó leitura
ex.: 2015-08-13 00:00:00
dtmDataMovCTEstringsó leitura
ex.: 2015-08-13 00:00:00
dtmDataMovSTKstringsó leitura
ex.: 2015-08-13 00:00:00
bitIvaCaixaVencidostringsó leitura
ex.: 0
bitIvaCaixaVencidoDCstringsó leitura
ex.: 0
fltDocumentSumTaxesstringsó leitura
ex.: .000000
fltDocumentSumRetentionsstringsó leitura
ex.: .000000
intTaxTypeCalculationstringsó leitura
ex.: 0
fltValorPagoCmpstringsó leitura
ex.: .000000
bitGenerateAutomaticSettlementsstringsó leitura
ex.: 0
bitNotCalculateRetentionsstringsó leitura
ex.: 0
fltDocSumTaxesExpensestringsó leitura
ex.: .000000
fltDocSumRetentionsExpensestringsó leitura
ex.: .000000
bitNotCalculateTotalsstringsó leitura
ex.: 0
strMoradaLin2stringnullable só leitura
str1MotivoIsencaostringnullable só leitura
str1CodOficialMotIVAIsencaostringnullable só leitura
strFCDEmailstringnullable só leitura
bitPartiallyIntegratedstringsó leitura
ex.: 0
strATCUDstringnullable só leitura
strQRCODEstringnullable só leitura
dtmDataExpFactATstringnullable só leitura
bitIsCancellationOrRectificationstringsó leitura
ex.: 0
bitAnuladoAntstringsó leitura
ex.: 0
bitCostsByExitCostingstringsó leitura
ex.: 0
bitCompensationAllLinesstringsó leitura
ex.: 0
bitNotPrintsPricesAndTaxesstringsó leitura
ex.: 0
fltRetentionReductedOutstandingValuestringsó leitura
ex.: .000000
fltRetentionReductedOutstandingValuePendstringsó leitura
ex.: .000000
bitFullyCompensatedSourceDocsstringsó leitura
ex.: 0
strStateTaxNumberstringnullable só leitura
strOperationTypestringnullable só leitura
intPrintCountstringsó leitura
ex.: 0

SCHEMA compraImportDocument

CampoTipoDescrição
field_AstringNIF do emitente (fornecedor).
ex.: 509999999
field_Fstring dateobrigatórioData do documento (YYYYMMDD ou YYYY-MM-DD).
ex.: 2026-11-12
field_GstringobrigatórioIdentificação do documento (nº).
ex.: FT 2026A/1543
field_HstringHash (4 caracteres).
field_InumberTotal da mercadoria com IVA.
field_I3numberBase tributável à taxa intermédia (13%).
field_I4numberIVA à taxa intermédia.
field_I5numberBase tributável à taxa reduzida (6%).
field_I6numberIVA à taxa reduzida.
field_I7numberBase tributável à taxa normal (23%).
field_I8numberIVA à taxa normal.
field_JstringHash (alternativo a field_H).
field_KstringATCUD.
field_NnumberTotal de IVA.
field_OnumberTotal do documento com impostos.
ex.: 123.0
field_QstringCódigo de identificação do documento na AT.
field_RstringControlo do hash / estado do documento AT.
field_SstringPagamentos, valores separados por ; (o total é gravado como valor pago).
field_TstringConteúdo integral do QR code.
strCodExerciciostring
intNumerointeger
strNumerostring
linhasarray<compraImportLinha>
line_itemsarray<compraImportLinha>Alias de linhas.

SCHEMA compraImportLinha

Linha do documento. Aceita colunas de Mov_Compra_Lin ou as chaves abaixo (maiúsculas/minúsculas indiferentes).
CampoTipoDescrição
PRODUCT_CODEstringCódigo do artigo (strCodArtigo).
ITEMstringDescrição (strDescArtigo).
QUANTITYnumber
ex.: 1
UNIT_PRICEnumber
ex.: 100.0
PRICEnumberTotal da linha com IVA.
ex.: 123.0
PRICE_VATnumberTotal da linha sem IVA.
ex.: 100.0
IVA_TAXAnumberTaxa de IVA em %.
ex.: 23

SCHEMA compraImportRequest

Importação de documentos de compra (faturas de fornecedor). Cada documento usa os campos do QR code fiscal AT (field_*). Aceita documents[], document (um só) ou os campos de um documento no corpo raiz. Campos adicionais com o nome de colunas de Mov_Compra_Cab (no corpo raiz ou no documento) são gravados diretamente.
CampoTipoDescrição
databasestringBase de dados da empresa.
ex.: emp_236
strAbrevTpDocstringobrigatório
ex.: VFA
strCodSeccaostringobrigatório
ex.: 1
strCodExerciciostringPor defeito, o exercício da data do documento.
intNumerointegerNúmero interno; por defeito o próximo do numerador.
strNumerostring
intTpEntidadeinteger
ex.: 2
intCodEntidadeintegerCódigo do fornecedor; se omitido é procurado pelo NIF (field_A).
strAbrevMoedastring
ex.: EUR
intSinalinteger
fltSubTotalnumber
fltInfTotalQtdnumber
por omissão: 1
fltInfTotalLinhasnumber
fltInfTotalArtigosnumber
por omissão: 1
documentsarray<compraImportDocument>
documentcompraImportDocument

SCHEMA compraImportResponse

CampoTipoDescrição
successinteger1 se nenhum documento deu erro.
ex.: 1
resultadoobject
novoarray<string>Documentos criados (field_G).
existarray<string>Documentos já existentes.
errorarray<string>Erros por documento.
errormsgstring

SCHEMA configEmpresa

Parâmetro de configuração da empresa (Tbl_Configuracao_Empresa).
CampoTipoDescrição
Idstringsó leitura
ex.: 1324
strValorstringsó leitura
ex.: 2023-08-19 10:36:13

SCHEMA contacto

Contacto associado a cliente/fornecedor.
31 campos — mostrar
CampoTipoDescrição
strChaveEntidadeintegerobrigatórioChave/código da entidade associada.
ex.: 2001
IdintegerIdentificador do contacto.
ex.: 5
intCodContactostringCódigo interno do contacto.
ex.: C-05
strNomestringNome do contacto.
ex.: Ana Silva
strCargostringCargo/função.
ex.: Compras
intCodEntRelacionadastringCódigo da entidade relacionada (se aplicável).
strNomeEnderecostringNome para endereço/envio.
ex.: Armazém Loja Exemplo
strMorada1stringMorada (linha 1).
ex.: Rua A, 100
strMorada2stringMorada (linha 2).
strLocalidadestringLocalidade.
ex.: Leiria
strCodPostalstringCódigo postal.
ex.: 2400-000
strTelEmpresastringTelefone empresa.
ex.: +351 212345678
strTelemovelstringTelemóvel.
ex.: +351 912345678
strEmail1stringEmail principal.
strEmail2stringEmail alternativo.
strWebsitestringWebsite associado.
ex.: https://www.lojaexemplo.pt
dtmNascimentostring dateData de nascimento (YYYY-MM-DD).
ex.: 1990-07-21
intNumLinhaintegerNº de linha/index (quando parte de listagem).
ex.: 1
imgFotostringFoto/imagem associada ao contacto.
strCodTpContactostringTipo de contacto.
ex.: GERAL
strTelParticularstringTelefone particular.
ex.: +351 912345678
strObservacoesstringObservações.
strLoginAberturastringUtilizador de criação.
ex.: api
strLoginAlteracaostringUtilizador da última alteração.
ex.: api
strAbrevZonastringZona comercial.
ex.: CEN
strAbrevSubzonastringSubzona comercial.
ex.: LRA
strNumContribstringNIF associado ao contacto.
ex.: PT123456789
bitInactivointeger1 se o contacto estiver inativo.
ex.: 0
intTipoEntidadeintegerTipo de entidade associada.
ex.: 1
dtmAberturastring date-timeData de criação.
ex.: 2025-01-02 09:00:00.000
dtmAlteracaostring date-timeData de alteração.
ex.: 2025-01-15 10:30:00.000

SCHEMA ctb_conta

35 campos — mostrar
CampoTipoDescrição
strCodExerciciostring
ex.: 2026
strContastring
ex.: 62221
strDescricaostring
bitMovimentastring1 = conta de movimento (aceita lançamentos)
bitRecapitulastring
strConta_Ivastringnullable
intCodTaxaIvastringnullableCódigo de IVA associado à conta (Tbl_Taxas_Iva.intCodigo).
fltVatRatestringnullable
strCodFichRepartstringnullable? = exige centro de custo
strNumContribstringNIF associado (contas correntes).
strRefl_deb_debstringnullable só leitura
strRefl_deb_crestringnullable só leitura
strRefl_cre_debstringnullable só leitura
strRefl_cre_crestringnullable só leitura
bitDefineFluxosstringsó leitura
strFluxos_Debstringnullable só leitura
strFluxos_Crestringnullable só leitura
strFluxos_Balstringnullable só leitura
bitTaxastringsó leitura
fltTaxaValorstringsó leitura
ex.: .000000
dtmAberturastringsó leitura
ex.: 2026-11-03 00:00:00
dtmAlteracaostringsó leitura
ex.: 2026-11-03 00:00:00
fltCustoFixostringsó leitura
ex.: .000000
intTpImostringnullable só leitura
fltTaxaRetencaoIRSstringnullable só leitura
ex.: .000000
intCodRubricaImpstringnullable só leitura
intZonaRetencaoIRSstringsó leitura
ex.: 0
bitNaoGerirPendentesstringsó leitura
strCodTpRemuneracaostringnullable só leitura
strCodePlanstringsó leitura
ex.: CONTAB
fltPercNotDeductiblestringsó leitura
ex.: .000000
bitGenerateThirdsstringsó leitura
intTaxonomyCodestringnullable só leitura
bitManageDeferralsstringsó leitura
strCriteriaReconciliationstringnullable só leitura

SCHEMA ctb_declperiodica_response

CampoTipoDescrição
successinteger
ex.: 1
dataarray<object>
intCodigointegerNúmero do campo da DP (1..24, 40, 41, 61, 66, 93, 94, ...)
ex.: 4
strAnexostringAnexo da declaração ("1" = rosto)
ex.: 1
fltValornumber float
errormsgstring

SCHEMA ctb_diario

Diário contabilístico.
CampoTipoDescrição
Idstring
ex.: 1
intCodigostring
ex.: 8
strDescricaostring
ex.: Diário Compras
bitFiltrar_Docsstring
ex.: 1
dtmAberturastring date-timenullable
ex.: 2025-01-01 00:00:00.000
dtmAlteracaostring date-time
ex.: 2025-01-15 10:30:00.000
bitDebDifCrestring
ex.: 0
bitPermiteIntroduzirstring
ex.: 1

SCHEMA ctb_eInvoiceTpDoc

Tipo documental eInvoice configurado na contabilidade.
CampoTipoDescrição
strTpDocstringTipo documental eInvoice.
ex.: Fatura
strAbrevTpDocstringAbreviatura do tipo documental.
ex.: FT
strListDocsstringLista/configuração de documentos associados ao tipo.
ex.: FT,FR,NC

SCHEMA ctb_eInvoiceTpDocsResponse

Resposta paginada/DataTables da listagem de tipos documentais eInvoice.
CampoTipoDescrição
sEchointeger
ex.: 0
iTotalRecordsinteger
ex.: 3
iTotalDisplayRecordsinteger
ex.: 3
aaDataarray<ctb_eInvoiceTpDoc>

SCHEMA ctb_entidadeNif

CampoTipoDescrição
nifstring
exerciciostring
clientesarray<ctb_entidadeResumo>
fornecedoresarray<ctb_entidadeResumo>
contasarray<object>
contastring
descricaostring
movimentoboolean
tipostring cliente · fornecedor · outro

SCHEMA ctb_entidadeResumo

CampoTipoDescrição
codigointeger
nomestring
nifstring

SCHEMA ctb_ligacaoCteTipoDoc

Linha de ligação contabilística por tipo de documento (rubricas/contas a usar ao lançar um documento de uma entidade).
CampoTipoDescrição
Rub_Codigostringnullable só leitura
Rub_Descricaostringsó leitura
PC_Descricaostringsó leitura
strContastringsó leitura
ex.: 22110088
strConta_Ivastringnullable só leitura
intCodTaxaIvastringnullable só leitura
fltVatRatestringsó leitura
ex.: .000000
bitTaxastringsó leitura
fltTaxaValorstringsó leitura
ex.: .000000
intNumLinhastringsó leitura
ex.: 1
intValorstringsó leitura
ex.: 100
strTipostringsó leitura
ex.: C
bitCentrosCustostringsó leitura
strCodFichRepartstringnullable só leitura
costCenterRequiredintegersó leitura
ex.: 0

SCHEMA ctb_listDBemp_response

Resposta da listagem de bases de dados de contabilidade.
CampoTipoDescrição
successinteger
ex.: 1
dataarray<empresasBD>

SCHEMA ctb_movimentos

Movimento contabilístico (cabeçalho).
45 campos — mostrar
CampoTipoDescrição
strCodExerciciostringCódigo exercicio
ex.: 2026
intCodDiariostring
ex.: 8
intNum_Diariostring
ex.: 3001
intMesstring
ex.: 3
strDatastring date
ex.: 2026-03-08
strAbrevTpDocstring
ex.: V/FAC
strNum_Docstring
ex.: FAC-2026/123
Idstring
ex.: 10021
strAbrevMoedastring
ex.: EUR
fltCambiostring
ex.: 1
dtmAberturastring date-time
ex.: 2026-03-08 12:31:00.000
dtmAlteracaostring date-time
ex.: 2026-03-08 12:31:00.000
strAplicacaoOrigemstring
ex.: CTEP
strLoginstring
ex.: api
strNum_Diariostring
ex.: 3001
strFArchTaxPayerstring
ex.: 500108668
fltFArchTotalstring
ex.: 123.45
temAnexoDigitalintegerIndicador se o movimento tem anexo digital associado (1=sim, 0=não).
ex.: 1
linhasarray<object>Linhas contabilísticas do movimento.
intNumlinhastring
ex.: 1
strContastring
ex.: 2211001
fltValorstring
ex.: 106
strDescricaostring
ex.: Fatura fornecedor
strDeb_Crestring
ex.: D
intGrp_Tercstring
ex.: -1
strNumContribstring
ex.: 500108668
bitReconciliadostring
ex.: 0
strCodePlanstring
ex.: CONTAB
IdReconciliationstring
ex.: 0
fltValueReconciliedstring
ex.: 0
mov_ccarray<object>Movimentos de centro de custo associados ao movimento contabilístico.
intNumLinhainteger
ex.: 1
intNumLinha_CCinteger
ex.: 1
strConta_CCustostring
ex.: CC001
fltValornumber
ex.: 50
strDeb_Crestring
ex.: D
fltValorMoedanumber
ex.: 50
fltPercentagemnumber
ex.: 100
UpdateStampstring
ex.: 00000000000007D3
Idinteger
ex.: 1
strDatastring date
ex.: 2026-01-15
fltValorRef1number
ex.: 0
fltValorRef2number
ex.: 0
fltValorRef3number
ex.: 0
strCodePlanstring
ex.: CONTAB

SCHEMA ctb_movimentosdiarios_response

CampoTipoDescrição
successinteger
ex.: 1
dataarray<object>
intCodDiariointeger
ex.: 3
strDescDiariostring
ex.: Vendas
strNum_Docstring
ex.: FT 2026/15
strDeb_Crestring D · C
strDatastringData mais antiga do documento no mês
fltValornumber floatSoma de fltValor das linhas do documento nesse lado
intLinhasinteger
errormsgstring

SCHEMA ctb_periodo

CampoTipoDescrição
exerciciostring
ex.: 2026
iniciostring date
ex.: 2026-01-01
fimstring date
ex.: 2026-12-31
bloqueadoboolean
ex.: false
estadostring aberto · fechado

SCHEMA ctb_saldos_response

CampoTipoDescrição
successinteger
ex.: 1
dataarray<object>
strContastring
ex.: 2432319
intMesinteger
ex.: 3
fltCreditonumber float
fltDebitonumber float
fltSaldonumber floatfltCredito - fltDebito
errormsgstring

SCHEMA ctb_taxaIva

CampoTipoDescrição
Idstring
intCodigostring
ex.: 3
strDescricaostring
ex.: Taxa Normal
fltTaxastring
ex.: 23.000000
fltPercNaoDedutivelstring
ex.: .000000
intTaxRegionCodestring0 Continente, 1 Açores, 2 Madeira
ex.: 0
intCodSAFTstring
bitInactivostring
ex.: 0

SCHEMA ctb_taxonomia

Correspondência entre conta do plano e código de taxonomia SNC (Tbl_Plano_Contas_Taxonomies).
CampoTipoDescrição
strExerciseCodestringsó leitura
ex.: 2017
strAccountOrigstringsó leitura
ex.: 892
strAccountDeststringsó leitura
ex.: 892
strDescriptionstringsó leitura
bitMovementstringsó leitura
intTaxonomyCodestringnullable só leitura
bitAccountTransfstringnullable só leitura
intOrderstringsó leitura
ex.: 1
bitInsertstringsó leitura

SCHEMA ctb_tipoDocumento

CampoTipoDescrição
tipoDocumentostring
ex.: VVDIN
descricaostring
ex.: V/ VENDA DINHEIRO
diariointegernullable
ex.: 3
eInvoicearray<object>
tipostring
codigosarray<string>

SCHEMA ctbFileAttachment

Anexo opcional enviado com importMovim.
CampoTipoDescrição
content_base64stringConteúdo do ficheiro em Base64.
filenamestring
ex.: fatura.pdf
pathstring
ex.: /imports/fatura.pdf
sizeinteger
ex.: 12345
mime_typestring
ex.: application/pdf

SCHEMA ctbImportCabId

CampoTipoDescrição
idinteger
strNum_Docstring
intNum_Diariointeger
strCodExerciciostring
intCodDiariointeger
intMesinteger

SCHEMA ctbImportMovimentoDocument

Documento de origem para importMovim.
32 campos — mostrar
CampoTipoDescrição
field_Astring
ex.: 500108668
field_Bstring
field_Cstring
ex.: Fatura fornecedor
field_Dstring
field_Estring
field_Fstring date
ex.: 2026-03-08
field_Gstring
ex.: FAC-2026/123
field_Hstring
field_I1string
field_I2string
field_I3string
field_I4string
field_I5string
field_I6string
field_I7string
field_I8string
field_Nstring
field_Ostring
field_Qstring
field_Rstring
docTypestring
ex.: V/FAC
import_typestring
ex.: qr
dte_addstring date-time
userstring
ex.: api
bitIsForSendinteger
ex.: 0
intTipoEntidadeinteger
ex.: 23
bitFiscalArchiveinteger
ex.: 1
bitFiscalArchiveHistinteger
ex.: 1
adicionalDescriptionstring
accountarray<ctbImportMovimentoLine>
linesarray<ctbImportMovimentoLine>
file_attachmentctbFileAttachmentAnexo opcional enviado com importMovim.

SCHEMA ctbImportMovimentoLine

Linha contabilística recebida em importMovim.
CampoTipoDescrição
strContastring
ex.: 2211001
accountstring
ex.: 2211001
contastring
ex.: 2211001
fltValornumber
ex.: 106
valornumber
ex.: 106
valuenumber
ex.: 106
intGrp_Tercinteger
ex.: -1
strDescricaostring
ex.: Fatura fornecedor
descriptionstring
ex.: Fatura fornecedor
strDeb_Crestring
ex.: D
typestring
ex.: D
tax_ratenumber
ex.: 23
strNumContribstring
ex.: 500108668
taxIdstring
ex.: 500108668
strCentroCustostringCentro de custo (100% do valor da linha). Alternativa simples a mov_cc.
strCodFichRepartstring? indica que a conta exige centro de custo (valida a presença de mov_cc/strCentroCusto).
mov_ccarray<object>Repartição por centros de custo.
strConta_CCustostringCódigo do centro de custo.
cost_centerstringAlias de strConta_CCusto.
fltPercentagemnumber
percentagenumberAlias de fltPercentagem.
fltValornumber
valuenumberAlias de fltValor.
strDeb_Crestring D · C

SCHEMA ctbLancamento

CampoTipoDescrição
idinteger
exerciciostring
diariointeger
mesinteger
numeroDiariointeger
tipoDocumentostring
numeroDocumentostring
dataDocumentostring date
dataLancamentostring date
nifstring
totalnumber double
anuladoboolean
aplicacaoOrigemstring
dataCriacaostring date-time
temAnexoboolean
linhasarray<object>
linhainteger
contastring
naturezastring D · C
valornumber double
descricaostring
nifstring
centrosCustoarray<object>
codigostring
percentagemnumber
valornumber

SCHEMA ctbLancamentoAnexo

PDF original do documento, associado ao lançamento.
CampoTipoDescrição
nomeFicheirostringobrigatório
ex.: FT_2026A_1543.pdf
mimeTypestring application/pdf
por omissão: application/pdf
conteudoBase64string byteobrigatórioConteúdo do ficheiro em Base64 (máx. 10 MB após descodificação).

SCHEMA ctbLancamentoDocumento

CampoTipoDescrição
externalIdstringIdentificador do documento no sistema de origem. É devolvido na resposta para correlação.
ex.: zc-7f3a9c21
diariointegerobrigatórioCódigo do diário (ver /contabilidade/diarios).
ex.: 8
tipoDocumentostringobrigatórioAbreviatura do tipo de documento no ERP (Tbl_Tipos_Documentos) ou tipo/código eInvoice mapeado em /contabilidade/eInvoice_TpDocs.
ex.: FT
numeroDocumentostringobrigatórioNúmero do documento de origem. Faz parte da chave de idempotência.
ex.: FT 2026A/1543
dataDocumentostring dateobrigatório
ex.: 2026-11-12
dataLancamentostring dateData contabilística; define exercício e mês. Por defeito igual a dataDocumento.
ex.: 2026-11-12
periodoobjectOpcional. Se enviado, tem de corresponder ao exercício/mês da data de lançamento.
exerciciostring
ex.: 2026
mesinteger
ex.: 11
descricaostringDescrição do lançamento; usada nas linhas sem descrição própria.
entidadeobjectobrigatório
nifstringobrigatórioNIF da entidade (com ou sem prefixo de país).
ex.: 509999999
nomestring
paisstringCódigo ISO 3166-1 alfa-2.
ex.: PT
totalnumber doubleTotal do documento (opcional, apenas para controlo/arquivo).
ex.: 123.0
linhasarray<ctbLancamentoLinha>obrigatório
anexoctbLancamentoAnexoPDF original do documento, associado ao lançamento.

SCHEMA ctbLancamentoErro

CampoTipoDescrição
codigostring CAMPO_OBRIGATORIO · CAMPO_INVALIDO · DIARIO_INEXISTENTE · TIPO_DOCUMENTO_INEXISTENTE · EXERCICIO_INEXISTENTE · PERIODO_FECHADO · PERIODO_INCOERENTE · CONTA_INEXISTENTE · CONTA_NAO_MOVIMENTO · DESEQUILIBRIO · IVA_INEXISTENTE · IVA_TAXA_DIVERGENTE · CENTRO_CUSTO_OBRIGATORIO · CENTRO_CUSTO_INEXISTENTE · CENTRO_CUSTO_REPARTICAO · ANEXO_INVALIDO · ERRO_INTERNO
mensagemstring
linhaintegernullableNúmero da linha (1 = primeira linha de linhas); null para erros de cabeçalho.
campostringnullableCaminho do campo em erro (ex. linhas[0].conta).

SCHEMA ctbLancamentoLinha

CampoTipoDescrição
contastringobrigatórioConta de movimento do plano de contas (ver /contabilidade/planocontas).
ex.: 62221
naturezastring D · CobrigatórioD = débito, C = crédito.
valornumber doubleobrigatórioValor positivo, com 2 casas decimais.
ex.: 100.0
descricaostring
nifstringNIF da linha, quando diferente do da entidade do cabeçalho.
ivaobjectOpcional; apenas validação. O código tem de existir e, se a conta tiver código de IVA configurado, tem de coincidir. A taxa, se enviada, tem de coincidir com a do código. O espaço fiscal (Continente/Açores/Madeira) é dado pelo próprio código de IVA.
codigointegerobrigatórioCódigo da taxa de IVA no ERP (intCodigo, ver /tabelas/taxasiva).
ex.: 3
taxanumberTaxa em percentagem (controlo; tem de coincidir com o código).
ex.: 23
incidencianumber doubleBase tributável a que o imposto se refere.
ex.: 100.0
centrosCustoarray<object>Repartição por centro de custo. Obrigatória quando a conta o exige. Cada elemento tem percentagem ou valor; a soma tem de ser 100% / o valor da linha.
codigostringobrigatório
ex.: ADM
percentagemnumber
ex.: 100
valornumber double

SCHEMA ctbLancamentoRequest

Pedido de criação de lançamentos contabilísticos (importMovim v2).
CampoTipoDescrição
actstring importMovimV2Opcional neste endpoint.
por omissão: importMovimV2
databasestringobrigatórioBase de dados da empresa (ver /contabilidade/listDBemp).
ex.: emp_236
validarApenasbooleanSe true, executa todas as validações sem gravar.
por omissão: False
documentosarray<ctbLancamentoDocumento>obrigatório

SCHEMA ctbLancamentoResponse

CampoTipoDescrição
successinteger1 se o pedido foi processado (mesmo com documentos em erro).
ex.: 1
resumoobject
recebidosinteger
criadosinteger
existentesinteger
validadosinteger
errosinteger
documentosarray<ctbLancamentoResultado>

SCHEMA ctbLancamentoResultado

CampoTipoDescrição
externalIdstringnullable
numeroDocumentostring
statusstring created · exists · validated · errorcreated gravado; exists já existia (idempotência, nada foi gravado); validated passou as validações (validarApenas=true); error não gravado, ver erros.
lancamentoobjectnullable
idintegerId interno; usar em GET /contabilidade/lancamentos?id=.
exerciciostring
diariointeger
mesinteger
numeroDiariointegerNúmero atribuído pelo Eticadata no diário/mês.
anexoIdstring uuidnullable
errosarray<ctbLancamentoErro>

SCHEMA ctbMovimentosActionRequest

Pedido para operações de movimentos de contabilidade. Em importMovim, aceita importação por documents[] e, por compatibilidade, também um documento único no corpo raiz.
CampoTipoDescrição
dbstringBase de dados/tenant alvo. Obrigatório em deleteMovim para evitar fallback para a BD por defeito.
ex.: emp_236
databasestringAlias de db. Obrigatório em deleteMovim quando db não for enviado.
ex.: emp_236
actstring importMovim · deleteMovim · deleteMovimento · deleteobrigatório
IdintegerIdentificador interno do movimento (alternativa à chave composta para deleteMovim).
ex.: 10021
idintegerAlias de Id.
ex.: 10021
strCodExerciciostringCódigo do exercício. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 2025
intCodDiariointegerCódigo do diário. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 8
intMesintegerMês do movimento. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 1
intNum_DiariointegerNúmero do diário. Em deleteMovim, faz parte da chave composta de eliminação.
ex.: 10001
intNumDiariointegerAlias de intNum_Diario.
ex.: 10001
codDiariointegerCódigo do diário a usar em importMovim. Se omitido, o endpoint usa 8.
ex.: 8
documentsarray<ctbImportMovimentoDocument>Coleção de documentos para importMovim.
accountarray<ctbImportMovimentoLine>Alias legado de linhas contabilísticas quando o pedido envia um único documento no corpo raiz.
linesarray<ctbImportMovimentoLine>Linhas contabilísticas quando o pedido envia um único documento no corpo raiz.
field_AstringNIF/Tax payer do documento externo no modo legado de importMovim.
ex.: 500108668
field_CstringDescrição do documento externo.
ex.: Fatura fornecedor
field_Fstring dateData do documento externo.
ex.: 2026-03-08
field_GstringNúmero externo/documento externo.
ex.: FAC-2026/123
field_NstringTotal de IVA no documento externo.
ex.: 6.00
field_OstringTotal do documento externo.
ex.: 106.00
docTypestringTipo documental de contabilidade a gravar.
ex.: V/FAC
file_attachmentctbFileAttachmentAnexo opcional enviado com importMovim.

SCHEMA ctbMovimentosActionResponse

Resposta de operações de movimentos de contabilidade.
CampoTipoDescrição
successinteger
ex.: 1
messagestring
ex.: Movimento eliminado com sucesso
errormsgstring
ex.: Movimento inexistente
movimentoobject
Idinteger
ex.: 10021
strCodExerciciostring
ex.: 2025
intCodDiariointeger
ex.: 8
intMesinteger
ex.: 12
intNum_Diariointeger
ex.: 36
strNum_Docstring
ex.: 3001
deletedobjectContadores devolvidos por deleteMovim.
cabecalhosinteger
ex.: 1
linhasinteger
ex.: 2
mov_ccinteger
ex.: 1
typestring success · warningwarning quando todos os documentos já existiam (importMovim).
statusinteger
ex.: 200
mensagemstring
ex.: Registo adicionado com sucesso. Doc:509999999 → 110034
recsobjectResultado por documento (importMovim).
novoarray<string>
existarray<string>
errorarray<string>
cab_idsarray<ctbImportCabId>
cab_idsarray<ctbImportCabId>
logobjectEco do pedido recebido.

SCHEMA dataTablesResult

Envelope das listagens (formato DataTables). Todos os valores das colunas da BD são devolvidos como texto.
CampoTipoDescrição
sEchointeger
ex.: 0
iTotalRecordsintegerTotal de registos que cumprem os filtros.
ex.: 1
iTotalDisplayRecordsinteger
ex.: 1
aaDataarray<object>

SCHEMA empresasBD

Base de dados de empresa disponível para consulta CTB.
CampoTipoDescrição
empstringBase de dados da empresa
ex.: emp_001
valuestringValor da base de dados (igual a emp).
ex.: emp_001

SCHEMA encomenda

Documento de encomenda (cabeçalho) com linhas. O endpoint aceita/devolve ainda outros campos ERP presentes em encomendas.php.
92 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador da encomenda.
ex.: 7001
strCodSeccaostringSecção.
ex.: VND
strAbrevTpDocstringTipo de doc (abreviado).
ex.: ENC
strCodExerciciostringExercício.
ex.: 2025
intNumerostringNúmero interno.
ex.: 45
strNumerostringNúmero formatado.
ex.: ENC/2025/00045
strNumExternostringNúmero externo do cliente.
ex.: PO-984
dtmDatastring dateData do documento.
ex.: 2025-11-07
strHorastring timeHora do documento.
ex.: 11:30:00
bitAnuladostring1 se anulado; 0 caso contrário.
ex.: 0
intTpEntidadestringTipo de entidade (1=Cliente, etc.).
ex.: 1
intCodEntidadestringCódigo da entidade.
ex.: 2001
intDireccaostringDireção (1=Entrada, -1=Saída).
ex.: -1
fltDescontoCabstringDesconto de cabeçalho (% ou valor consoante regra).
ex.: 0
fltDescontoFinstringDesconto financeiro.
ex.: 0
strCodCondPagstringCondições de pagamento.
ex.: 30D
strNumRequisicaostringNº da requisição.
dtmDataRequisicaostring dateData da requisição.
dtmDataVencimentostring dateData de vencimento.
ex.: 2025-12-07
strAbrevSubZonastringSubzona/rota.
ex.: LRA
strAbrevMoedastringMoeda.
ex.: EUR
fltCambiostringCâmbio.
ex.: 1.0
strMeioExpedicaostringMeio de expedição.
ex.: Camião
strLocalCargastringLocal de carga.
ex.: Armazém A
strLocalDescargastringLocal de descarga.
ex.: Cliente
strObsstringObservações.
ex.: Entregar em palete.
strECVDNumContribstringNIF na morada de entrega.
ex.: PT123456789
strECVDNomestringNome na morada de entrega.
ex.: Loja Exemplo
strECVDMoradastringMorada de entrega.
ex.: Rua X, 1
strECVDLocalidadestringLocalidade de entrega.
ex.: Leiria
strECVDCodPostalstringCódigo postal de entrega.
ex.: 2400-000
strECVDTelefonestringnullableTelefone de entrega.
ex.: +351 212345678
bitECVDRetIRSstring1 se retém IRS.
ex.: 0
intCodVendedorstringVendedor responsável.
ex.: 201
intTpComissaostringTipo de comissão.
ex.: 0
fltComissaoValorstringValor de comissão.
ex.: 0
fltComissaoPercentstringPercentagem de comissão.
ex.: 0
fltComissaoPenalizstringPenalização de comissão.
ex.: 0
fltComissaoValorBasestringBase de cálculo de comissão.
ex.: 0
bitComissaoDispLiqstringDisponibiliza comissão na liquidação.
ex.: 0
dtmComissaoDataDispstring dateData de disponibilização da comissão.
intTpComissaoDescontosstringRegras de descontos para comissão.
ex.: 0
bitIvaIncluidostring1 se preços incluem IVA.
ex.: 0
bitRegimeVendastringRegime de venda.
ex.: 0
fltInfTotalArtigosstringNº artigos distintos.
ex.: 3
fltInfTotalLinhasstringNº de linhas.
ex.: 3
fltInfTotalQtdstringQuantidade total.
ex.: 30
fltTotalMercadoriaSIVAstringTotal mercadoria sem IVA.
ex.: 300
fltTotalMercadoriaCIVAstringTotal mercadoria com IVA.
ex.: 369
fltTotalDescontosSIVAstringDescontos sem IVA.
ex.: 0
fltTotalDescontosCIVAstringDescontos com IVA.
ex.: 0
fltTotalDescontosFinSIVAstringDescontos financeiros S/IVA.
ex.: 0
fltTotalDescontosFinCIVAstringDescontos financeiros C/IVA.
ex.: 0
fltTotalOutrosSIVAstringOutros valores S/IVA.
ex.: 0
fltTotalOutrosCIVAstringOutros valores C/IVA.
ex.: 0
fltTotalAcertosstringAcertos.
ex.: 0
intIVACodTaxa1stringCódigo taxa IVA 1.
ex.: 23
intIVACodTaxa2stringCódigo taxa IVA 2.
ex.: 0
fltIVATaxa1stringPercentagem taxa IVA 1.
ex.: 23
fltIVATaxa2stringPercentagem taxa IVA 2.
ex.: 0
fltIVAIncidencia1stringIncidência IVA 1.
ex.: 300
fltIVAIncidencia2stringIncidência IVA 2.
ex.: 0
fltIVAValor1stringValor IVA 1.
ex.: 69
fltIVAValor2stringValor IVA 2.
ex.: 0
fltTotalIVAstringTotal IVA.
ex.: 69
fltSubTotalstringSubtotal.
ex.: 300
fltIRSTaxastringTaxa IRS.
ex.: 0
fltIRSIncidenciastringIncidência IRS.
ex.: 0
fltIRSValorRetidostringValor retido IRS.
ex.: 0
fltTotalstringTotal do documento.
ex.: 369
fltTotalPagamentosstringTotal de pagamentos registados.
ex.: 0
fltTrocostringTroco.
ex.: 0
strAplicacaoOrigemstringAplicação origem.
ex.: Integrador-WS
dtmDataAberturastring date-timeData de abertura.
ex.: 2025-11-07T11:20:00Z
dtmDataAlteracaostring date-timeData de alteração.
ex.: 2025-11-07T11:40:00Z
strCodRubricastringnullableRubrica contabilística (quando aplicável).
bitArrImpostosstringIndicadores de impostos (bitwise).
ex.: 0
dtmDataEntregaCabstring dateData de entrega prevista.
ex.: 2025-11-14
strHoraEntregaCabstring timeHora de entrega prevista.
ex.: 16:00:00
intCodCatEntidadeintegernullableCategoria da entidade.
ex.: 1
intLinhaPrecostringLinha/tabela de preço aplicada.
ex.: 1
dtmDataEstadostring date-timeData do estado atual.
ex.: 2025-11-07T11:35:00Z
strObsEstadostringObservações do estado.
strCodEstadoDocstringCódigo do estado do documento.
ex.: ABERTO
fltTotalToPaystringTotal a pagar pendente.
ex.: 369
strMotivoIsencaostringMotivo de isenção de IVA (quando aplicável).
strLoginstringUtilizador.
ex.: nsantos
strLoginCriacaostringUtilizador de criação.
ex.: nsantos
strLoginEstadostringUtilizador que alterou o estado.
ex.: msousa
dtmDataAlteracaoEstadostring date-timeData/hora de alteração de estado.
ex.: 2025-11-07T11:38:00Z
linhasarray<linhaEncomenda>Linhas da encomenda.
intPrintCountstringsó leitura
ex.: 0

SCHEMA exercicio

Exercicio Fiscal
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 11
strCodigostringCódigo
ex.: EX 2026
dtmIniciostring date-timeData Inicio
ex.: 2026-01-01 00:00:00.000
dtmFimstring date-timeData Final
ex.: 2026-12-31 00:00:00.000

SCHEMA familia

Família de artigos.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 10
strCodigostringCódigo da família.
ex.: FAM-ROUPA
strDescricaostringDescrição.
ex.: Roupa
strCodTpFamiliastringTipo de família.
ex.: GERAL

SCHEMA fornecedor

Entidade fornecedor.
CampoTipoDescrição
IdstringobrigatórioIdentificador interno do fornecedor.
ex.: 3001
intCodigostringCódigo do fornecedor.
ex.: 3001
strNomestringNome do fornecedor.
ex.: Fornecedor Exemplo, Lda
strNumContribstringNIF/VAT do fornecedor.
ex.: PT500108668
strTelefonestringnullableTelefone.
ex.: +351 212345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua B, 50
strMorada_lin2stringnullableMorada (linha 2).
ex.: Zona Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringCódigo postal.
ex.: 2400-111
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
intCodCatEntidadestringCódigo da categoria de entidade.
ex.: 1
strObsstringnullableObservações gerais.
dtmAberturastring date-timeData de abertura.
ex.: 2025-01-02 09:00:00.000
dtmAlteracaostring date-timeData de alteração.
ex.: 2025-01-15 10:30:00.000

SCHEMA fornecedores

Estrutura simplificada de fornecedor (listagens).
CampoTipoDescrição
IdstringobrigatórioIdentificador interno.
ex.: 3001
intCodigostringCódigo do fornecedor.
ex.: 3001
strNomestringNome do fornecedor.
ex.: Fornecedor Exemplo, Lda
strNumContribstringNIF/VAT do fornecedor.
ex.: PT500108668
strTelefonestringnullableTelefone.
ex.: +351 212345678
strEmailstringnullableEmail principal.
strMorada_lin1stringMorada (linha 1).
ex.: Rua B, 50
strMorada_lin2stringnullableMorada (linha 2).
ex.: Zona Industrial
strLocalidadestringLocalidade.
ex.: Leiria
strPostalstringCódigo postal.
ex.: 2400-111
strAbrevSubZonastringSubzona/rota comercial.
ex.: LRA
intCodCatEntidadestringnullableCódigo da categoria de entidade.
ex.: 1
strCodCondPagstringnullableCódigo das condições de pagamento.
ex.: 30
strObsstringnullableObservações gerais.
dtmAberturastring date-timeData de abertura.
ex.: 2025-01-02 09:00:00.000
dtmAlteracaostring date-timeData de alteração.
ex.: 2025-01-15 10:30:00.000

SCHEMA funcionarios

Funcionário (registo básico).
CampoTipoDescrição
IdintegerobrigatórioIdentificador.
ex.: 101
intCodigostringCódigo do funcionário.
ex.: 101
strNomestringNome do funcionário.
ex.: João Dias

SCHEMA linhaCompra

Linha de compra. O endpoint aceita/devolve ainda outros campos ERP presentes em compras.php.
126 campos — mostrar
CampoTipoDescrição
IdintegerobrigatórioIdentificador da linha.
ex.: 1
intNumLinhastringNº da linha.
ex.: 1
intTpLinhastringTipo de linha.
ex.: 1
strCodArmazemstringnullableArmazém.
ex.: ARM-01
strCodArtigostringnullableCódigo do artigo.
ex.: ART-0001
strDescArtigostringDescrição do artigo.
ex.: T-Shirt Azul M
strCodLotestringnullableLote (se aplicável).
ex.: L2025-11
fltQuantidadestringQuantidade.
ex.: 50
fltQuantidadeAnulnumberQuantidade anulada.
ex.: 0
fltQuantidadeSatisfstringQuantidade recebida/satisfeita.
ex.: 0
intNumLinhaReservaintegerLinha de reserva (se existir).
ex.: 0
fltQtdReservarStknumberQuantidade a reservar em stock.
ex.: 0
fltPrecoUnitariostringPreço unitário.
ex.: 8
strCodClassMovStkstringnullableClasse de movimento.
ex.: ENT
fltDesconto1stringDesconto 1 (%).
ex.: 0
fltDesconto2stringDesconto 2 (%).
ex.: 0
fltDesconto3stringDesconto 3 (%).
ex.: 0
fltDescontoValorUnitstringValor de desconto unitário.
ex.: 0
fltDescontoValorstringValor total de desconto.
ex.: 0
fltValorLiquidostringValor líquido da linha.
ex.: 400
intCodTaxaIVAstringnullableCódigo taxa IVA.
ex.: 23
fltTaxaIVAstringPercentagem IVA.
ex.: 23
fltComissaoPercnumberPercentagem de comissão.
ex.: 0
fltComissaoValornumberValor de comissão.
ex.: 0
fltComissaoLinhanumberComissão calculada para a linha.
ex.: 0
fltValorMercadoriaCIVAstringValor mercadoria c/ IVA.
ex.: 492
fltValorMercadoriaSIVAstringValor mercadoria s/ IVA.
ex.: 400
fltValorDescontosCIVAstringValor descontos c/ IVA.
ex.: 0
fltValorDescontosSIVAstringValor descontos s/ IVA.
ex.: 0
fltValorDescontosFinCIVAstringDescontos financeiros c/ IVA.
ex.: 0
fltValorDescontosFinSIVAstringDescontos financeiros s/ IVA.
ex.: 0
fltValorAPagarstringValor a pagar da linha.
ex.: 492
CA_Campo01stringnullableCampo personalizado 01.
strMotivoIsencaoIVAstringnullableMotivo de isenção (se aplicável).
strCodOficialMotIVAIsencaostringnullableCódigo oficial do motivo de isenção.
strCodSeccaostringsó leitura
ex.: 1
strAbrevTpDocstringsó leitura
ex.: V/FAC
strCodExerciciostringsó leitura
ex.: 2015
intNumerostringsó leitura
ex.: 2
strCodLocalizacaostringnullable só leitura
fltCustoUnitariostringsó leitura
ex.: 5000.000000
fltValorEncargosIntstringsó leitura
ex.: .000000
fltValorEncargosExtstringsó leitura
ex.: .000000
bitNaoMovStkstringsó leitura
ex.: 0
bitConversaostringsó leitura
ex.: 0
intNumLinhaEncargostringsó leitura
ex.: 1
intTipoAssociacaostringsó leitura
ex.: 0
intLinhaAssociacaostringnullable só leitura
ex.: 0
intLinhaReferenciastringnullable só leitura
ex.: 0
bitSujeitoRetIRSstringsó leitura
ex.: 0
strFormulastringnullable só leitura
ex.: 1
fltMedidaQtdstringsó leitura
ex.: .000000
fltMedida1stringsó leitura
ex.: .000000
fltMedida2stringsó leitura
ex.: .000000
fltMedida3stringsó leitura
ex.: .000000
strDocumOrigemstringnullable só leitura
idstringsó leitura
ex.: 1387
fltPercIvaNDstringsó leitura
ex.: .000000
intConversaoIdNumstringsó leitura
ex.: 0
CA_Campo02stringnullable só leitura
CA_Campo03stringnullable só leitura
CA_Campo04stringnullable só leitura
CA_Campo05stringnullable só leitura
CA_Campo06stringnullable só leitura
CA_Campo07stringnullable só leitura
CA_Campo08stringnullable só leitura
CA_Campo09stringnullable só leitura
CA_Campo10stringnullable só leitura
intIntraCodRegiaostringsó leitura
ex.: 0
intEdicaostringsó leitura
ex.: 0
dtmDataDevolstringsó leitura
ex.: 1900-01-01 00:00:00
strSemanaDevolstringnullable só leitura
strIntraCodPautalstringnullable só leitura
fltIntraPesoLiquidostringsó leitura
ex.: .000000
bitEVSujeitostringsó leitura
ex.: 0
fltEVUnitPilhasstringsó leitura
ex.: .000000
fltEVUnitPneusstringsó leitura
ex.: .000000
fltEVUnitOleosstringsó leitura
ex.: .000000
fltEVUnitREEEstringsó leitura
ex.: .000000
fltEVUnitDAutorstringsó leitura
ex.: .000000
fltEVParcialDAutorstringsó leitura
ex.: .000000
fltEVPercDAutorstringsó leitura
ex.: .000000
fltEVUnitNaoDefinidostringsó leitura
ex.: .000000
fltEVParcialNaoDefinidostringsó leitura
ex.: .000000
fltEVPercNaoDefinidostringsó leitura
ex.: .000000
fltEVTotalstringsó leitura
ex.: .000000
strintracodpaisorigemstringsó leitura
fltPesoLiquidoTotalstringsó leitura
ex.: .000000
strCodMarcastringnullable só leitura
strCodModelostringnullable só leitura
strCodVersaostringnullable só leitura
strCodNivelstringnullable só leitura
strCodFichaRepartstringsó leitura
ex.: 04
strCodContastringsó leitura
strCodContaReflDebstringsó leitura
strCodContaReflCrestringsó leitura
intIdDuplicacaostringsó leitura
ex.: 0
fltGOPQtdAtribuidastringsó leitura
ex.: .000000
intNumLinhaOrigstringsó leitura
ex.: 1
strDocAQueReportastringsó leitura
intNumeroEtiquetasstringsó leitura
ex.: 0
strCodProjectostringnullable só leitura
fltCustototalstringsó leitura
ex.: 5000.000000
intCampaignstringnullable só leitura
bitNotSubjHeaderDiscountstringsó leitura
ex.: 0
intProjectLinestringnullable só leitura
fltNonDeductibleTaxCostValuestringsó leitura
ex.: .000000
fltTotalTaxValueOfIncidenceLiquidstringsó leitura
ex.: .000000
fltTotalTaxValueOfIncidenceLiquidUnitstringsó leitura
ex.: .000000
intConversaoIdNumDststringnullable só leitura
fltPendingQuantitystringsó leitura
ex.: .000000
intLineNumberIntegrstringsó leitura
ex.: 0
fltTotalCompensadostringsó leitura
ex.: .000000
fltValorAPagarAcertostringsó leitura
ex.: .000000
intAutDestinationTpDocstringnullable só leitura
strAutCarKeystringnullable só leitura
strAutSectionCodestringnullable só leitura
strAutDocTypestringnullable só leitura
strAutFiscalYearstringnullable só leitura
intAutDocNumberstringnullable só leitura
intAutLineTypestringnullable só leitura
intAutIdLinestringnullable só leitura
intAutExtraCodestringnullable só leitura
GuidAutIdLinestringnullable só leitura
bitProcessVehicleLinestringsó leitura
ex.: 0
fltOperationalCostValueStdstringsó leitura
ex.: .000000

SCHEMA linhaEncomenda

Linha de encomenda. O endpoint aceita/devolve ainda outros campos ERP presentes em encomendas.php.
41 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador da linha.
ex.: 1
intNumLinhastringNº da linha.
ex.: 1
intTpLinhastringTipo de linha (artigo/texto/etc.).
ex.: 1
strCodArmazemstringnullableArmazém.
ex.: ARM-01
strCodArtigostringnullableCódigo do artigo.
ex.: ART-0001
strDescArtigostringDescrição do artigo.
ex.: T-Shirt Azul M
strCodLotestringnullableLote (se aplicável).
fltQuantidadestringQuantidade pedida.
ex.: 10
fltQuantidadeAnulstringQuantidade anulada.
ex.: 0
fltQuantidadeSatisfstringQuantidade satisfeita/expedida.
ex.: 0
intNumLinhaReservastringLinha de reserva (se existir).
ex.: 0
fltQtdReservarStkstringQuantidade a reservar em stock.
ex.: 10
fltPrecoUnitariostringPreço unitário.
ex.: 10
strCodClassMovStkstringnullableClasse de movimento.
ex.: SAI
fltDesconto1stringDesconto 1 (%).
ex.: 0
fltDesconto2stringDesconto 2 (%).
ex.: 0
fltDesconto3stringDesconto 3 (%).
ex.: 0
fltDescontoValorUnitstringValor de desconto unitário.
ex.: 0
fltDescontoValorstringValor total de desconto.
ex.: 0
fltValorLiquidostringValor líquido da linha.
ex.: 100
intCodTaxaIVAstringnullableCódigo taxa IVA.
ex.: 23
fltTaxaIVAstringPercentagem IVA.
ex.: 23
fltComissaoPercstringPercentagem de comissão.
ex.: 0
fltComissaoValorstringValor de comissão.
ex.: 0
fltComissaoLinhastringComissão calculada para a linha.
ex.: 0
fltValorMercadoriaCIVAstringValor mercadoria c/ IVA.
ex.: 123
fltValorMercadoriaSIVAstringValor mercadoria s/ IVA.
ex.: 100
fltValorDescontosCIVAstringValor descontos c/ IVA.
ex.: 0
fltValorDescontosSIVAstringValor descontos s/ IVA.
ex.: 0
fltValorDescontosFinCIVAstringDescontos financeiros c/ IVA.
ex.: 0
fltValorDescontosFinSIVAstringDescontos financeiros s/ IVA.
ex.: 0
fltValorAPagarstringValor a pagar da linha.
ex.: 123
CA_Campo01stringnullableCampo personalizado 01.
strMotivoIsencaoIVAstringMotivo de isenção (se aplicável).
strCodOficialMotIVAIsencaostringCódigo oficial do motivo de isenção.
strCodSeccaostringsó leitura
ex.: 1
strAbrevTpDocstringsó leitura
ex.: ENCCL
strCodExerciciostringsó leitura
ex.: 2020
intNumerostringsó leitura
ex.: 3
fltQuantidadePendstringsó leitura
ex.: 1.000000
strObsstringnullable só leitura

SCHEMA linhaStock

Linha de movimento de stock. O endpoint aceita/devolve ainda outros campos ERP presentes em stocks.php.
55 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador único da linha.
ex.: 1
strCodSeccaostringCódigo da secção associada.
ex.: Geral
strAbrevTpDocstringAbreviatura do tipo de documento.
ex.: ENT_A
strCodExerciciostringCódigo do exercício.
ex.: 2025
intNumerostringNúmero do documento (cabeçalho).
ex.: 123
intNumLinhastringNúmero sequencial da linha.
ex.: 1
strCodArmazemstringArmazém de destino.
ex.: ARM-01
strCodLocalizacaostringnullableLocalização destino.
ex.: A1-01-01
strCodArtigostringCódigo do artigo.
ex.: ART-0001
strCodLotestringnullableLote do artigo (quando aplicável).
ex.: L2025-11
fltQuantidadestringQuantidade movimentada.
ex.: 50
fltSinalstringSinal da quantidade (1 entrada, -1 saída).
ex.: 1
fltValorUnitariostringValor unitário.
ex.: 10.5
fltSubTotalstringSubtotal da linha.
ex.: 525
strObsstringObservações da linha.
ex.: Receção com palete.
strCodClassMovStkstringnullableClasse de movimento de stock.
ex.: ENT
intTipoAssociacaostringTipo de associação a outro doc.
ex.: 0
intLinhaAssociacaostringLinha associada no doc de origem.
ex.: 0
intLinhaReferenciastringLinha de referência.
ex.: 0
strFormulastringFórmula de cálculo (se usada).
fltMedidaQtdstringQuantidade medida principal.
ex.: 50
fltMedida1stringMedida auxiliar 1.
ex.: 0
fltMedida2stringMedida auxiliar 2.
ex.: 0
fltMedida3stringMedida auxiliar 3.
ex.: 0
bitTransferenciastringIndica se é transferência entre localizações.
ex.: False
strCodArmazemOristringnullableArmazém de origem.
ex.: ARM-00
strCodLocalizacaoOristringnullableLocalização de origem.
ex.: R0-00-00
dtmDataValorstring date-timeData de valorização.
ex.: 2025-11-07T00:00:00Z
intNumLinhaDocOristringLinha do documento de origem.
ex.: 0
intNumLinhaDocOriCompstringLinha complementar de origem.
ex.: 0
intEdicaostringNº de edição/revisão.
ex.: 1
CA_Campo01stringnullableCampo personalizado 01.
CA_Campo02stringnullableCampo personalizado 02.
CA_Campo03stringnullableCampo personalizado 03.
CA_Campo04stringnullableCampo personalizado 04.
CA_Campo05stringnullableCampo personalizado 05.
CA_Campo06stringnullableCampo personalizado 06.
CA_Campo07stringnullableCampo personalizado 07.
CA_Campo08stringnullableCampo personalizado 08.
CA_Campo09stringnullableCampo personalizado 09.
CA_Campo10stringnullableCampo personalizado 10.
strCodDepartamentostringnullableDepartamento associado.
ex.: LOG
dtmDataRecStockstring date-timenullableData de receção do stock.
ex.: 2025-11-07T12:00:00Z
strCodMarcastringnullableMarca do artigo.
ex.: GEN
strCodModelostringnullableModelo do artigo.
ex.: 2025
strCodVersaostringnullableVersão do artigo.
ex.: v1
strCodNivelstringnullableNível hierárquico.
ex.: N1
intIdDuplicacaostringIdentificador de duplicação.
ex.: 0
fltGOPQtdAtribuidastringQtd atribuída a ordens de produção.
ex.: 0
intNumLinhaOrigstringNúmero de linha de origem.
ex.: 0
strCodProjectostringnullableCódigo de projeto.
ex.: PRJ-001
intProjectLineintegernullableLinha do projeto.
ex.: 0
fltQtyReserveToStockstringQtd reservada para stock.
ex.: 0
strProjectCodeOristringnullableCódigo do projeto de origem.
intProjectLineOriintegernullableLinha de projeto de origem.
ex.: 0

SCHEMA meioexpedicao

Meio de expedição/transporte.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strCodigostringCódigo do meio.
ex.: CAM
strDescricaostringDescrição do meio.
ex.: Camião

SCHEMA numeradores

Numeradores por tipo de documento/seção/exercício.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strAbrevTpDocstringAbreviatura do tipo de documento.
ex.: ENC
strCodSeccaostringCódigo da secção.
ex.: VND
strCodExerciciostringExercício.
ex.: 2025
intNum_Mes00stringÚltimo número usado (mês 00 = anual).
ex.: 1234
intTpNumeradorstringsó leitura
ex.: 25
strFormatostringsó leitura
ex.: ####/!AAAA!

SCHEMA operacaoResultado

Resposta padrão das operações de escrita. success=1 com message e Id do registo; success=0 com errormsg.
CampoTipoDescrição
successinteger 0 · 1
ex.: 1
messagestring
ex.: Registo criado
errormsgstringMensagem de erro (quando success=0). Em alguns casos de sucesso parcial (ex. cabeçalho sem linhas) vem com success=1.
ex.: Código existente
IdintegerId do registo criado/alterado.
ex.: 105
logstringDetalhe técnico do erro (quando disponível).

SCHEMA pickerRequest

Pedido para operações do endpoint picker.
CampoTipoDescrição
actstring conferDoc · updateBarcode · webdav · batchobrigatório
barcodestring
erp_codestring
cloudDirectorystring
serverstring
fileNamestring
filenamestring
mimestring
loginstring
passwordstring
fileContentBase64string
fileContentstring
nomeficheirostring
ficheiro_tipostring
linhasinteger
tipo_internostring
tipostring
destinatariostring
ficheiro_base64string
ficheiro_conteudostring
ficheirostring binary

SCHEMA pickerResponse

Resposta do endpoint picker.
CampoTipoDescrição
successinteger
ex.: 1
messagestring
ex.: Código de barras atualizado com sucesso
mensagemstring
ex.: Registo adicionado
pathstringNome do ficheiro gravado (act=webdav).
debugobjectEco dos dados recebidos.

SCHEMA referencia

Referência (modelo/base) que agrupa artigos/variações.
35 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador interno da referência.
ex.: 9876
strCodigostringCódigo da referência.
ex.: REF-TSHIRT
strAbreviaturastringAbreviatura da referência.
ex.: TSH
strCodCategoriastringCódigo da categoria.
ex.: CAT-10
strTpArtigostringnullableTipo (M – Mercadoria, S – Serviço).
ex.: M
strDescricaostringDescrição da referência.
ex.: T-Shirt Algodão
strDescricaoComplstringDescrição complementar/detalhe.
ex.: Coleção Primavera
intTpComposicaostringTipo de composição (quando aplicável).
ex.: 0
bitInactivostring1 se inativo; 0 caso contrário.
ex.: 0
intCodTaxaIvaVendastringCódigo taxa IVA venda.
ex.: 23
intCodTaxaIvaComprastringCódigo taxa IVA compra.
ex.: 23
dtmAberturastring date-timeData de criação.
ex.: 2025-01-15T10:00:00Z
dtmAlteracaostring date-timeData da última alteração.
ex.: 2025-03-02T14:30:00Z
strAbrevMedStkstringUM de stock.
ex.: UN
strAbrevMedVndstringUM de venda.
ex.: UN
bitNaoMovStkstring1 se não movimenta stock.
ex.: 0
strObsstringObservações gerais.
ex.: Linha económica
strCodGrelhaHorstringCódigo da grelha horizontal (ex. tamanhos).
ex.: TAM
strCodGrelhaVerstringnullableCódigo da grelha vertical (ex. cores).
ex.: COR
intTpPrecostringTipo de preço base.
ex.: 1
artigosarray<object>Artigos (variantes) pertencentes à referência.
IdstringId da linha/associação.
ex.: 1
IdArtigostringId do artigo.
ex.: 12345
strCodArtigostringCódigo do artigo.
ex.: ART-0001-BL-M
strDescricaostringDescrição do artigo.
ex.: T-Shirt Azul M
strCodGrelhaHorLinstringValor na grelha horizontal.
ex.: M
strCodGrelhaVerLinstringValor na grelha vertical.
ex.: AZ
stocknumberStock atual do artigo.
ex.: 25
familiasarray<object>Famílias associadas à referência.
strCodFamiliastringCódigo da família.
ex.: FAM-ROUPA
strCodTpNivelstringTipo de nível.
ex.: N1
precosarray<object>Preços por tabela.
intNumerointegerNúmero da tabela de preço.
ex.: 1
fltPreconumberPreço associado.
ex.: 12.99
intTpIVAintegerTipo de IVA.
ex.: 23

SCHEMA stock

Movimento de stock (cabeçalho) com respetivas linhas. O endpoint aceita/devolve ainda outros campos ERP presentes em stocks.php.
33 campos — mostrar
CampoTipoDescrição
IdstringobrigatórioIdentificador único do registo de stock.
ex.: 501
strCodSeccaostringCódigo da secção/departamento.
ex.: Geral
strAbrevTpDocstringAbreviatura do tipo de documento (ENT_A, SAI_B).
ex.: ENT_A
strCodExerciciostringCódigo do exercício (ano).
ex.: 2025
intNumerostringNúmero interno do documento.
ex.: 123
strNumerostringNúmero formatado do documento.
ex.: ENT_A/2025/00123
dtmDatastring date-timeData do documento.
ex.: 2025-11-07T10:00:00Z
bitAnuladostringIndica se o documento está anulado.
ex.: False
strCodArmazemOriDefstringnullableArmazém de origem por defeito.
ex.: ARM-01
strCodLocalizacaoOriDefstringnullableLocalização de origem por defeito.
ex.: A1-01-01
strMeioExpedicaostringnullableMeio de expedição (ex. camião).
ex.: Camião
strLocalCargastringLocal da carga.
ex.: Fábrica A
strLocalDescargastringLocal da descarga.
ex.: Armazém Central
strViaturastringIdentificação da viatura.
ex.: AA-00-BB
strObsstringObservações gerais.
ex.: Conferir quantidades na receção.
fltTotalstringTotal do documento (valor).
ex.: 1500.55
UpdateStampstring date-timeStamp/ETag de atualização.
ex.: 2025-11-07T10:01:22Z
dtmDataAberturastring date-timenullableData de abertura.
ex.: 2025-11-07T09:55:00Z
dtmDataAlteracaostring date-timeData da última alteração.
ex.: 2025-11-07T10:05:00Z
strLoginstringUtilizador responsável.
ex.: nsantos
strAplicacaoOrigemstringAplicação origem.
ex.: Integrador-WS
dtmDataCargastring date-timeData/hora de carga no sistema.
ex.: 2025-11-07T10:02:00Z
strHoraCargastring timeHora da carga (texto).
ex.: 10:02:00
strForteAbrevMoedastringnullableMoeda forte abreviada.
ex.: EUR
fltForteCambiostringTaxa de câmbio aplicada.
ex.: 1.0
bitSafeModebooleannullableDocumento criado em modo seguro.
ex.: true
bitUpdateIntegradorstringAtualizado via integrador.
ex.: True
strCodProjectoOrigemstringnullableCódigo do projeto de origem.
ex.: PRJ-001
intPrintCountstringNúmero de impressões.
ex.: 2
dtmDateDocstring date-timenullableData efetiva do documento.
ex.: 2025-11-07T00:00:00Z
bitCostsByExitCostingstringCustos valorizados por custo de saída.
ex.: False
intProjectLineOriintegernullableLinha do projeto de origem.
ex.: 0
linhasarray<linhaStock>Linhas do movimento de stock.

SCHEMA subzona

Subzona pertencente a uma zona.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 11
strAbreviaturastringAbreviatura.
ex.: LRA
strDescricaostringDescrição.
ex.: Leiria
strAbrevPaisstringPaís.
ex.: PT
strAbrevZonastringAbreviatura da zona.
ex.: CEN

SCHEMA taxasiva

Tabela de taxas de IVA.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 23
intCodigostringCódigo/abreviatura da taxa.
ex.: NOR
strDescricaostringDescrição da taxa.
ex.: IVA Normal
fltTaxastringPercentagem da taxa.
ex.: 23.0
strCodISONorma2stringsó leitura
ex.: PT

SCHEMA tipoartigo

Tipo de artigo (classe).
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strCodigostringCódigo.
ex.: M
strDescricaostringDescrição.
ex.: Mercadoria

SCHEMA tipofamilia

Tipo/nível de família.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strCodigostringCódigo.
ex.: N1
strDescricaostringDescrição.
ex.: Nível 1
intNivelstringNível hierárquico.
ex.: 1

SCHEMA tiposdecontacto

Tipos de contacto (ex. Comercial, Financeiro).
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strCodigostringCódigo do tipo de contacto.
ex.: COM
strDescricaostringDescrição.
ex.: Comercial

SCHEMA tiposDocumentos

tipos de documentos
CampoTipoDescrição
IdstringobrigatórioIdentificador da linha de código de barras.
ex.: 10
strAbreviaturastringAbreviatura.
ex.: ENCWB
strDescricaostringDescrição
ex.: Encomenda Web
strCodArmazemstringnullableArmazem predefinido
ex.: 1
strCodClassMovStkstringnullable só leitura
ex.: 2
intTpEntidadestringsó leitura
ex.: 0

SCHEMA venda

Documento de venda (cabeçalho e, opcionalmente, linhas). O endpoint aceita/devolve ainda outros campos ERP presentes em vendas.php.
156 campos — mostrar
CampoTipoDescrição
IdstringIdentificador interno da venda.
ex.: 101
intNumerostringNúmero interno do documento.
ex.: 245
strAbrevTpDocstringAbreviatura do tipo de documento.
ex.: FAC
strCodSeccaostringCódigo da secção.
ex.: VND
strCodExerciciostringCódigo do exercício.
ex.: 2026
strNumerostringNúmero formatado do documento.
ex.: FAC/2026/00245
strNumExternostringnullableNúmero externo do documento.
ex.: WEB-245
dtmDatastring dateData do documento.
ex.: 2026-03-08
intTpEntidadestringTipo de entidade.
ex.: 1
intCodEntidadestringCódigo da entidade.
ex.: 2001
strAbrevSubZonastringSubzona associada à entidade/documento.
ex.: LRA
strAbrevMoedastringMoeda do documento.
ex.: EUR
intCodVendedorintegernullableVendedor associado.
ex.: 201
strObsstringnullableObservações do documento.
fltTotalstringTotal do documento.
ex.: 123.45
strCodEstadoDocstringnullableEstado do documento.
ex.: ABERTO
linhasarray<object>Linhas da venda.
strCodSeccaostringsó leitura
ex.: 1
strAbrevTpDocstringsó leitura
ex.: FACT
strCodExerciciostringsó leitura
ex.: 2019
intNumerostringsó leitura
ex.: 1
intNumLinhastringsó leitura
ex.: 1
intTpLinhastringsó leitura
ex.: 5
strCodArmazemstringnullable só leitura
strCodLocalizacaostringnullable só leitura
strCodArtigostringsó leitura
ex.: 1
strDescArtigostringsó leitura
ex.: GASÓLEO
strCodLotestringnullable só leitura
intEdicaostringsó leitura
ex.: 0
fltQuantidadestringsó leitura
ex.: 1.000000
fltCustoUnitariostringsó leitura
ex.: 3.000000
fltPrecoUnitariostringsó leitura
ex.: 5.000000
fltCustoTotalstringsó leitura
ex.: 3.000000
intConversaoIdNumstringsó leitura
ex.: 0
intTpMargemstringsó leitura
ex.: 0
fltMargemMinimastringsó leitura
ex.: .000000
strCodClassMovStkstringnullable só leitura
ex.: 2
intTipoAssociacaostringsó leitura
ex.: 0
intLinhaAssociacaostringsó leitura
ex.: 0
intLinhaReferenciastringsó leitura
ex.: 0
strFormulastringnullable só leitura
ex.: 1
fltMedidaQtdstringsó leitura
ex.: .000000
fltMedida1stringsó leitura
ex.: .000000
fltMedida2stringsó leitura
ex.: .000000
fltMedida3stringsó leitura
ex.: .000000
strCodArmazemOristringnullable só leitura
strCodLocalizacaoOristringnullable só leitura
fltDesconto1stringsó leitura
ex.: .000000
fltDesconto2stringsó leitura
ex.: .000000
fltDesconto3stringsó leitura
ex.: .000000
fltDescontoValorUnitstringsó leitura
ex.: .000000
fltDescontoValorstringsó leitura
ex.: .000000
strDocumOrigemstringnullable só leitura
fltValorLiquidostringsó leitura
ex.: 5.000000
intCodTaxaIVAstringsó leitura
ex.: 3
strHorastringsó leitura
ex.: 11:21:34
bitAnuladostringsó leitura
ex.: 0
intDireccaostringsó leitura
ex.: 1
fltDescontoCabstringsó leitura
ex.: .000000
fltDescontoFinstringsó leitura
ex.: .000000
strCodCondPagstringsó leitura
ex.: 3
dtmDataVencimentostringsó leitura
ex.: 2019-11-02 00:00:00
intMercadostringsó leitura
ex.: 0
fltCambiostringsó leitura
ex.: 1.000000000000000000
strMeioExpedicaostringnullable só leitura
ex.: 1
strLocalCargastringnullable só leitura
ex.: Morada do remetente
strLocalDescargastringnullable só leitura
ex.: Morada do destinatário
dtmDataCargastringsó leitura
ex.: 2019-10-03 00:00:00
strHoraCargastringsó leitura
ex.: 11:21
strViaturastringnullable só leitura
strCVDNumContribstringsó leitura
ex.: 504624679
strCVDNomestringsó leitura
ex.: GLORIOUS GYM, SOCIEDADE UNIPESSOAL LDA
strCVDMoradastringsó leitura
ex.: ABC
strCVDCodPostalstringsó leitura
ex.: 1000-000
strCVDTelefonestringnullable só leitura
strCVDLocalidadestringsó leitura
ex.: DEF
strCVDEmailstringnullable só leitura
intTpComissaostringsó leitura
ex.: 0
fltComissaoValorstringsó leitura
ex.: .000000
fltComissaoPercentstringsó leitura
ex.: .000000
fltComissaoPenalizstringsó leitura
ex.: .000000
fltComissaoValorBasestringsó leitura
ex.: .000000
dtmComissaoDataDispstringsó leitura
ex.: 2019-10-03 00:00:00
intTpComissaoDescontosstringsó leitura
ex.: 0
strCodRubricastringnullable só leitura
ex.: VND
fltTotalPagamentosstringsó leitura
ex.: .000000
fltInfTotalArtigosstringsó leitura
ex.: 1.000000
fltInfTotalLinhasstringsó leitura
ex.: 1.000000
fltInfTotalQtdstringsó leitura
ex.: 1.000000
fltTotalMercadoriaSIVAstringsó leitura
ex.: 5.000000
fltTotalMercadoriaCIVAstringsó leitura
ex.: 6.150000
fltTotalDescontosSIVAstringsó leitura
ex.: .000000
fltTotalDescontosCIVAstringsó leitura
ex.: .000000
fltTotalDescontosFinSIVAstringsó leitura
ex.: .000000
fltTotalDescontosFinCIVAstringsó leitura
ex.: .000000
fltTotalOutrosSIVAstringsó leitura
ex.: .000000
fltTotalOutrosCIVAstringsó leitura
ex.: .000000
fltTotalAcertosstringsó leitura
ex.: .000000
fltTotalIECstringsó leitura
ex.: .000000
intIVACodTaxa1stringsó leitura
ex.: 3
intIVACodTaxa2stringsó leitura
ex.: -1
intIVACodTaxa3stringsó leitura
ex.: -1
fltIVATaxa1stringsó leitura
ex.: 23.000000
fltIVATaxa2stringsó leitura
ex.: .000000
fltIVATaxa3stringsó leitura
ex.: .000000
fltIVAIncidencia1stringsó leitura
ex.: 5.000000
fltIVAIncidencia2stringsó leitura
ex.: .000000
fltIVAValor1stringsó leitura
ex.: 1.150000
fltIVAValor2stringsó leitura
ex.: .000000
fltIVAValor3stringsó leitura
ex.: .000000
fltTotalIVAstringsó leitura
ex.: 1.150000
fltValorIVARegPagostringsó leitura
ex.: .000000
fltIncidenciaIVARegPagostringsó leitura
ex.: .000000
fltSubTotalstringsó leitura
ex.: 5.000000
fltIRSTaxastringsó leitura
ex.: .000000
fltIRSIncidenciastringsó leitura
ex.: .000000
fltIRSValorRetidostringsó leitura
ex.: .000000
fltTrocostringsó leitura
ex.: .000000
fltValorPagostringsó leitura
ex.: .000000
fltValorPendentestringsó leitura
ex.: 6.150000
intSinalstringsó leitura
ex.: 1
strAplicacaoOrigemstringsó leitura
ex.: VNDP
strLoginstringsó leitura
ex.: vasco2
dtmDataAberturastringsó leitura
ex.: 2019-10-03 11:21:34.000
dtmDataAlteracaostringsó leitura
ex.: 2019-10-03 11:21:34.000
fltSinalPagoEncomendastringsó leitura
ex.: .000000
intNumeroPessoasstringnullable só leitura
dtmDataEntregastringnullable só leitura
strAbrevMoedaPagTrocostringsó leitura
ex.: EUR
fltCambioPagTrocostringsó leitura
ex.: 1.000000000000000000
fltTrocoMoedaDocstringsó leitura
ex.: .000000
fltDiferencaArredstringsó leitura
ex.: .000000
fltTotalValorValeDescontoSIVAstringsó leitura
ex.: .000000
fltTotalValorValeDescontoCIVAstringsó leitura
ex.: .000000
intNumValeDescontoEmitidostringnullable só leitura
ex.: 0
strFENumEtiquetastringnullable só leitura
fltValorIVAPendentestringsó leitura
ex.: .000000
strDescritivoPagamentostringnullable só leitura
intCodCatEntidadestringnullable só leitura
ex.: 1
strHashstringsó leitura
ex.: JpymIaZM1JKuawJWcRplhRgekEYtcSx2SYsb3YdoSBMtv4rB9JGoVi7fBeVy
intHashControlstringsó leitura
ex.: 1
strCodSecContratostringnullable só leitura
strCodTpContratostringnullable só leitura
strCodExercContratostringnullable só leitura
intNumeroContratostringnullable só leitura
intLinhaPrecostringsó leitura
ex.: 0
strMoradaLin2stringnullable só leitura
dtmDataValidadeContratostringnullable só leitura
intEstadoContratostringsó leitura
ex.: 0
dtmDataEstadostringsó leitura
ex.: 2019-10-03 00:00:00
strObsEstadostringnullable só leitura
intNumProcessamentostringsó leitura
ex.: 0
intCodEstabHotelstringnullable só leitura
intNumQuartoHotelstringnullable só leitura
intLinhaHospedestringnullable só leitura
strMotivoIsencaostringsó leitura

SCHEMA vendedores

Vendedor (registo básico).
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 201
intCodigostringCódigo do vendedor.
ex.: 201
strNomestringNome do vendedor.
ex.: Marta Sousa
strMoradaLin1stringnullable só leitura
strMoradaLin2stringnullable só leitura
strLocalidadestringnullable só leitura
strPostalstringnullable só leitura
strTelefonestringnullable só leitura
strBIstringnullable só leitura
dtmBIstringnullable só leitura
strArqBIstringnullable só leitura
strNumContribstringnullable só leitura
strAbrevSubZonastringnullable só leitura
ex.: PRT

SCHEMA zona

Zona geográfica/comercial.
CampoTipoDescrição
IdstringobrigatórioIdentificador.
ex.: 1
strAbreviaturastringAbreviatura.
ex.: N
strDescricaostringDescrição.
ex.: Norte
strAbrevPaisstringnullableAbreviatura do país.
ex.: PT