Comissões de um profissional

get

https://api.trinks.com/v1/comissoes

Retorna o detalhamento das comissões de um profissional no dia, com valores equivalentes à tela de
Relatório de Comissões do Trinks. Cada item é uma parcela de comissão, então o mesmo idComissao pode
aparecer mais de uma vez. A taxa administrativa é informativa e já está refletida no valor da comissão.

Período: data consulta um dia inteiro; a hora é ignorada. Datas anteriores a 2012 respondem 400.

Paginação: page a partir de 1 e pageSize de 1 a 50 (padrão 10). Fora disso a resposta é 400,
diferente das listagens que limitam em 50 sem erro.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

EstabelecimentoProfissionalId

int32

required

(Obrigatório) Id do profissional no estabelecimento (o "id" retornado por
GET /v1/profissionais, ou seja, o id_estabelecimento_profissional).

Data

date-time

required

(Obrigatório) Dia da consulta. O endpoint consulta um único dia por vez.

CriterioData

int32

enum

(Opcional) Critério de data (mesmos nomes da tela web):
1 = DataLiberacaoComissao ("Data de Liberação da Comissão");
2 = DataAtendimentoVenda ("Data de Atendimento/Venda");
3 = DataPagamentoEstorno ("Data de Pagamento/Estorno").
Default: 1 (DataLiberacaoComissao).

Allowed:

StatusPagamento

int32

enum

(Opcional) 1 = Todos; 2 = Pago, comissão já incluída em fechamento do profissional; 3 = NaoPago.
Omitido = Todos. Não se refere ao pagamento do cliente.

Allowed:

Detalhado

boolean

(Opcional) Quando true, cada comissão do detalhamento traz todas as colunas do
relatório detalhado (exportação). Default: false.

IncluirEstornos

boolean

(Opcional) Quando true, inclui estornos e pagamentos estornados no resultado, como o
"Exibir estornos" do relatório web. As comissões trazidas por essa
opção vêm marcadas com estorno ou pagamentoEstornado. Default: false.

Page

int32

Numeração da página, a partir de 1 (padrão 1).

PageSize

int32

Quantidade de comissões por página, de 1 a 50 (padrão 10).

Headers

estabelecimentoId

string

required

Responses

`Errors`

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Sucesso

400Requisição inválida. Erros de validação trazem a lista em Errors

404Não encontrado

`Errors`