Moloni API / Endpoints / Settings / Document Sets / getAll

getAll

Disponível na versão: 1.0+

Devolve um array com todas as séries disponíveis.

Algumas notas importantes
- Neste método getAll, a informação do template pode não existir, se a série não estiver associada com um modelo de identificação.
- Ao atualizar uma série, se a marcar como ativo por padrão, qualquer outra série definida na mesma empresa como ativa por padrão será desmarcada.
- Você só pode excluir as séries que não estejam em uso por nenhum documento.
- Se tentar eliminar uma série que já esteja em uso por algum documento, vai ser devolvida uma resposta inválida ({valid: 0}).

Pedido

https://api.moloni.pt/v1/documentSets/getAll/?access_token=[current_access_token]

Parâmetros

company_id int

Obrigatório

Nota
- O parâmetro qty tem como default 50 e o offset 0, sendo que o máximo qty é 50;
- Campos de preenchimento facultativo, significa que podem ser uma string vazia ou zero, dependendo do respectivo tipo.

Resposta

[
	{
		document_set_id: int,
		name: string,
		cash_vat_scheme_indicator: int,
		active_by_default: int,
		template_id: int,
		img_gr_1: string,
		template:
		{
			template_id: int,
			name: string,
			business_name: string,
			email: string,
			address: string,
			city: string,
			zip_code: string,
			country_id: int,
			phone: string,
			fax: string,
			website: string,
			notes: string,
			documents_footnote: string,
			email_sender_name: string,
			email_sender_address: string,
			image: string
		}
	}, (...)
]

Lista de erros possíveis

Sempre que existir um erro no preenchimento dos campos, será devolvido via JSON o objeto com os erros indexado pela ordem dos campos.
As mensagens de erro, são devolvidas sob a forma de códigos, e para perceber quais os erros disponíveis e como interpretar as mensagens recebidas, consulte esta ligação.

Software de faturação online

Certificado pela Autoridade Tributária N.º 2860