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

Documentos de Série

PreviousCategorias de Despesa

Last updated 1 year ago

Obter Todos os Documentos de Série

Obter Documentos de Série com Filtro

GET
{{base_url}}/api/commercial_document_series?filter[document_type]=FT&filter[prefix]=2023&filter[number]=3

Obter Documentos de Série com filtro

get

Obter Documentos de Série com filtro

Authorizations
Query parameters
filter[document_type]stringOptionalExample: FT
filter[prefix]stringOptionalExample: 2023
filter[number]stringOptionalExample: 13
Responses
200
Sucesso
application/json
get
GET /api/commercial_document_series HTTP/1.1
Host: {{base_url}}
Accept: */*
200

Sucesso

{
  "data": [
    {
      "attributes": {
        "active": true,
        "activity_code": null,
        "address_id": null,
        "allow_mb_reference": false,
        "at_status": "active",
        "at_status_date": null,
        "at_type": "normal",
        "atcud_prefix": "THIS_IS_FAKE",
        "bank_account_id": null,
        "broker_edi": null,
        "cashed_vat": false,
        "communication_date": null,
        "company_id": 800000046,
        "copies": 1,
        "created_at": "2023-04-27 11:26:40.38374",
        "data": {},
        "description": null,
        "direct_debit": false,
        "document_series_id": null,
        "document_theme_id": null,
        "document_type": "FT",
        "electronic_invoice": false,
        "external_registration": false,
        "hidden": false,
        "is_default": false,
        "is_edi": false,
        "manual_registration": false,
        "number": 13,
        "observations": null,
        "oss_country_id": null,
        "oss_tax_defaults": [],
        "prefix": "2023",
        "render_banks_data": false,
        "render_banks_data_fr": false,
        "updated_at": "2024-03-04 16:51:35.941381",
        "vat_included_prices": false
      },
      "id": "72",
      "relationships": {
        "company": {
          "data": {
            "id": "800000046",
            "type": "current_company"
          }
        }
      },
      "type": "commercial_document_series"
    }
  ]
}
  • Obter Todos os Documentos de Série
  • GETObter Documentos de Série com filtro
  • Obter Documentos de Série com Filtro