Histórico da Página
...
TOTVS Consignado (Plataforma) : objetiva-se na facilitação e a elaboração de empréstimos consignados interligando a instituição de crédito parceira e a empresa cliente ERPs TOTVS.
Abaixo segue mapeamento das API's TOTVS Consignado identificadas pelo método em destaque:
- O símbolo * (asterísco) identifica a obrigatoriedade do campo na api
- A cor vermelha do campo identifica que o campo é chave
...
| tabs | Método: POST, Método: PUT , Método: GET, Método: DELETE |
|---|---|
| ids | 1,2,3,4 |
...
| default | yes |
|---|---|
| referencia | 1 |
...
| default | yes |
|---|---|
| referencia | 1 |
...
ação
...
endpoint
...
descrição
...
campos
...
tipo
...
descrição dos campos
...
observação
...
Desmembramento da api,
Alteração
e Inclusão
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/contract
...
Insere e mantém os dados relacionados ao contrato de empréstimo firmado pelo funcionário.
...
cpf*
...
string
...
cpf funcionário
...
Desmembramento da api do MiddleWare para melhor gestão das informações
...
Manutenção no nome dos campos
...
Inserido os campos:
Registration
, ContractDate
, TotalDebit
, DebitDate
, ContractDuration
, Interest
, TotalToBorrow
, TotalToPay
, ExpirationDate
, DiscountStartDate
,PartnerLawDescription
, Status
, Taxes
...
cnpjCompany*
...
string
...
cnpj filial erp
...
registration
...
number($double)
...
matrícula do funcionário
...
contractCode*
...
string
...
código contrato
...
contractDate*
...
string($date-time)
...
data do contrato
...
totalDebit
...
number($double)
...
saldo devedor
...
debitDate
...
string($date-time)
...
data atualização saldo devedor
...
contractDuration
...
string($date-time)
...
Data de término do Contrato
...
totalToBorrow*
...
number($double)
...
Valor Total Emprestado
...
totalToPay
...
number($double)
...
Valor Total a Pagar
...
installmentValue*
...
number($double)
...
valor da parcela na contratação
...
installmentQuantity*
...
integer($int32)
...
nro.total parcelas
...
taxes
...
number($double)
...
Taxas (
"valueIOF" ,
"monthlyTax" ,
"yearlyTax" ,
"monthlyCET" ,
"yearlyCET"
)
...
expirationDate
...
string
...
Data de expiração da Proposta
...
discountStartDate
...
string
...
Data Inicial de Desconto em Folha
...
partnerLawDescription
...
string
...
Descrição do contrato
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/contract
/{contractCode}
/installment
...
Insere e mantém os dados relacionados as parcelas do empréstimo realizado pelo funcionário.
...
Para execução na plataforma recebe parâmetros (obrigatórios): contractCode
...
cpf*
...
string
...
cpf do funcionário
...
Desmembramento da api do MiddleWare para melhor gestão das informações
...
Manutenção no nome dos campos
Inserido os campos:
CPF
, CNPJCompany
, Registration
, ContractCode
, Value
...
cnpjCompany*
...
string
...
cnpj filial erp
...
registration
...
string
...
matrícula do funcionário
...
contractCode*
...
string
...
codigo contrato
...
number*
...
integer($int32)
...
número da parcela
...
dueDate*
...
string($date-time)
...
Data Vencimento da Parcela
...
value*
...
number($double)
...
Valor da Parcela
...
| default | no |
|---|---|
| referencia | 2 |
...
| default | yes |
|---|---|
| referencia | 1 |
...
ação
...
endpoint
...
descrição
...
campos
...
tipo
...
descrição dos campos
...
observação
...
Desmembramento da api, Alteração,
Inclusão
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/contract
/{contractCode}
/debit
Update contract
...
Realiza alteração do valor atual do saldo devedor e data relacionada a atualização do saldo no contrato
...
cpf*
...
string
...
cpf do funcionário
...
Desmembramento da api do MiddleWare para melhor gestão das informações.
...
Update contract
...
Manutenção no nome dos campos
...
cnpjCompany*
...
string
...
cnpj filial erp
...
registration
...
string
...
matrícula do funcionário
...
contractCode*
...
string
...
codigo contrato
...
totalDebit*
...
number($double)
...
saldo devedor
...
debitDate
...
string($date-time)
...
data atualização saldo devedor
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/contract
/{contractCode} Update contract
...
Realiza alteração em todo contrato
...
cpf*
...
string
...
cpf funcionário
...
Desmembramento da api do MiddleWare para melhor gestão das informações.
...
Update contract
...
Manutenção no nome dos campos
...
cnpjCompany*
...
string
...
cnpj filial erp
...
registration
...
number($double)
...
matrícula do funcionário
...
contractCode*
...
string
...
código contrato
...
contractDate*
...
string($date-time)
...
data do contrato
...
totalDebit
...
number($double)
...
saldo devedor
...
debitDate
...
string($date-time)
...
data atualização saldo devedor
...
contractDuration
...
string($date-time)
...
Data de término do Contrato
...
totalToBorrow*
...
number($double)
...
Valor Total Emprestado
...
totalToPay
...
number($double)
...
Valor Total a Pagar
...
installmentQuantity*
...
number($double)
...
valor da parcela na contratação
...
installmentQuantity*
...
integer($int32)
...
nro.total parcelas
...
taxes
...
number($double)
...
Taxas (
"valueIOF",
"monthlyTax",
"yearlyTax",
"monthlyCET",
"yearlyCET"
)
...
expirationDate
...
string
...
Data de expiração da Proposta
...
discountStartDate
...
string
...
Data Inicial de Desconto em Folha
...
partnerLawDescription
...
string
...
Descrição do contrato
...
status
...
integer($int32)
...
Status (
1=Aberto,
2=Encerrado,
3=Transferido
)
...
/api
/partner
/v2
/company
/{cnpj}
/contract
/{contractCode}
/installment
/{installmentNumber}
Update installment
...
Realiza alteração em apenas uma parcela do contrato
...
cpf*
...
string
...
cpf do funcionário
...
Desmembramento da api do MiddleWare para melhor gestão das informações.
...
Update Installment
Manutenção no nome dos campos
...
cnpjCompany*
...
string
...
cnpj filial erp
...
registration
...
string
...
matrícula do funcionário
...
contractCode*
...
string
...
codigo contrato
...
number*
...
integer($int32)
...
número da parcela
...
dueDate*
...
string($date-time)
...
Data Vencimento da Parcela
...
value*
...
number($double)
...
Valor da Parcela
...
| default | no |
|---|---|
| referencia | 3 |
...
| default | yes |
|---|---|
| referencia | 1 |
...
ação
...
endpoint
...
descrição
...
campos
...
tipo
...
descrição dos campos
...
observação
...
Unificação de api's,
Alteração e Inclusão
...
{URL base}
/api
/partner
/v2
/company
...
Array dos dados relacionados à empresa.
Para execução na plataforma recebe parâmetros (filial inicial e filial final) start e end; calcula e retorna resultado do campo.
...
cnpj*
...
string
...
cnpj filial erp
...
Unificado na api citada na coluna endpoint incorporando os campos a lista de itens relacionada à empresa
...
Manutenção no nome dos campos
...
Inserido os campos:
Name
Com mesma funcionalidade pode ser usada a /api/partner/v1/company/{cnpj} que recebe o cnpj como parâmetro retornando o registro deste.
...
name
...
string
...
nome da empresa
...
rangeSalaryCount
...
integer($int32)
...
Total de funcionários por Faixa Salarial
...
averageSalary
...
number($double)
...
Média Salarial funcionários
...
turnover
...
number($double)
...
turnover
...
Alteração e Inclusão
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/payroll
...
Array dos dados relacionados ao funcionário, identificando existência de folha.
...
registration
...
string
...
matrícula do funcionário
...
Manutenção no nome dos campos
...
Inserido o campo:
Registration
...
cpf
...
string
...
cpf funcionário
...
cnpjCompany*
...
string
...
cnpj filial erp
...
month*
...
integer($int32)
...
mês competência
...
year*
...
integer($int32)
...
ano competência
...
generated
...
boolean
...
Identifica se houve movimento financeiro na competência
...
Alteração e Inclusão
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/employee
...
Array dos dados relacionados ao funcionário.
Para execução na plataforma recebe parâmetros (obrigatórios) cnpjCompany, cpf; retorna dados de cadastro do funcionário bem como a apuração do valor de margem consignável calculada.
...
registration
...
string
...
matrícula do funcionário
...
Manutenção no nome dos campos
...
Inserido o campo:
Registration
...
cpf*
...
string
...
cpf funcionário
...
cnpjCompany*
...
string
...
cnpj filial erp
...
name
...
string
...
nome do funcionário
...
hiringDate
...
string($date-time)
...
Data de admissão
...
consignableMargin
...
number($double)
...
Valor da Margem Consignável
...
salary
...
number($double)
...
Salário Bruto
...
phone
...
string
...
Telefone
...
externalLoan
...
boolean
...
Indica existência de empréstimo externo a plataforma
...
status
...
integer($int32)
...
Codigo da Situação ( 1="Ativo",
2="Demitido",
3="Férias",
4="Transferido", 5="Afastado"
)
...
motherName
...
string
...
Nome da mãe
...
maritalStatus
...
integer($int32)
...
Estado civil (
1="Solteiro",
2="Casado",
3="Viúvo",
4="União estável", 5="Divorciado",
6="Desquitado",
7="Separado",
8="Outros"
)
...
...
string
...
...
birthDate
...
string($date-time)
...
Data de nascimento
...
address
...
string
...
Endereço (
"zipCode",
"street",
"number",
"addOn",
"neighborhood",
"city",
"state"
)
...
Alteração, Inclusão e Remoção
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/employee
/termination
...
Array dos dados relacionados a rescisão do funcionário.
Para execução na plataforma recebe parâmetros (obrigatórios) cnpjCompany, month,year; retorna dados de cadastro do funcionário relacionado a seu desligamento bem como a apuração do valor descontado de empréstimo na rescisão calculada.
...
cpf
...
string
...
cpf funcionário
...
Manutenção no nome dos campos
...
Inserido os campos:
Month
, Year
, Name
, Registration
Remoção dos campos:
empy_datadepagamento
, empy_demissao
, periodo
...
cnpjCompany*
...
string
...
cnpj filial erp
...
name
...
string
...
nome do funcionário
...
registration
...
string
...
matrícula do funcionário
...
terminationDate
...
string($date-time)
...
Data de Rescisão
...
paymentDate
...
string($date-time)
...
Data do Pagamento da Rescisão
...
year*
...
integer($int32)
...
ano competência - rescisão
...
month*
...
integer($int32)
...
mês competência - rescisão
...
reason
...
integer($int32)
...
Tipo de Rescisão (
1="Pedido de demissão",
2="Dispensa sem justa causa",
3="Dispensa por justa causa",
4="Acordo",
5="Término de contrato",
6="Quebra de contrato",
7="Aposentadoria",
8="Falecimento"
)
...
discountValue
...
number($double)
...
Valor descontado do empréstimo na rescisão
...
Alteração e Inclusão
...
{URL base}
/api
/partner
/v2
/company
/{cnpj}
/conciliation
...
Array dos dados relacionados a conciliação dos empréstimos do funcionário.
Para execução na plataforma recebe parâmetros (obrigatórios) cnpjCompany, month, year; retorna dados do empréstimo após resultado da conciliação da folha de pagamento.
...
registration
...
string
...
matrícula do funcionário
...
Manutenção no nome dos campos
...
Inserido os campos:
Registration
, Month
, Ano
...
Remoção dos campos:
período
...
cpf
...
string
...
cpf funcionário
...
cnpjCompany*
...
string
...
cnpj filial erp
...
contractCode
...
string
...
código contrato
...
month*
...
integer($int32)
...
mês da competência
...
year*
...
integer($int32)
...
ano da competência
...
installmentNumber
...
integer($int32)
...
número da parcela
...
installmentStatus
...
integer($int32)
...
Status da Parcela (
1= "Aberta",
2="Paga",
3="Erro"
)
...
reasonStatus
...
integer($int32)
...
Motivo do Status (
1="Parcela Paga",
2="Enviada para Folha",
3="Funcionário Demitido",
4="Não houve geração de folha para esse funcionário nesta data",
5="Não averbada - Funcionário demitido",
6="Não averbada - Não foi realizado desconto na folha de pagamento",
7="Funcionário Transferido",
8="Funcionário não encontrado"
)
...
endorsedValue
...
number($double)
...
Valor Averbado
...
notEndorsedValue
...
number($double)
...
Valor Não Averbado
...
| Totvs custom tabs box items | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
|
03. Controle de versão
Ocorrendo mudanças significativas no contrato referente a recursos das API's, a versão desse documento será atualizado, porém a atualização dinâmica poder ser verificada nos seguintes link's:
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas