FactPlus RESTful API Versão 1.0

API Call Alter

O apicall ALTER é usado para alterar o estado dos documentos. A chamada aceita os seguintes documentos: factura, factura-recibo.


Parâmetros por enviar

Parâmetro Subparâmetro Descrição
apicall Metódo de chamada do api {ALTER}
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 4 subparâmetros com as informações do documento a atualizar
document reference Número de referência do documento (ID único do documento)
Formato: {númerico}
document type Tipo do documento a atualizar
Formato: {factura,factura-recibo}
document status Estado para qual quer atualizar o documento
Formato: {Consulte aqui a lista dos estados do documento}
document reason Razão de cancelamento
Formato: {alphanúmerico}
Nota: Valor de parâmetro obrigatório para cancelamentos de documentos

 

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}

 

Regras

Regras para alterar o estado dos documento

Regras de alteração

FACTURA
  • rascunho -> final
  • final -> cancelada

FACTURA-RECIBO
  • rascunho -> paga
  • paga -> cancelada

 

Formatos

Formatos de estado dos documentos usados pela API

Estado dos documentos

Estado Formato
Rascunhodraft
Finalsent
Pagosettled
Canceladocanceled
Aceiteaccepted
Recusadorefused

 

Exemplo (JSON NATIVO)

Este exemplo mostra como alterar o estado de um documento



{
  "apicall":"ALTER",
  "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "document": {
    "reference": "1589910249",
    "type": "factura",
    "status": "sent",
    "reason":""
  }
}