OSs concluídos
Descrição
Retorna as ordens de serviço concluídas.
Exemplo:
- Simples
- Detalhado
[
{
"tos_id": "1234",
"tos_is_client_number": "False",
"tos_number": "1",
"tos_year": "2024",
"tos_description": "This is a description",
"tclient_name": "Client",
"tbudget_is_custom_number": "",
"tbudget_registration_timestamp": "",
"tbudget_number": "",
"tos_start_timestamp": "01/01/2024 00:00:00",
"tos_end_timestamp": "02/01/2024 00:00:00",
"tos_status": "2",
"tos_note_total_cost": "50,00",
"spend_total": "100,00",
"tos_price": "200",
"tos_additional_field_1": "",
"tos_additional_field_2": "",
"tos_additional_field_3": "",
"tos_additional_field_4": "",
"tos_additional_field_5": ""
}
]
[
{
"tos_id": "1234",
"tos_is_client_number": "False",
"tos_number": "1",
"tos_year": "2024",
"tos_description": "This is a description",
"tclient_name": "Cliente",
"tbudget_is_custom_number": "",
"tbudget_registration_timestamp": "",
"tbudget_number": "",
"tos_start_timestamp": "01/01/2024 00:00:00",
"tos_end_timestamp": "02/01/2024 00:00:00",
"tos_status": "2",
"tos_note_total_cost": "50,00",
"spend_total": "100,00",
"tos_price": "200",
"tos_additional_field_1": "",
"tos_additional_field_2": "",
"tos_additional_field_3": "",
"tos_additional_field_4": "",
"tos_additional_field_5": "",
"Apontamentos": [
{
"tnote_id": "12345",
"tresource_name": "LAAA",
"tnote_start_timestamp": "01/01/2024 08:00:00",
"tnote_end_timestamp": "01/01/2024 09:00:00",
"tnote_elapsed_hours": "1,0000",
"tnote_total_cost": "50,00",
"tos_id": "1234",
"tos_is_client_number": "False",
"tos_number": "1",
"tos_complete_number": "1/24",
"tos_year": "2024",
"tos_description": "This is a description",
"tclient_name": "Cliente",
"tbudget_is_custom_number": "",
"tbudget_registration_timestamp": "",
"tbudget_number": "",
"tos_start_timestamp": "01/01/2024 00:00:00",
"tos_end_timestamp": "02/01/2024 00:00:00",
"tos_status": "2",
"tos_note_total_cost": "50,00",
"spend_total": "100,00",
"tos_price": "200,00",
"tos_additional_field_1": "",
"tos_additional_field_2": "",
"tos_additional_field_3": "",
"tos_additional_field_4": "",
"tos_additional_field_5": "",
"tuser_name": "",
"tnote_was_edited": "",
"tcard_number": ""
}
],
"Gastos": [
{
"tos_id": "1234",
"tspend_description": "Parafuso",
"tspend_total": "100"
}
]
}
]
URL
/api/v1/companyKey=:companyKey/integrationKey=:integrationKey/os/concluido[?:params]
Parâmetros possíveis
| Parâmetro | Descrição | Exemplo | Obrigatório? |
|---|---|---|---|
| start_time | Define a data/hora inicial dos dados no formato ISO 8601 (UTC). Deve acompanhar o parâmetro end_time | start_time=2024-03-01T08:00:00Z | Sim |
| end_time | Define a data/hora final dos dados no formato ISO 8601 (UTC). Deve acompanhar o parâmetro start_time | end_time=2024-03-01T09:00:00Z | Sim |
| cliente | Filtra apenas os resultados onde o nome do cliente for igual ao valor informado. Pode informar um ou mais clientes. Deve-se separar várias tags usando-se vírgula | cliente=nome1,nome2 | Não |
Modificadores de data/hora
Você pode substituir os parâmetros start_time/end_time por um modificador de data/hora (clique aqui para saber mais). Caso ambos estejam presentes, o primeiro par tem preferência.
Exemplo de consulta
// buscando as ordens de serviço entre 08h00 e 09h00 (UTC) do dia 03/01/2024
/os/concluido?start_time=2024-03-01T08:00:00Z&end_time=2024-03-01T09:00:00Z
// Filtrando os resultados da consulta anterior para somente uma OS
/os/concluido?start_time=2024-03-01T08:00:00Z&end_time=2024-03-01T09:00:00Z&cliente=nome1
// Filtrando os resultados da consulta anterior para somente duas OSs
/os/concluido?start_time=2024-03-01T08:00:00Z&end_time=2024-03-01T09:00:00Z&cliente=nome1,nome2
// Usando um modificador de data/hora para consultar a última hora
/os/concluido?lasthour&cliente=nome1,nome2