Moloni API / Endpoints / Documents / Payment Returns / getAll

getAll

Disponível na versão: 1.0+

Devolve as devoluções de pagamento da empresa. Se forem definidas opções de pesquisa, são devolvidos os documentos que as cumpram.

Pedido

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

Parâmetros

company_id int

Obrigatório

qty int

offset int

customer_id int

document_set_id int

number int

date date

year int

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_id: int,
		document_type_id: int,
		document_set_id: int,
		number: int,
		date: datetime,
		entity_number: string,
		entity_name: string,
		entity_vat: string,
		entity_address: string,
		net_value: float,
		status: int,
		transport_code: string,
		transport_code_set_by: int,
		exchange_currency_id: int,
		exchange_total_value: float,
		exchange_rate: float,
		exchange_currency: {
			currency_id: int,
			iso4217: string,
			symbol: string
		},
		document_type: {
			document_type_id: int,
			saft_code: string
		},
		document_set: {
			document_set_id: int,
			name: 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