API Call View

O apicall VIEW faz a busca ou GET de documentos, seja único ou vários. Para buscar um documento deve adicionar o número de referência (ID único do documento), para buscar vários documentos deve deixar em branco o número de referência. A chamada aceita os seguintes documentos: factura, factura-recibo, proforma e recibo.

Parâmetros por enviar

Parâmetro	Subparâmetro	Descrição
apicall		Metódo de chamada do api {VIEW}
apikey		Chave API de cada utilizador do software, em formato de 32 digítos.
document		Parâmetro que contem informações principais sobre o documento, deve conter 2 subparâmetros com as informações do documento a visualizar
document	reference	Número de referência do documento (ID único do documento) Formato: {númerico} Nota: Para visualizar vários documentos não deve atribuir valor ao subparâmetro 'reference', para buscar um (1) único documento deve atribuir o seu valor de referência
document	type	Tipo de documento a visualizar Formato: {factura,factura-recibo,proforma ou recibo}

Parâmetros por receber (MÚLTIPLOS DOCUMENTOS {factura,factura-recibo,proforma})

Parâmetro	Subparâmetro	Descrição
result		Resultado da operação Formato: {success,failure}
message		Mensagem retornada pela API
data		Parâmetro retornado pela API apenas quando a operação foi realizada com successo Nota: Ao fazer a busca de vários documentos o parâmetro 'data' retorna um 'array' com 9 subparâmetros
data	document	Retorna o tipo de documento requisitado
data	reference	Número de referência do documento, ID único de cada documento
data	status	Estado do documento Formato: {Consulte aqui a lista dos estados do documento }
data	number	Número do documento
data	client	Nome do cliente atríbuido ao documento
data	date	Data atríbuida ao documento
data	duedate	Data de vencimento do documento
data	archived	Estado da arquivação do documento, '0' Não arquivado, '1' Arquivado
data	total	Somatório total do valor do documento

Parâmetros por receber (MULTIPLOS DOCUMENTOS {recibo})

