TOConline - Documentação API
  • Introdução
  • Setup do Postman
  • Autenticação Simplificada
  • Autenticação Detalhada
  • Características dos pedidos
  • APIs
    • Empresa
      • Clientes, Morada e E-mail
      • Fornecedores, Morada e E-mail
      • Produtos e Serviços
    • Vendas
      • Documentos de Venda
      • Documentos Retificativos
      • Recibos de Venda
      • Descarregar PDF de Documentos de Venda
      • Descarregar PDF de Recibo
      • Comunicação de documentos à AT
      • Envio de Documentos por email
      • Envio de Recibos por email
    • Compras
      • Documentos de Compra
      • Pagamentos
      • Descarregar PDF de Documentos de Compra
      • Descarregar PDF de Pagamentos
      • Comunicação de documentos à AT
    • Versões Anteriores
      • Vendas
        • Documentos de Venda
        • Recibos de Venda
      • Compras
        • Documentos de Compra
        • Pagamentos
    • APIs Auxiliares
      • Descritores de Taxa
      • Família de Itens
      • Países
      • Unidades de Medida
      • Contas Bancárias
      • Caixa Associada
      • Unidade Monetária
      • Taxas
      • Categorias de Despesa
      • Documentos de Série
Powered by GitBook
On this page
  1. APIs
  2. APIs Auxiliares

Taxas

APIs de taxas fornecem dados de impostos para integrar em sistemas, facilitando cálculos e conformidade legal.

PreviousUnidade MonetáriaNextCategorias de Despesa

Last updated 1 year ago

Obter Todas as Taxas

Filtro por Código de Taxa e pelo Código da Região

Endpoint
GET /taxes?filter[tax_code]=<código de Taxa> &filter[tax_country_region]=<código da região> 

Exemplo:

Exemplo de Endpoint
GET /api/taxes?filter[tax_code]=NOR&filter[tax_country_region]=BE
Exemplo de Response
{
    "data": [
        {
            "type": "taxes",
            "id": "103",
            "attributes": {
                "tax_country_region": "BE",
                "tax_code": "NOR",
                "description": "Normal",
                "tax_percentage": "21",
                "tax_expiration_date": null,
                "vat_tax_id": null
            }
        }
    ]
}

Filtro por Código de Taxa e pela Região e Percentagem de Taxa

Endpoint
GET /taxes?filter[tax_code]=<código de Taxa> &filter[tax_country_region]=<a região do IVA>&filter[tax_percentage]=<a percentagem de taxa>

Exemplo:

Exemplo de Endpoint
{{base_url}}/api/taxes?filter[tax_code]=NOR&filter[tax_country_region]=BE&filter[tax_percentage]=21
Exemplo de Response
{
    "data": [
        {
            "type": "taxes",
            "id": "103",
            "attributes": {
                "tax_country_region": "BE",
                "tax_code": "NOR",
                "description": "Normal",
                "tax_percentage": "21",
                "tax_expiration_date": null,
                "vat_tax_id": null
            }
        }
    ]
}

Obter Todas as Taxas de OSS (One Stop Shop)

Obter Todas as Taxas

get

Obter Todas as Taxas

Authorizations
Query parameters
filter[tax_country_region]stringOptionalExample: BE
filter[tax_code]stringOptionalExample: NOR
filter[tax_percentage]stringOptionalExample: 21
Responses
200
/ Sucesso / Sucesso
get
GET /api/taxes HTTP/1.1
Host: {{base_url}}
Accept: */*
200

/ Sucesso / Sucesso

No content

Obter Todas as Taxas de OSS

get

Obter Todas as Taxas de OSS

Authorizations
Responses
200
Sucesso
application/json
get
GET /api/oss_taxes HTTP/1.1
Host: {{base_url}}
Accept: */*
200

Sucesso

