Pular para o conteúdo principal

Exporta ordens de serviço em JSON.

GET /api/{userId}/establishment/{establishmentId}/serviceorders/export/json

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento

Requisição

  • Método: GET
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/serviceorders/export/json
  • Headers: Authorization, Accept: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

NomeTipoDescrição
startDatestring (YYYY-MM-DD)Data inicial do período.
endDatestring (YYYY-MM-DD)Data final do período.
startTimestring (HH:MM:SS)Hora inicial. Padrão: 00:00:00.
endTimestring (HH:MM:SS)Hora final. Padrão: 23:59:59.
typeDateTimestringentryDateTime (padrão) ou exitDateTime.
serviceOrderPlatestringPlaca ou código da OS (busca parcial).
clientNamestringNome do cliente (busca parcial).
searchstringTermo de busca aplicado a placa, código, documento e nome do cliente.
servicesnumberFiltra OS que contenham um serviço específico.
orderBystringCampo de ordenação.
sortstringasc ou desc.

Resposta

  • Status: 200 OK
  • Content-Type: application/json

Exemplo de resposta

{
"response": "success",
"data": {
"establishment": {
"establishmentId": 1234,
"establishmentName": "Estacionamento Central",
"documentId": "12345678000199",
"addresses": [
{
"street": "Av. Paulista",
"number": "1000",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100"
}
],
"base64Logo": "iVBORw0KGgoAAAANSUhEUgAA..."
},
"operator": "João da Silva",
"search": {
"startDateTime": "01/04/2026",
"endDateTime": "19/04/2026"
},
"content": [
{
"establishmentId": 1234,
"serviceOrderId": 98741,
"serviceOrderCode": "EST1000123",
"cardCode": "A120",
"typePrice": 1,
"plate": "ABC1D23",
"observations": [],
"vehicleColor": "Prata",
"vehicleModel": "Fiat Uno",
"entryDateTime": "2026-04-18 08:15:00",
"exitDateTime": "2026-04-18 12:45:00",
"amount": 25.00,
"amountServices": 35.00,
"totalAmount": 60.00,
"discountId": null,
"discountAmount": 0,
"discountType": null,
"situationId": 2,
"financialSituationId": 3,
"operationSituationName": "Finalizada",
"financialSituationName": "Pago",
"clientName": "Maria Oliveira",
"userName": "João da Silva",
"userOutputName": "João da Silva",
"paymentMethodName": "Dinheiro",
"establishmentName": "Estacionamento Central",
"services": [
{
"serviceOrderId": 98741,
"description": "Lavagem simples",
"quantity": 1,
"amount": 35.00,
"serviceContractId": null,
"commissioners": null
}
]
},
{
"establishmentId": 1234,
"serviceOrderId": 98812,
"serviceOrderCode": "EST1000145",
"cardCode": "A121",
"typePrice": 2,
"plate": "XYZ9A87",
"observations": [],
"vehicleColor": "Preto",
"vehicleModel": "VW Gol",
"entryDateTime": "2026-04-19 09:00:00",
"exitDateTime": "0001-01-01 00:00:00",
"amount": 0,
"amountServices": 0,
"totalAmount": 0,
"discountId": null,
"discountAmount": 0,
"discountType": null,
"situationId": 1,
"financialSituationId": null,
"operationSituationName": "Aberta",
"financialSituationName": null,
"clientName": null,
"userName": "João da Silva",
"userOutputName": null,
"paymentMethodName": null,
"establishmentName": "Estacionamento Central",
"services": []
}
],
"resume": {
"totalSoCanceled": 0,
"totalSoPg": 125,
"totalSoUpdated": 4,
"averagePeriod": 4680,
"totalPeriod": 585000,
"totalAmountSoPg": 7550.00,
"totalFreeSituations": 2
},
"totalPeriod": "0m, 6d, 18h, 30min e 0s",
"mediumPeriod": "0m, 0d, 1h, 18min e 0s"
}
}