FactPlus RESTful API Versão 1.0

API Call Send

O apicall SEND é usado para enviar um documento por email. A chamada aceita o(s) seguintes documento(s): factura,factura-recibo


Parâmetros por enviar

Parâmetro Subparâmetro Descrição
apicall Metódo de chamada do api {SEND}
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 o qual deseja enviar, deve conter 2 subparâmetros com as informações do documento
document reference Número de referência do documento
Formato: {númerico}
document type Tipo do documento
Formato: {factura,factura-recibo}
recipient Parâmetro que contem informações do recipiente a qual quer enviar o documento. Deve conter 4 subparâmetros com as informações por enviar
recipient address Endereço de email do recipiente
Formato: {alphanúmerico}
Validação: Formato de email deve ser válido
recipient subject Título do cabeçalho do email por enviar
Formato: {alphanúmerico}
recipient message Mensagem do corpo de email por enviar
Formato: {alphanúmerico}
recipient copy Enviar uma cópia do email para o utilizador
Formato: '1' para enviar, '0' para não enviar

 

Parâmetros por receber

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
Formato: {boolean:true}

 

Exemplo (JSON NATIVO)

Este exemplo mostra como enviar um documento por email via a API



{
  "apicall":"SEND",
  "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "document": {
    "reference": "1595589191",
    "type": "factura"
  },
  "recipient": {
    "address": "operations@seafoodconsultants.com",
    "subject": "Pagamento da Factura FT2020/1",
    "message": "caríssimo(s), Em anexo a factura por pagar, Regards",
    "copy": "0"
  }
}