Geração de link para download da fatura de serviços em pdf

De RBX ISP - Manual do Usuário
Revisão de 09h25min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é gerar um link para download de uma fatura de serviços em pdf. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> {...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é gerar um link para download de uma fatura de serviços em pdf. Abaixo, segue exemplo do json de envio:

{
  "get_service_invoice":
  {
    "service_invoice_id": 1052,
    "document_id": null
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 get_service_invoice Sim Raiz -  
A02 service_invoice_id Sim* A01 Número

Código interno da fatura de serviços. Ao informar este campo, o campo document_id não deve ser informado.

A03 document_id Sim* A01 Número

Código interno do documento financeiro vinculado à fatura de serviços. Ao informar este campo, o campo service_invoice_id não deve ser informado.

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": 
  {
    "service_invoice_link": "https://meurbx.com/routerbox/tmp/fatura_xxxxxxx.pdf",
    "service_invoice_available": 15
  }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 19,
  "error_description": "Unknown error!",
  "result": ""
}