{
  "data": [
    {
      "attributes": {
        "code": "AT",
        "country_name": "Áustria",
        "int": [
          "13#1"
        ],
        "nor": [
          "20#1"
        ],
        "red": [
          "10#1"
        ],
        "tax_country_region": "AT"
      },
      "id": "AT",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "BE",
        "country_name": "Bélgica",
        "int": [
          "12#1"
        ],
        "nor": [
          "21#1"
        ],
        "red": [
          "6#1"
        ],
        "tax_country_region": "BE"
      },
      "id": "BE",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "BG",
        "country_name": "Bulgária",
        "int": [
          "9#1"
        ],
        "nor": [
          "20#1"
        ],
        "red": [],
        "tax_country_region": "BG"
      },
      "id": "BG",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "CY",
        "country_name": "Chipre",
        "int": [
          "9#1"
        ],
        "nor": [
          "19#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "CY"
      },
      "id": "CY",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "CZ",
        "country_name": "República Checa",
        "int": [
          "15#1"
        ],
        "nor": [
          "21#1"
        ],
        "red": [
          "10#1"
        ],
        "tax_country_region": "CZ"
      },
      "id": "CZ",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "DE",
        "country_name": "Alemanha",
        "int": [],
        "nor": [
          "19#1"
        ],
        "red": [
          "7#1"
        ],
        "tax_country_region": "DE"
      },
      "id": "DE",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "DK",
        "country_name": "Dinamarca",
        "int": [],
        "nor": [
          "25#1"
        ],
        "red": [],
        "tax_country_region": "DK"
      },
      "id": "DK",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "EE",
        "country_name": "Estónia",
        "int": [],
        "nor": [
          "20#1"
        ],
        "red": [
          "9#1"
        ],
        "tax_country_region": "EE"
      },
      "id": "EE",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "EL",
        "country_name": "Grécia",
        "int": [
          "13#1"
        ],
        "nor": [
          "24#1"
        ],
        "red": [
          "6#1"
        ],
        "tax_country_region": "EL"
      },
      "id": "EL",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "ES",
        "country_name": "Espanha",
        "int": [
          "10#1"
        ],
        "nor": [
          "21#1"
        ],
        "red": [
          "4#1"
        ],
        "tax_country_region": "ES"
      },
      "id": "ES",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "FI",
        "country_name": "Finlândia",
        "int": [
          "14#1"
        ],
        "nor": [
          "24#1"
        ],
        "red": [
          "10#1"
        ],
        "tax_country_region": "FI"
      },
      "id": "FI",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "FR",
        "country_name": "França",
        "int": [
          "5.5#1",
          "10#2"
        ],
        "nor": [
          "20#1"
        ],
        "red": [
          "2.1#1"
        ],
        "tax_country_region": "FR"
      },
      "id": "FR",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "HR",
        "country_name": "Croácia",
        "int": [
          "13#1"
        ],
        "nor": [
          "25#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "HR"
      },
      "id": "HR",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "HU",
        "country_name": "Hungria",
        "int": [
          "18#1"
        ],
        "nor": [
          "27#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "HU"
      },
      "id": "HU",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "IE",
        "country_name": "Irlanda",
        "int": [
          "9#1",
          "13.5#2"
        ],
        "nor": [
          "23#1"
        ],
        "red": [
          "4.8#1"
        ],
        "tax_country_region": "IE"
      },
      "id": "IE",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "IT",
        "country_name": "Itália",
        "int": [
          "5#1",
          "10#2"
        ],
        "nor": [
          "22#1"
        ],
        "red": [
          "4#1"
        ],
        "tax_country_region": "IT"
      },
      "id": "IT",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "LT",
        "country_name": "Lituânia",
        "int": [
          "9#1"
        ],
        "nor": [
          "21#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "LT"
      },
      "id": "LT",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "LU",
        "country_name": "Luxemburgo",
        "int": [
          "7#1",
          "13#2"
        ],
        "nor": [
          "16#1"
        ],
        "red": [
          "3#1"
        ],
        "tax_country_region": "LU"
      },
      "id": "LU",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "LV",
        "country_name": "Letónia",
        "int": [
          "12#1"
        ],
        "nor": [
          "21#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "LV"
      },
      "id": "LV",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "MC",
        "country_name": "Mónaco",
        "int": [
          "5.5#1",
          "10#2"
        ],
        "nor": [
          "20#1"
        ],
        "red": [],
        "tax_country_region": "MC"
      },
      "id": "MC",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "MT",
        "country_name": "Malta",
        "int": [
          "7#1"
        ],
        "nor": [
          "18#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "MT"
      },
      "id": "MT",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "NL",
        "country_name": "Países Baixos",
        "int": [],
        "nor": [
          "21#1"
        ],
        "red": [
          "9#1"
        ],
        "tax_country_region": "NL"
      },
      "id": "NL",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "PL",
        "country_name": "Polónia",
        "int": [
          "8#1"
        ],
        "nor": [
          "23#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "PL"
      },
      "id": "PL",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "PT",
        "country_name": "Portugal",
        "int": [
          "13#1"
        ],
        "nor": [
          "23#1"
        ],
        "red": [
          "6#1"
        ],
        "tax_country_region": "PT"
      },
      "id": "PT",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "PT-AC",
        "country_name": "Portugal - Açores",
        "int": [
          "9#1"
        ],
        "nor": [
          "16#1"
        ],
        "red": [
          "4#1"
        ],
        "tax_country_region": "PT-AC"
      },
      "id": "PT-AC",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "PT-MA",
        "country_name": "Portugal - Madeira",
        "int": [
          "12#1"
        ],
        "nor": [
          "22#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "PT-MA"
      },
      "id": "PT-MA",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "RO",
        "country_name": "Roménia",
        "int": [
          "9#1"
        ],
        "nor": [
          "19#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "RO"
      },
      "id": "RO",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "SE",
        "country_name": "Suécia",
        "int": [
          "12#1"
        ],
        "nor": [
          "25#1"
        ],
        "red": [
          "6#1"
        ],
        "tax_country_region": "SE"
      },
      "id": "SE",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "SI",
        "country_name": "Eslovénia",
        "int": [
          "9.5#1"
        ],
        "nor": [
          "22#1"
        ],
        "red": [
          "5#1"
        ],
        "tax_country_region": "SI"
      },
      "id": "SI",
      "type": "oss_taxes"
    },
    {
      "attributes": {
        "code": "SK",
        "country_name": "Eslováquia",
        "int": [
          "10#1"
        ],
        "nor": [
          "20#1"
        ],
        "red": [],
        "tax_country_region": "SK"
      },
      "id": "SK",
      "type": "oss_taxes"
    }
  ]
}
  • Obter Todas as Taxas
  • GETObter Todas as Taxas
  • Filtro por Código de Taxa e pelo Código da Região
  • Filtro por Código de Taxa e pela Região e Percentagem de Taxa
  • Obter Todas as Taxas de OSS (One Stop Shop)
  • GETObter Todas as Taxas de OSS