Plantonizei

Painel da empresa › Antecipações

Recebíveis da antecipação

GET/api/v1/advances/{id}/receivablesPede sessão

Como funciona

Os recebíveis que entraram num pedido de antecipação: valor, vencimento, situação, escala, especialidade e a data do plantão. Recebível lançado à mão, sem plantão, vem com o período vazio.

Pede a permissão de ver antecipações.

Parâmetros

  • idCaminho · string · obrigatórioIdentificador do registro, como vem na listagem.

Respostas

200 · receivables: os recebíveis do pedido; doctor: quem pediu e para onde vai o dinheiro.

  • receivablesobject[] · Os recebíveis.
  • receivables[].amountCentsinteger · Valor, em centavos.
  • receivables[].dueDatestring · Vencimento (AAAA-MM-DD).
  • receivables[].idstring · Identificador do registro.
  • receivables[].periodstring · Data do plantão (DD/MM/AAAA); vazia para recebível lançado à mão.
  • receivables[].scalestring · Escala.
  • receivables[].specialtystring · Especialidade.
  • receivables[].statusstring · Situação.
  • doctorobject · Quem pediu, com os dados de pagamento (que a listagem não traz).
  • doctor.cpfstring
  • doctor.emailstring
  • doctor.specialtystring
  • doctor.bondTypestring
  • doctor.shiftTypestring
  • doctor.bankstring · Banco.
  • doctor.agencystring · Agência.
  • doctor.accountstring · Conta.
  • doctor.pixstring · Chave PIX.

Corpo de exemplo

{
  "receivables": [
    {
      "amountCents": 150000,
      "dueDate": "texto",
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "period": "texto",
      "scale": "texto",
      "specialty": "texto",
      "status": "texto"
    }
  ],
  "doctor": {
    "cpf": "texto",
    "email": "medico@exemplo.com.br",
    "specialty": "texto",
    "bondType": "texto",
    "shiftType": "texto",
    "bank": "texto",
    "agency": "texto",
    "account": "texto",
    "pix": "texto"
  }
}