Relatório financeiro

GET http://escala.med.br/api/v2/partner/payments/shifts

Informações dos plantões com valores a serem pagos

Parâmetros

Nome	Tipo	Descrição
start*	string	Data inicial do período buscado, no formato yyyy-MM-dd
end*	string	Data final do período buscado no formato yyyy-MM-dd
hour_source*	string	Indica em qual saldo de horas é baseado o cálculo do valor, pode ser worked, planned ou checkin, indicando, respectivamente, horas trabalhadas, horas planejadas ou horas em que foram realizadas check-in
payment_model*	string	Filtro de plantões por tipo de pagamento, pode ser BY_HOUR ou BY_SHIFT, indicando, respectivamente, plantões pagos por hora e por plantão
offset	string	Parâmetro para paginação. A lista será retornada a partir do valor determinado por esse parâmetro
limit	string	Parâmetro para paginação. Número de plantões buscados, máximo é 100. Se esse parâmetro não for passado, o padrão será 100. O atributo da resposta next_page_url indica a próxima página
tag	string	Tag a ser buscada de acordo com o parâmetro tags_source
tags_source	string	Indica qual entidade no Escala serve como referência para a busca por tags, pode ser schedule, team, employee ou shift. Indicando, respecitvamente, escala, equipe, profissional ou plantão.

Nome

Tipo

Descrição

start*

string

Data inicial do período buscado, no formato yyyy-MM-dd

end*

string

Data final do período buscado no formato yyyy-MM-dd

hour_source*

string

Indica em qual saldo de horas é baseado o cálculo do valor, pode ser worked, planned ou checkin, indicando, respectivamente, horas trabalhadas, horas planejadas ou horas em que foram realizadas check-in

payment_model*

string

Filtro de plantões por tipo de pagamento, pode ser BY_HOUR ou BY_SHIFT, indicando, respectivamente, plantões pagos por hora e por plantão

offset

string

Parâmetro para paginação. A lista será retornada a partir do valor determinado por esse parâmetro

limit

string

Parâmetro para paginação. Número de plantões buscados, máximo é 100. Se esse parâmetro não for passado, o padrão será 100. O atributo da resposta next_page_url indica a próxima página

tag

string

Tag a ser buscada de acordo com o parâmetro tags_source

tags_source

string

Indica qual entidade no Escala serve como referência para a busca por tags, pode ser schedule, team, employee ou shift. Indicando, respecitvamente, escala, equipe, profissional ou plantão.

Headers

Name	Type	Description
Authentication	string	Autenticação feita via Bearer <token>

Name

Type

Description

Authentication

string

Autenticação feita via Bearer <token>

Chamada

curl --location 'https://escala.med.br/api/v2/partner/payments/shifts?start=2024-07-01&end=2024-07-31&payment_model=BY_HOUR&hour_source=planned' \
--header 'Authorization: Bearer <API_TOKEN>' \

{
  "rows": [
      {
          "shift_id": 8379421,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "23 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379422,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "24 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379423,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "25 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379424,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "26 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379425,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "27 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379426,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "28 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379427,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "29 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      },
      {
          "shift_id": 8379428,
          "schedule": "UPA - Pediatria",
          "tag_schedule": "",
          "team": "Dia",
          "tag_team": "",
          "employee": "Felipe Soares",
          "employee_internal_id": "",
          "employee_pis": null,
          "employee_cpf": "",
          "employee_email": "arthur.gusmao+2@escala-app.com",
          "employee_phone": "",
          "tag_employee": "",
          "date": "30 Set 2020",
          "total_value": "R$ 10.656,00",
          "raw_value": 10656,
          "start": "07:00",
          "end": "19:00",
          "planned_start": "07:00",
          "planned_end": "19:00",
          "total_worked_hours": "12,00 h",
          "shift_observation": "",
          "value_source": "Valor do profissional",
          "hour_value": "R$ 888,00",
          "professional_bonus": "-",
          "team_bonus": "-",
          "schedule_bonus": "-",
          "professional_bonus_period": "-",
          "team_bonus_period": "-",
          "schedule_bonus_period": "-",
          "timezone": "America/Belem"
      }
  ],
  "total_page_value": "R$ 85.248,00",
  "total_page_hours": "96,00 h",
  "total_rows": 108,
  "next_page_url": "http://escala.test/api/v2/partner/payments/shifts?start=2020-09-01&end=2020-09-30&payment_model=BY_HOUR&hour_source=worked&ordering=ascending&orderField=schedule&secondary=date&tags_source=none&XDEBUG_SESSION_START=PHPSTORM&offset=150&limit=50&"
}

{
    "errorCode": "",
    "complementaryErrorCode": "",
    "internalErrorMessage": null,
    "userMessage": "Validation Error",
    "details": null,
    "optional": null,
    "message": {
        "start": [
            "The start field is required."
        ]
    }
}

Os campos presentes na resposta:

shift_id: identificador único do plantão
employee_id: identificador interno do funcionário
employee_internal_id: identificador único definido pelo cliente do funcionário
employee : Nome do funcionário
employee_email: e-mail do funcionário
employee_phone: telefone do funcionário
employee_cpf: cpf do funcionário
employee_pis: pis do funcionário
tag_employee: tags cadastrada para o funcionário
schedule:nome da escala
schedule_id: identificador único da escala
tag_schedule: tags cadastrada para a escala
team: nome da equipe
tag_team: tags cadastrada para a equipe
date: data do plantão
total_value: valor total a ser pago com unidade de valor
raw_value: valor a ser pago apenas em números
planned_start : horário planejado para o plantão iniciar (útil para quando há check-in e check-out)
planned_end : horário planejado para o plantão terminar (útil para quando há check-in e check-out)
start: horário de início do plantão, esse campo corresponde ao horário de check-in do profissional quando houver check-in
end: horário final do plantão, esse campo corresponde ao horário de check-out do profissional quando houver check-out
total_worked_hours: número total de horas trabalhadas
shift_observation: observação do plantão
value_source: entidade em que foi cadastrado o valor utilizado para o cálculo
hour_value: valor por hora
professional_bonus : bônus do profissional
team_bonus : bônus da equipe
schedule_bonus : bônus da escala
professional_bonus_period : período ao qual o bônus do profissional é aplicado
team_bonus_period : período ao qual o bônus da equipe é aplicado
schedule_bonus_period : período ao qual o bônus da escala é aplicado
timezone : fuso horário

PreviousCheck-in/Check-out NextAusências

Last updated 1 month ago