Parâmetro	Subparâmetro	Descrição
result		Resultado da operação Formato: {success,failure}
message		Mensagem retornada pela API
data		Parâmetro retornado pela API apenas quando a operação foi realizada com successo Nota: Ao fazer a busca de vários documentos o parâmetro 'data' retorna um 'array' com 9 subparâmetros
data	document	Retorna o tipo de documento requisitado
data	receipt_reference	Número de referência do documento, ID único do recibo
data	invoice_reference	Número de referência da factura a qual pertence o recibo, ID único da factura
data	status	Estado do documento Formato: {Consulte aqui a lista dos estados do documento
data	number	Número do documento
data	client	Nome do cliente atríbuido ao documento
data	date	Data atríbuida ao documento
data	duedate	Data de vencimento do documento
data	archived	Estado da arquivação do documento, '0' Não arquivado, '1' Arquivado
data	total	Somatório total do valor do documento

Parâmetros por receber (UM (1) ÚNICO DOCUMENTO {factura,factura-recibo,proforma})

Parâmetro	Subparâmetro	Subparâmetro	Descrição
result			Resultado da operação Formato: {success,failure}
message			Mensagem retornada pela API
data			Parâmetro retornado pela API apenas quando a operação foi realizada com successo Nota: Ao fazer a busca de um (1) único documento o parâmetro 'data' retorna 4 subparâmetros com seus respectivos valores
data	document Nota: O parâmetro 'data->document' retorna dados principais do documento contendo 16 parâmetros
data	document	type	Retorna o tipo de documento
data	document	reference	Retorna o número de referência do documento (ID único do documento)
data	document	status	Retorna o estado do documento
data	document	number	Retorna o número do documento
data	document	serie	Retorna o número de serie do documento
data	document	date	Retorna a data atribuida ao documento
data	document	duedate	Retorna a data de vencimento do documento
data	document	vref	Retorna o valor de referência do documento
data	document	currency	Retorna a moeda câmbial do documento
data	document	exchange_rate	Retorna o valor do câmbio atribuido ao documento
data	document	observation	Retorna observações atruibuida ao documento
data	document	retention	Retorna o valor de retenção do documento
data	document	archived	Retorna o estado da arquivação do documento, '0' Nao arquivado, '1' Arquivado
data	document	cancel_reason	Retorna a razão de cancelamento, para documentos cancelados
data	document	exemption_reason	Retorna o motivo de isenção de taxa/iva
data	document	createdat	Retorna a data de criação do documento gerida pela aplicação
data	client Nota: O parâmetro 'data->client' retorna dados do cliente atribuido ao documento contendo 6 parâmetros
data	client	name	Retorna o nome do cliente
data	client	nif	Retorna o NIF do cliente
data	client	email	Retorna o email do cliente
data	client	telephone	Retorna o número de telefone do cliente
data	client	address	Retorna o endereço fisíco do cliente
data	client	city	Retorna o endereço da cidade do cliente
data	items Nota: O parâmetro 'data->items' retorna dados dos items atribuido ao documento, contendo um 'array' de items com 7 parâmetros
data	items	itemcode	Retorna o código do item
data	items	description	Retorna a descrição do item
data	items	price	Retorna o valor do preço do item
data	items	quantity	Retorna o valor da quantidade atribuida ao item
data	items	tax	Retorna o valor da taxa/iva do item
data	items	discount	Retorna o valor do desconto do item
data	items	exemption_code	Retorna o código do motivo de isenção de taxa/iva
data	summary Nota: O parâmetro 'data->summary' retorna dados somatórios do valor total do documento, contendo 6 parâmetros
data	sumary	sum	Retorna o valor somatório do documento
data	sumary	discount	Retorna o valor somatório de descontos do documento
data	sumary	retention	Retorna o valor somatório de retenção do documento
data	sumary	stax	Retorna o valor somatório de items excluindo a taxa/iva do documento
data	sumary	wtax	Retorna o valor somatório de items incluindo a taxa/iva do documento
data	sumary	total	Retorna o valor somatório final e total do documento

Parâmetros por receber (UM (1) ÚNICO DOCUMENTO {recibo})

Parâmetro	Subparâmetro	Subparâmetro	Descrição
result			Resultado da operação Formato: {success,failure}
message			Mensagem retornada pela API
data			Parâmetro retornado pela API apenas quando a operação foi realizada com successo Nota: Ao fazer a busca de um (1) único documento o parâmetro 'data' retorna 2 subparâmetros com seus respectivos valores
data	document Nota: O parâmetro 'data->document' retorna dados principais do documento contendo 17 parâmetros
data	document	type	Retorna o tipo de documento
data	document	reference	Retorna o número de referência do documento (ID único do recibo)
data	document	invoice_number	Retorna o número da factura atribuida ao recibo
data	document	receipt_number	Retorna o número do recibo
data	document	status	Retorna o estado do documento
data	document	serie	Retorna o número de série do documento
data	document	date	Retorna a data atribuida ao documento
data	document	duedate	Retorna a data de vencimento do documento
data	document	vref	Retorna o valor de referência do documento
data	document	currency	Retorna a moeda câmbial do documento
data	document	exchange_rate	Retorna o valor do câmbio atribuido ao documento
data	document	invoice_amount	Retorna o valor somatório da factura atribuida ao recibo
data	document	receipt_payment_amount	Retorna o valor somatório do recibo
data	document	receipt_payment_method	Retorna a descrição do metodo de pagamento
data	document	observation	Retorna observações atruibuida ao documento
data	document	cancel_reason	Retorna a razão de cancelamento, para documentos cancelados
data	document	createdat	Retorna a data de criação do documento gerida pela aplicação
data	client Nota: O parâmetro 'data->client' retorna dados do cliente atribuido ao documento contendo 6 parâmetros
data	client	name	Retorna o nome do cliente
data	client	nif	Retorna o NIF do cliente
data	client	email	Retorna o email do cliente
data	client	telephone	Retorna o número de telefone do cliente
data	client	address	Retorna o endereço fisíco do cliente
data	client	city	Retorna o endereço da cidade do cliente

Formatos

Formatos de estado dos documentos usados pela API

Estado dos documentos

Estado	Formato
Rascunho	draft
Final	sent
Pago	settled
Cancelado	canceled
Aceite	accepted
Recusado	refused

Exemplo (JSON NATIVO)

Este exemplo mostra como buscar vários documentos



{
"apicall":"VIEW",
"apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"document": {
  "reference": "",
  "type": "factura"
}
}

Este exemplo mostra como buscar um (1) único documento



{
  "apicall":"VIEW",
  "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "document": {
    "reference": "1595589191",
    "type": "factura"
  }
}

FactPlus RESTful API Versão 1.0