Create
Cria uma nova série de documentos.
Criar 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
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
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.
curl -X POST https://api.cloudinvoice.net/series/new/
-d '{
"code": "A01",
"description": "Serie API",
"config_document": [1, 2, 3]
}'{
"id": 3,
"code": "A01",
"description": "Serie API",
"document_serie_type_id": 901,
"document_serie_type": {
"code": "P",
"description": "Documentos Produzidos na Aplicação"
},
"is_at_cud_serie": true,
"initial_date": "2026-05-19 10:46:38",
"expiration_date": null,
"is_closed": false,
"closed_user_id": null,
"closed_date": null,
"closed_reason": "",
"location_id": 1,
"location": {
"code": 1,
"description": "Localização 1"
},
"is_cash_vat_scheme": false
}Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.
Last updated