Developers
Documents > Delivery Notes > getOne
getOne
Disponível na versão: 1.2+

Devolve os dados da guia de remessa 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.

Dependendo se foi definido um vendedor ou não, a estrutura salesman poderá não existir. De igual modo, o conjunto associated_documents poderá estar vazio.

Dentro de cada elemento de products, o conjunto taxes poderá estar vazio (caso em que o campo exemption_reason do elemento de products correspondente estará forçosamente preenchido).

Pedido

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

Parâmetros
company_id int

Obrigatório

document_id int
customer_id int
salesman_id int
document_set_id int
number int
date int
year int
your_reference 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,
	supplier_id: int,
	salesman_id: int,
	document_set_id: int,
	number: int,
	date: datetime,
	expiration_date: datetime|null,
	year: int,
	your_reference: string,
	our_reference: string,
	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,
	attached_file: string,
	notes: string,
	salesman_commission: float,
	deduction_id: int,
	deduction_percentage: float,
	deduction_name: string,
	special_discount: float,
	financial_discount: float,
	gross_value: float,
	comercial_discount_value: float,
	financial_discount_value: float,
	taxes_value: float,
	deduction_value: float,
	net_value: float,
	reconciled_value: float,
	delivery_method_id: int,
	delivery_method_name: string,
	vehicle_id: int,
	vehicle_name: string,
	vehicle_number_plate: string,
	delivery_datetime: datetime|null,
	delivery_departure_address: string,
	delivery_departure_city: string,
	delivery_departure_zip_code: string,
	delivery_departure_country: int,
	delivery_destination_address: string,
	delivery_destination_city: string,
	delivery_destination_zip_code: string,
	delivery_destination_country: int,
	related_documents_notes: string,
	status: int,
	transport_code: string,
	transport_code_set_by: int,
	rsa_hash: string,
	hash_control: 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
	},
	salesman: {
		salesman_id: int,
		number: string,
		name: string,
		vat: string
	},
	products: [
		{
			ean: string,
			order: int,
			origin_id: int,
			product_id: int,
			category_id: int,
			reference: string,
			name: string,
			summary: string,
			price: float,
			unit_id: int,
			unit_name: string,
			unit_short_name: string,
			discount: float,
			qty: int,
			exemption_reason: string,
			supplier: {
				supplier_id: int,
				number: string,
				name: string,
				vat:string
			},
			taxes: [
				{
					tax_id: int,
					type: int,
					saft_type: int,
					vat_type: string,
					stamp_tax: string,
					name: string,
					value: float,
					fiscal_zone: string,
					order: int,
					cumulative: int,
					incidence_value: float,
					total_value: float
				},
				(...)
			]
		},
		(...)
	],
	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