Create

Criar Série de Documentos

Cria uma nova série de documentos.

As Série de Documentos precisam, desde dia 1 de Janeiro de 2023, ser comunicadas à Autoridade Tributária de modo a lhes serem atribuídos códigos ATCUD. Certifique-se que já obteve as suas credenciais WSE no portal dao Autoridade Tributária e as inseriu no BackOffice CloudInvoice em: Configurações → Autoridade Tributária → Comunicação de Séries ATCUD antes de tentar criar uma Série de Documentos

POST https://api.cloudinvoice.net/series/new/

Request Body

Name	Type	Description
code*	string Valor Único	Código da Série ⚠️ Códigos começados por AT não são permitidos pela Autoridade Tributária.
description*	string	Descrição
document_serie_type_id	integer	Tipo de Série Consulte a tabela Apêndice para saber mais.
initial_date	date Format: yyyy-mm-dd	Data de Início Quando não fornecido, assume a data atual.
expiration_date	date Format: yyyy-mm-dd	Data de Expiração
config_document	list	Lista de Documentos IDs dos Tipos de Documentos para os quais serão criadas numerações na Série. Consulte a tabela Tipos de Documentos para saber mais.
is_cash_vat_scheme	boolean	Regime de IVA de Caixa Série para usar em Documentos ao abrigo do Regime de IVA de Caixa.
is_eu_sales_serie	boolean	Regime de Vendas à Distância Série para usar em Documentos ao abrigo do Regime de Vendas à Distância. ⚠️ A utilização destes séries requer o módulo de Vendas à Distância.
is_oss_serie	boolean	Série OSS (One-Stop-Shop) Série para usar em Documentos ao abrigo do Regime de Vendas à Distância, com OSS. ⚠️ A utilização destes séries requer o módulo de Vendas à Distância.
is_offline_serie	boolean	Série Offline Série para usar em Documentos gerados no módulo offline do POS CloudInvoice. ⚠️ A utilização destes séries requer o módulo Offline.

Exemplo de Pedido

curl -X POST https://api.cloudinvoice.net/series/new/
    -d '{
        "code": "A01",
        "description": "Serie API",
        "config_document": [1, 2, 3]
    }'

Exemplo de Resposta

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.