Introdução
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Clientes - Contas em aberto
Artigos
Artigos - Stock
Artigos - Movimentos stock
Agenda - Marcações
Agenda - Indisponibilidades
Administração
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Modos de expedição
Administração - Moedas
Administração - Preços
Administração - Séries
Administração - Taxas de IVA
Administração - Tipos de documento
Administração - Veículos
Administração - Unidades
Subscrição - Locais
Administração - Séries - Criar
—
description
string
required
Descrição
valid_until
integer
required
Válido até. Preencher apenas com o ano.
assign_to_all
boolean
Determina se deve atribuir de imediato a série a todos os tipos de documento
assign_as_default
boolean
Determina se deve colocar a série como pré-definida
communicate
boolean
Determina se deve comunicar a série à AT. Necessário que a configuração do utilizador de acesso aos serviços AT esteja correctamente configurado.
communicate_documents_types
json array
Determina quais os tipos de documentos a comunicar à AT com a respectiva série. Só necessário preencher caso o parâmetro communicate seja true.
active
boolean
Estado
Request POST /administration/series/create
{
"description": ..
"valid_until": ..
"assign_to_all": ..
"assign_as_default": ..
"active": ..
}Response 200
{
"status": true,
"data":
{
"id": ..
"description": ..
"valid_until": ..
"type": ..
"active": ..
"updated_at": ..
"created_at": ..
}
}
Possíveis erros
- Não preencheu todos os campos obrigatórios
- Não tem permissões para executar esta operação
- É obrigatória a indicação de um valor para o campo X
- O valor indicado para o campo descrição já se encontra registado
- A descrição da série é inválida. Não são permitidos: acentos, espaços, caracteres especiais (excepto: . _ -)