Histórico da Página
Apis de Comissões
API : POST: http://localhost:8051/api/imb/v1/commission/view
API Comissão View
Informações | ||
---|---|---|
| ||
{ |
API: GET: http://localhost:8051/api/imb/v1/commission/103
API para buscar as comissões de acordo com o ID da comissão.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "idcomissao": 103, "idmodcomissao": 1, "data": "2022-01-01T00:00:00", "codcolcontrato": 20, "contrato": "1911", "codpessempr": 27, "nomefantasia": "JARDIM DAS ORQUÍDEAS ", "numunid": "000021", "nomeunid": "000021", "numsubunid": "000012", "nomecorretor": "SILVERIO MORAIS", "statuscomissao": "Calculada", "datavenda": "2022-01-01T00:00:00", "valorcomissaototal": 3600.0000, "valorbase": 90000.0000, "valormax": 3600.0000, "comissionados": [ { "idcomissao": 103, "iditemcomissao": 1, "idregracomissao": 1, "stateentity": 0, "percentualcomissao": 0.5000, "valorcomissaocorretor": 450.0000, "nroparcelas": 3, "statuscomissaocorretor": "Calculada", "codfuncao": 4, "dscfuncao": "Corretor", "percentual": 50.0000, "codcolcfo": 0, "codcfo": "01;C100338", "nomecfo": "SILVERIO MORAIS", "pagarcomissaoaimob": 0, "tipoquempaga": "Empresa", "codtipoquempaga": 0, "tipocomissao": "Comissão", "codtipocomissao": 0, "tipocalculocomissaoitem": "Valor Fixo", "codtipocalculocomissaoitem": 0, "tipovalor": "Fórmula Percentual", "codtipovalor": 3 }, { "idcomissao": 103, "iditemcomissao": 2, "idregracomissao": 1, "stateentity": 0, "percentualcomissao": 0.5000, "valorcomissaocorretor": 450.0000, "nroparcelas": 1, "statuscomissaocorretor": "Calculada", "codfuncao": 4, "dscfuncao": "Corretor", "percentual": 50.0000, "codcolcfo": 0, "codcfo": "01;C100338", "nomecfo": "SILVERIO MORAIS", "pagarcomissaoaimob": 0, "tipoquempaga": "Cliente", "codtipoquempaga": 1, "tipocomissao": "Comissão", "codtipocomissao": 0, "tipocalculocomissaoitem": "Descrescente", "codtipocalculocomissaoitem": 0, "tipovalor": "Fórmula Percentual", "codtipovalor": 3 }, { "idcomissao": 103, "iditemcomissao": 3, "idregracomissao": 2, "stateentity": 0, "percentualcomissao": 1.0000, "valorcomissaocorretor": 900.0000, "nroparcelas": 3, "statuscomissaocorretor": "Calculada", "codfuncao": 5, "dscfuncao": "Imobiliária", "percentual": 100.0000, "codcolcfo": 0, "codcfo": "01;C100577", "nomecfo": "SILVA && SILVA", "pagarcomissaoaimob": 0, "tipoquempaga": "Empresa", "codtipoquempaga": 0, "tipocomissao": "Comissão", "codtipocomissao": 0, "tipocalculocomissaoitem": "Valor Fixo", "codtipocalculocomissaoitem": 0, "tipovalor": "Percentual", "codtipovalor": 0 } ] } |
Expandir | ||
---|---|---|
| ||
Parâmetros:
Dados recebidos:
Dados recebidos dos comissionados:
|
API: POST: http://localhost:8051/api/imb/v1/commission/
Api para buscar comissões de acordo com o usuário logado.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
Exemplo - Solicitação visualizar Comissões: { "TipoUsuarioComissionado": "0", "CpfOuCnpjUsuarioComissionado": { "CpfCnpj": "099.821.769-78" }, "CpfOuCnpjSubordinados": [ { "CpfCnpj": "" }, { "CpfCnpj": "" } ], "CnpjImobiliaria": { "CpfCnpj": "" }, "DataInicial": null, "DataFinal": null, "CodigoEmpreendimento": null } ou simplificada { "TipoUsuarioComissionado": "0", "CpfOuCnpjUsuarioComissionado": { "CpfCnpj": "011.211.841-50" } } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "count": 3, "hasNext": false, "items": [ { "idcomissao": 7, "idmodcomissao": 4, "data": "2022-03-04T00:00:00", "codcolcontrato": 1, "contrato": "2578", "codpessempr": 2019, "nomefantasia": "EMPREENDIMENTO MODELOS DE CÁLCULO", "numunid": "03", "numsubunid": "000025", "nomecorretor": "Corretor da Proposta", "statuscomissao": "Em Preparação", "datavenda": "2022-02-11T00:00:00", "valorcomissaototal": 1000.0000 }, { "idcomissao": 14, "idmodcomissao": 4, "data": "2022-03-11T00:00:00", "codcolcontrato": 1, "contrato": "9896", "codpessempr": 2019, "nomefantasia": "EMPREENDIMENTO MODELOS DE CÁLCULO", "numunid": "03", "numsubunid": "000030", "nomecorretor": "Corretor da Proposta", "statuscomissao": "Em Preparação", "datavenda": "2022-03-11T00:00:00", "valorcomissaototal": 11000.0000 } ] } |
Expandir | ||
---|---|---|
| ||
Parâmetros:
Dados Recebidos:
Dados recebidos dos itens é o mesmo da primeira API da comissão por ID |
API: GET: http://localhost:8051/api/imb/v1/commission/103/sellers
Api para buscar os comissionados de uma comissão específica e retorna a mesma estrutura da API de busca uma comissão.
API: GET: http://localhost:8051/api/imb/v1/commission/103/sellers/1
Api para buscar um comissionado específico de uma comissão específica e retorna a mesma estrutura da API de busca uma comissão.
API: DELETE: http://localhost:8051/api/imb/v1/commission/103/sellers/1
Api para deletar um comissionado específico de uma comissão específica e retorna a mesma estrutura da API de busca uma comissão.
Expandir | ||
---|---|---|
| ||
Caso seja deletado um comissionado que tem comissão paga pela empresa e pelo cliente, o valor da comissão/percentual fica para uma das duas situações. Sendo assim, caso apague o comissionado cliente, então o valor/percentual da comissão vai para comissionado empresa e vice-versa. Se for um comissionado comum é apagada normalmente o registro |
API: PUT: http://localhost:8051/api/imb/v1/commission/103/sellers/1
Api para atualizar o dado de um comissionado específico de uma comissão específica e retorna a mesma estrutura da API de busca uma comissão.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
Posso usar um JSON básico, apenas com o campo alterado {"percentualcomissao": 2.0000} ou completo com a estrutura do comissionado { "idcomissao": 103, "iditemcomissao": 1, "idregracomissao": 1, "percentualcomissao": 0.6000, "valorcomissaocorretor": 450.0000, "nroparcelas": 3, "statuscomissaocorretor": "Calculada", "codfuncao": 4, "dscfuncao": "Corretor", "percentual": 50.0000, "codcolcfo": 0, "codcfo": "01;C100338", "nomecfo": "SILVERIO MORAIS", "pagarcomissaoaimob": 0, "tipoquempaga": "Empresa", "codtipoquempaga": 0, "tipocomissao": "Comissão", "codtipocomissao": 0, "tipocalculocomissaoitem": "Valor Fixo", "codtipocalculocomissaoitem": 0, "tipovalor": "Fórmula Percentual", "codtipovalor": 3 } |
Expandir | ||
---|---|---|
| ||
Parâmetros:
Dados recebidos dos itens é o mesmo da primeira API da comissão por ID |
API: POST: http://localhost:8051/api/imb/v1/commission/103/sellers/1
Api para incluir um comissionado específico de uma comissão específica e retorna a mesma estrutura da API de busca uma comissão.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "idcomissao": 103, "iditemcomissao": null, "idregracomissao": 11, "percentualcomissao": 1.0000, "valorcomissaocorretor": 0.0000, "nroparcelas": 5, "codfuncao": 7, "dscfuncao": "Avulso", "percentual": 50.0000, "codcolcfo": 0, "codcfo": "01;C100338", "nomecfo": "SILVERIO MORAIS", "codtipoquempaga": 0, "tipoquempaga": "Empresa", "codtipocomissao": 0, "tipocomissao": "Comissão", "codtipocalculocomissaoitem": 0, "tipocalculocomissaoitem": "Valor Fixo", "codtipovalor": 0, "tipovalor": "Fórmula" } |
Expandir | ||
---|---|---|
| ||
Só pode criar uma comissionado o tipo quem recebe "Comissionado Avulso PI" e esteja na modalidade dessa comissão, pois isso indica que o usuário permite incluir novos comissionados com valores defaults. É permitido inserir vários desse tipo e nunca para a mesma pessoa. Se já existir a pessoa para esse tipo de avulso basta realizar o Put desse registro. O Id da regra é o campo mais importante, pois ele busca esse comissionado avulso de sua modalidade e insere com os valores defaults para essa comissão. Caso seja incluindo um comissionado que tem comissão paga pela empresa com percentual menor que 100%, então será criado o comissionado cliente com o a diferença desse percentual e calculando a nova proporção do percentual da comissão em cima dessa proporção de cliente e empresa. Se for criado um comissionado com regra quem paga 100%, regra padrão, então cria apenas o próprio registro. Parâmetros:
Dados recebidos dos itens é o mesmo da primeira API da comissão por ID |
API: GET: http://localhost:8051/api/imb/v1/commission/103/single_sellers/
API para buscar a regra do comissionado avulso para o Lookup do portal de imóvel, para todos os comissionados do tipo avulso que estejam na modalidade da regra da comissão editada, seguir o padrão abaixo de URI
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[ { "idcomissao": 103, "iditemcomissao": 0, "idregracomissao": 11, "stateentity": 0, "percentualcomissao": 1.0000, "valorcomissaocorretor": 0.0, "nroparcelas": 3, "codfuncao": 7, "dscfuncao": "Avulso", "percentual": 100.0000, "codcolcfo": 0, "pagarcomissaoaimob": 0, "tipoquempaga": "Empresa", "codtipoquempaga": 0, "tipocomissao": "Comissão", "codtipocomissao": 0, "tipocalculocomissaoitem": "Valor Fixo", "codtipocalculocomissaoitem": 0, "tipovalor": "Percentual", "codtipovalor": 0 }, { "idcomissao": 103, "iditemcomissao": 0, "idregracomissao": 15, "stateentity": 0, "percentualcomissao": 1.0000, "valorcomissaocorretor": 0.0, "nroparcelas": 3, "codfuncao": 8, "dscfuncao": "Secretária", "percentual": 100.0000, "codcolcfo": 0, "pagarcomissaoaimob": 0, "tipoquempaga": "Empresa", "codtipoquempaga": 0, "tipocomissao": "Prêmio", "codtipocomissao": 1, "tipocalculocomissaoitem": "Valor Fixo", "codtipocalculocomissaoitem": 0, "tipovalor": "Percentual", "codtipovalor": 0 } ] |
Expandir | ||
---|---|---|
| ||
Dados recebidos dos itens é o mesmo do padrão da primeira API dos comissionados |
API: POST: http://localhost:8051/api/imb/v1/commission/generate
API para gerar a comissão de forma automática.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
Exemplo - Solicitação Geração da Comissão: { "codColContrato": 1, "contrato": "54", "dataComissao": "2022-03-25", "valorBaseComissao": 8000, "cpfOuCnpjCorretorProposta": { "cpfCnpj": "812.406.850-09" }, "cpfOuCnpjImobiliariaProposta": { "cpfCnpj": "384.042.140-34" }, "cpfOuCnpjSDRProposta": { "cpfCnpj": "384.042.140-34" } } |
Expandir | ||
---|---|---|
| ||
Parâmetros:
Dados recebidos dos itens é o mesmo da primeira API da comissão por ID |
API: POST: http://localhost:8051/api/imb/v1/commission/103/recalculates
API para recalcular e alterar informações da comissão já cadastrada.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
Exemplo - Solicitação Recalculo da Comissão: Opcional, caso queira mudar a data e o valor, se não passar nada somente recalcula buscando o valores da venda { "valorbase": 90000.0000, "data": "2022-03-11" } |
Expandir | ||
---|---|---|
| ||
Parâmetros:
Dados recebidos dos itens é o mesmo da primeira API da comissão por ID |
API: GET: http://localhost:8051/api/imb/v1/commission/103/sellers/payments
API para retornar as parcelas de pagamento da comissão
Expandir | ||
---|---|---|
| ||
Regras:
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[ { "idcomissao": 33, "iditemcomissao": 1, "tipocomissao": "Comissão", "tipoquemrecebe": "Corretor da Proposta", "tipoquempaga": "Empresa", "tipocalculo": "Valor Fixo", "dscfuncao": "Corretor padrão", "nomecomissionado": "TESTE", "nroparcela": 1, "datapagamento": "2022-03-10T00:00:00", "valorparcela": 6000.0 }, { "idcomissao": 33, "iditemcomissao": 1, "tipocomissao": "Comissão", "tipoquemrecebe": "Corretor da Proposta", "tipoquempaga": "Empresa", "tipocalculo": "Valor Fixo", "dscfuncao": "Corretor padrão", "nomecomissionado": "TESTE", "nroparcela": 2, "datapagamento": "2022-04-10T00:00:00", "valorparcela": 6000.0 }, { "idcomissao": 33, "iditemcomissao": 1, "tipocomissao": "Comissão", "tipoquemrecebe": "Corretor da Proposta", "tipoquempaga": "Empresa", "tipocalculo": "Valor Fixo", "dscfuncao": "Corretor padrão", "nomecomissionado": "TESTE", "nroparcela": 3, "datapagamento": "2022-05-10T00:00:00", "valorparcela": 6000.0 }, { "idcomissao": 33, "iditemcomissao": 2, "tipocomissao": "Comissão", "tipoquemrecebe": "Corretor da Proposta", "tipoquempaga": "Cliente", "tipocalculo": "Proporcional", "dscfuncao": "Corretor padrão", "nomecomissionado": "TESTE", "nroparcela": 1, "datapagamento": "2022-03-10T00:00:00", "valorparcela": 2000.0 } ] |