Esta seção apresenta os recursos disponíveis para integração com o ContractFlow. Cada rota representa uma entidade da plataforma e permite operações de criação, atualização e consulta de dados.

Person

Representa a identidade única de uma pessoa na plataforma.

Uma Person pode estar associada a diferentes papéis e entidades, como Membro, Prestador ou Responsável, evitando duplicidade de registros mesmo quando a mesma pessoa exerce múltiplas funções.

Esse modelo garante centralização da identidade, rastreabilidade e consistência das informações.

Dependências:
Nenhuma (entidade base)

https://api-{base-url}/contractflow/docs/integration/person

Member

Representa o vínculo de uma Person com a estrutura organizacional da plataforma.

O Member define como a pessoa atua dentro da organização, podendo estar associado a uma ou mais funções (Positions), que determinam suas responsabilidades e permissões.

Dependências:

• Person (obrigatório)

https://api-{base-url}/contractflow/docs/integration/member

Supplier

Representa a entidade jurídica (empresa) fornecedora de serviços.

O Supplier é a base para o relacionamento contratual, permitindo vinculação com contratos, prestadores e alocações.

Dependências:

• Position (recomendado para definição de responsabilidade)

https://api-{base-url}/contractflow/docs/integration/suplier

Contract

Representa o contrato firmado com um fornecedor.

Centraliza as informações contratuais e permite o vínculo com prestadores e alocações, sendo um dos principais elementos de governança e controle operacional.

Dependências:

• Supplier (recomendado)

• Contract Type (recomendado)

• Position (recomendado para definição de responsabilidade)

https://api-{base-url}/contractflow/docs/integration/contract

Contract Type

Representa a categorização dos contratos.

Permite organizar e classificar contratos de acordo com regras e estruturas definidas pela organização.

Dependências:
Nenhuma (entidade base)

https://api-{base-url}/contractflow/docs/integration/contract-type

Outsourced Empoyee

Representa o prestador de serviço vinculado a um fornecedor.

Cada prestador possui uma identidade única e pode estar associado a múltiplas alocações, além de documentos obrigatórios para controle de conformidade.

Dependências:

• Person (obrigatório)

• Position (recomendado para definição de responsabilidade)

https://api-{base-url}/contractflow/docs/integration/outsourced-employee/abridged

Allocation

Representa o vínculo operacional do prestador com um contrato, fornecedor e contexto de atuação.

A Allocation define onde e como o prestador está alocado dentro da organização.

• Outsourced Employee (obrigatório)

• Supplier (recomendado)

• Contract (recomendado)

• Allocation Type (recomendado)

• Position (recomendado para definição de responsabilidade)

https://api-{base-url}/contractflow/docs/integration/allocation

Allocation Type

Representa a categorização das alocações.

Permite estruturar e classificar os diferentes tipos de vínculo operacional dos prestadores.

Dependências:
Nenhuma (entidade base)

https://api-{base-url}/contractflow/docs/integration/allocation-type

Position

Representa a função exercida por um Member dentro da organização.

Define responsabilidades e escopo de atuação sobre entidades como contratos, fornecedores, prestadores e alocações, herdando permissões de uma Position Description.

Dependências:

• Member (obrigatório)

• Position Description (obrigatório)

https://api-{base-url}/contractflow/docs/integration/position

Position Description

Define o modelo de uma função.

Estabelece o escopo de permissões e responsabilidades que serão herdadas pelas Positions associadas.

Dependências:
Nenhuma (entidade base)

https://api-{base-url}/contractflow/docs/integration/position-description

Document

Gerencia os documentos associados a prestadores, fornecedores e contratos.

Permite controle de validade, conformidade e organização documental.

Dependências:

• Pode estar vinculado a:

  • Outsourced Employee

  • Supplier

  • Contract

https://api-{base-url}/contractflow/docs/integration/document