Developers
Documents > Payment Returns > getOne
getOne
Disponível na versão: 1.0+

Devolve os dados da devolução de pagamento pedida, respeitando os parâmetros de pesquisa. No caso dos parâmetros de pesquisa corresponderem a mais do que um documento, apenas o primeiro a ser encontrado será devolvido.

Pedido

https://api.moloni.com/v1/paymentReturns/getOne/?access_token=[current_access_token]

Parâmetros
company_id int

Obrigatório

document_id int
customer_id int
document_set_id int
number int
date int
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.
{
	document_id: int,
	company_id: int,
	document_type_id: int,
	customer_id: int,
	document_set_id: int,
	number: int,
	date: datetime,
	year: int,
	entity_number: string,
	entity_name: string,
	entity_vat: string,
	entity_address: string,
	entity_city: string,
	entity_zip_code: string,
	entity_country: string,
	alternate_address_id: int,
	notes: string,
	net_value: float,
	status: 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
	},
	associated_documents: [
		{
			associated_id: int,
			value: float
		},
		(...)
	],
	payments: [
		{
			payment_method_id: int,
			payment_method_name: string,
			date: datetime,
			value: float,
			notes: string
		},
		(...)
	]
}
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.
© 2017 Moloni. Termos de Utilização