TOTVS Consignado

Árvore de páginas

01. VISÃO GERAL


Processo de Provisionamento no TOTVS Consignado via TOTVS Adesão

O processo de provisionamento de clientes no TOTVS Consignado é realizado através do módulo TOTVS Adesão. A equipe responsável pelo TOTVS Adesão utiliza os endpoints do Consignado para enviar as informações do cliente, incluindo os CNPJs e os parceiros conveniados que devem ser habilitados ou desabilitados.

Operações Disponíveis

Com as novas funcionalidades, será possível realizar as seguintes operações:

  1. Habilitar um Novo Cliente:

    • Permite a inclusão de um novo cliente no sistema, juntamente com seus CNPJs e parceiros conveniados.

  2. Habilitar um Novo CNPJ para um Cliente Existente:

    • Adiciona um novo CNPJ à lista de unidades ou filiais de um cliente já provisionado.

  3. Habilitar um Novo Parceiro para um Cliente Existente:

    • Permite a adição de um novo parceiro conveniado para um cliente já existente.

  4. Desintegrar um CNPJ de um Cliente Existente:

    • Remove um CNPJ previamente habilitado, desativando suas operações no sistema Consignado.

  5. Desintegrar um Parceiro de um Cliente Existente:

    • Remove um parceiro conveniado das operações do cliente.

  6. Desintegrar um Cliente Totalmente:

    • Remove o cliente do sistema Consignado, desativando todas as suas unidades (CNPJs) e parceiros.

A seguir um detalhamento dos endpoints e a função de cada um deles:

02. OPERAÇÕES

1 -  HABILITAR NOVO CLIENTE


ENDPOINT:

TipoURL
POSThttps://api-consignado.totvs.app/api/provisioning/v1/environment/generate-environment

EXEMPLO DE UTILIZAÇÃO

Abaixo os campos a serem informados na chamada ao endpoint:


Exemplo de Curl:

curl
curl --location 'https://localhost:5001/api/provisioning/v1/environment/generate-environment' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
  "fluigTenantId": "4b151eb39a9f40a6a44d222241af7e12",
  "enterpriseName": "Tenant Teste",
  "enterpriseCNPJ": "57240135000141",
  "adminEmail": "[email protected]",
  "adesaoId": "13f5764d-1e4b-4f45-8c93-e0bb10041273",
  "totvsCode": "TDEV01",
  "erpSource": 1,
  "genericPartnerCompanies": [
    {
      "partnerCode": "0039",
      "partnerCompanies": [
        {
          "cnpj": "17899772000100",
          "socialReason": "Parceiro Ja existente I",
          "streetAddress": "RUA",
          "number": "123",
          "complement": "CASA",
          "zipCode": "313178524",
          "neighborhood": "AL",
          "city": "BH",
          "state": "MG"
        }
      ]
    },
    {
      "partnerCode": "0001",
      "partnerCompanies": [
        {
          "cnpj": "71278900000143",
          "socialReason": "Parceiro Ja existente II"
        }
      ]
    }
  ]
}
'

Regras de Provisionamento e Habilitação no TOTVS Consignado

Durante o processo de provisionamento no TOTVS Consignado, algumas regras e condições específicas devem ser seguidas:

  1. Dados de Endereço Obrigatórios para Parceiros Techfin (0039):

    • Quando o parceiro informado for do tipo Techfin (0039), é obrigatório fornecer os dados de endereço completo no payload da requisição.

  2. Criação de Ambiente no RAC/Carol se Inexistente:

    • Caso seja detectado que o ambiente do cliente ainda não existe, essa verificação será realizada por meio do TotvsCode. Se necessário, um novo ambiente será criado automaticamente no RAC/Carol.

2 -  HABILITAR UM NOVO CNPJ OU PARCEIRO PARA UM CLIENTE JA EXISTENTE :

Se o cliente já possui um ambiente previamente provisionado, os parceiros e CNPJs informados na chamada serão avaliados e habilitados dentro do módulo Consignado, conforme as permissões e requisitos.

EXEMPLO DE UTILIZAÇÃO

Abaixo os campos a serem informados na chamada ao endpoint:,


Exemplo de Curl:

curl
curl --location 'https://localhost:5001/api/provisioning/v1/environment/generate-environment' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \
--header 'Content-Type: application/json-patch+json' \
--data '{
  "fluigTenantId": "4b151eb39a9f40a6a44d222241af7e18",
  "genericPartnerCompanies": [
    {
      "partnerCode": "0001",
      "partnerCompanies": [
        {
          "cnpj": "17899772000100",
          "socialReason": "Parceiro Ja existente I"
        }
      ]
    },
    {
      "partnerCode": "0039",
      "partnerCompanies": [
        {
          "cnpj": "71278900000143",
          "socialReason": "Parceiro Ja existente II",
          "streetAddress": "RUA",
          "number": "123",
          "complement": "CASA",
          "zipCode": "313178524",
          "neighborhood": "AL",
          "city": "BH",
          "state": "MG"
        }
      ]
    }
  ]
}
'



Regras de Inclusão de um Provisionamento já existente no TOTVS Consignado

Durante o processo de inclusão de um provisionamento já existente no TOTVS Consignado, algumas regras e condições específicas devem ser observadas:

  1. Dados de Endereço Obrigatórios para Parceiros Techfin (0039):

    • Quando o parceiro for do tipo Techfin (0039), é obrigatório incluir os dados de endereço completo no payload da requisição.

  2. Inclusão de Múltiplos Parceiros para o Mesmo CNPJ:

    • Será permitido associar diferentes parceiros ao mesmo CNPJ.



      Observação : Para adicionar parceiros ou CNPJs a um cliente já provisionado, é necessário informar apenas o fluigTenantId e os dados pertinentes à estrutura de genericPartnerCompanies, conforme o exemplo fornecido.


'

3. Desabilitar Cliente, CNPJ Específico ou Parceiro Conveniado

Endpoint:

MétodoURL
DELETEhttps://api-consignado.totvs.app/api/provisioning/v1/environment/provisioning-Disable

Exemplo de Utilização

A seguir, estão os campos que devem ser informados na chamada ao endpoint:


Exemplo de Curl:


curl
curl --location --request DELETE 'https://localhost:5001/api/provisioning/v1/environment/provisioning-Disable' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \
--header 'Content-Type: application/json-patch+json' \
--data '{
  "FluigTenantId": "2cc016582f849158b84-90d07697d1e6",
  "PartnerCompaniesDisable": [
    {
      "PartnerCode": "0001",
      "CnpjDisable": [
        {
          "Cnpj": "10349609000124"
        },
        {
          "Cnpj": "69996530000138"
        }
      ]
    },
    {
      "PartnerCode": "0039"
    }
  ]
}
'


Regras para desabilitar um Parceiro ou Cnpj de um provisionamento existente : 

  1. Desabilitação de Todos os CNPJs de um Parceiro:

    • Se não for informado um CNPJ na lista de desabilitação para um determinado parceiro, será entendido que todos os CNPJs configurados para aquele parceiro devem ser desabilitados.
    • Portanto, o campo cnpjDisable não é obrigatório.

  2. Erro 400 - fluigTenantId:

    • Um erro 400 será retornado se o campo fluigTenantId estiver em branco ou se o tenant informado for inexistente.

  3. Erro 400 - Código do Parceiro (partnerCode):

    • Um erro 400 será retornado se o campo partnerCode (código do parceiro) não for informado.











  • Sem rótulos