Consulta vendas para integração com a folha

GET 
/v1/venda

Retorna vendas integradas ou pendentes, ordenadas pelo identificador. Vendas vinculadas a outra venda, de tipos 17 e 18, futuras, registradas no último minuto ou anteriores a 23/11/2014 são excluídas. Quando integrado é true, empresa e matrícula são obrigatórias em conjunto.

Authorization

Autentique-se em POST /v1/autenticacao e informe no campo Bearer Token somente o valor da propriedade token retornada. A interface enviará o cabeçalho Authorization: Bearer TOKEN automaticamente.

Request

Query Parameters

Responses

200

Vendas encontradas; data é uma lista vazia quando não há resultados.

application/json

Schema

Schema

success booleanrequired
message stringnullablerequired
total int64required

data

object[]

required

Array [

id int64required

colaborador

object

required

id int64required

empCod int64required

matricula int64required

dtComp daterequired

dthrVenda date-timerequired

dthrIntegradoFolha date-timenullablerequired

vlrVenda doublerequired

nroParcelas int32required

parcelas

object[]

required

Array [

nroParcela int32required

dtParcela daterequired

vlrParcela doublerequired

]

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "id": 0,
      "colaborador": {
        "id": 0,
        "empCod": 0,
        "matricula": 0
      },
      "dtComp": "2024-07-29",
      "dthrVenda": "2024-07-29T15:51:28.071Z",
      "dthrIntegradoFolha": "2024-07-29T15:51:28.071Z",
      "statusIntegradoFolha": "1",
      "vlrVenda": 0,
      "nroParcelas": 0,
      "parcelas": [
        {
          "nroParcela": 0,
          "dtParcela": "2024-07-29",
          "vlrParcela": 0
        }
      ]
    }
  ]
}

sucesso

{
  "success": true,
  "message": null,
  "total": 1,
  "data": [
    {
      "id": 533,
      "colaborador": {
        "id": 20,
        "empCod": 2,
        "matricula": 300000
      },
      "dtComp": "2020-07-31",
      "dthrVenda": "2020-07-16T09:45:00",
      "dthrIntegradoFolha": null,
      "statusIntegradoFolha": null,
      "vlrVenda": 150,
      "nroParcelas": 1,
      "parcelas": []
    }
  ]
}

400

Regra de negócio não atendida ou chamada inválida.

application/json

Schema

Schema

success booleanrequired
message stringrequired
total int64
data undefined[]
cause stringnullable

Example (from schema)

{
  "success": false,
  "message": "Invalid call of API.",
  "total": 0,
  "data": [
    null
  ],
  "cause": "string"
}

422

Falha de binding ou validação dos parâmetros recebidos.

application/json

Schema

Schema

success booleanrequired
message stringrequired
total int64
data undefined[]
cause stringnullable

Example (from schema)

{
  "success": false,
  "message": "Invalid call of API.",
  "total": 0,
  "data": [
    null
  ],
  "cause": "string"
}

Loading...