O apicall RECEIPT é usado para criar recibos. A chamada aceita o(s) seguintes documento(s): recibo.
| Parâmetro | Subparâmetro | Descrição |
|---|---|---|
| apicall | Metódo de chamada do api {RECEIPT} | |
| 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 a qual o recibo será atribuido, deve conter 2 subparâmetros com as informações do documento | |
| document | reference | Número de referência do documento a qual quer atribuir o recibo (ID único do documento)Formato: {númerico} |
| document | type | Tipo do documentoFormato: {factura} Nota: O documento a atribuir o recibo deve estar no seu estado final |
| payment | Parâmetro que contem informações principais sobre o recibo a criar. Deve conter 5 subparâmetros com as informações do recibo a criar | |
| payment | amount | Valor total do recibo Formato: {númerico} Validação: O valor total do recibo não pode ser superior ao valor pendente do documento {factura}, Valor total do recibo não pode ser igual a zero (0), Formato de valor decimal não deve conter virgula, apenas ponto (.) |
| payment | date | Data do reciboFormato: {yyyy-mm-dd} Validação: Data do recibo não pode ser inferior a data do documento {factura} a atribuir ou superior a data actual |
| payment | serie | Número de série do documento Formato: {alphanúmerico} Validação: O número de série deve ser o valor do ano corrente ou estar pré-definido nas configurações do utilizador. |
| payment | pm | Meio de pagamentoFormato: {Consulte aqui a lista de formato de meios de pagamento} |
| payment | observation | Observações relacionadas ao documento Formato: {alphanúmerico} Nota: Valor de parâmetro não é obrigatório |
| 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} |
Formatos de meios de pagamento usados pela API
| Meio de pagamento | Formato |
|---|---|
| Transferência bancária ou débito direto autorizado | TB |
| Cartão de crédito | CC |
| Cartão de débito | CB |
| Cheque bancário | CH |
| Cheque ou cartão oferta | CO |
| Compensação de saldos de conta corrente | CS |
| Dinheiro electrónico | DE |
| Letra comercial | LC |
| Numerário | NU |
| Permuta de bens | PR |
| Crédito documentário internacional | CI |
| Outros meios aqui não assinalados | OU |
Este exemplo mostra como criar um recibo
{
"apicall":"RECEIPT",
"apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"document": {
"reference": "1596973009",
"type": "factura"
},
"payment":{
"amount": "120000.00",
"date":"2020-01-01",
"serie": "2020",
"pm": "NU",
"observation": "pagamento concluído."
}
}