Histórico da Página

Lista todas as empresas parceiras.

• Corpo da Requisição:
  Nenhum corpo necessário.

• Exemplo de Requisição com curl:

curl --location --globoff '{{Base URL}}/api/partner/v2/company' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer'

Resposta:

• 200 OK: Retorna uma lista de empresas parceiras.

[
  {
    "cnpj": "00000000000100",
    "socialReason": "Empresa Exemplo LTDA"
  },
  {
    "cnpj": "11111111111111",
    "socialReason": "Outra Empresa SA"
  }
]

Retorna informações de uma empresa parceira específica pelo CNPJ.

• Parâmetros de caminho:

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string

• Exemplo de Requisição com curl:

curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {seu_token_aqui}'

Resposta:

• 200 OK: Retorna os dados da empresa correspondente ao CNPJ fornecido.
• Exemplo de Resposta:

[
  {
    "cnpj": "11111111111111",
    "name": "Outra Empresa SA",
    "turnover": 0,
    "averageSalary": 1782.38,
    "rangeSalaryCount": [
      {
        "start": 1,
        "end": 1000,
        "numberOfEmployees": 8
      },
      {
        "start": 1001,
        "end": 2000,
        "numberOfEmployees": 65
      },
      {
        "start": 2001,
        "end": 3000,
        "numberOfEmployees": 8
      },
      {
        "start": 3001,
        "end": 4000,
        "numberOfEmployees": 5
      },
      {
        "start": 4001,
        "end": 5000,
        "numberOfEmployees": 1
      },
      {
        "start": 5001,
        "end": 6000,
        "numberOfEmployees": 1
      },
      {
        "start": 6001,
        "end": 7000,
        "numberOfEmployees": 1
      },
      {
        "start": 7001,
        "end": 8000,
        "numberOfEmployees": 0
      },
      {
        "start": 8001,
        "end": 9000,
        "numberOfEmployees": 0
      },
      {
        "start": 9001,
        "end": 10000,
        "numberOfEmployees": 0
      },
      {
        "start": 10001,
        "end": 11000,
        "numberOfEmployees": 0
      },
      {
        "start": 11001,
        "end": 12000,
        "numberOfEmployees": 0
      },
      {
        "start": 12001,
        "end": 13000,
        "numberOfEmployees": 0
      },
      {
        "start": 13001,
        "end": 14000,
        "numberOfEmployees": 0
      },
      {
        "start": 14001,
        "end": 15000,
        "numberOfEmployees": 1
      },
      {
        "start": 15001,
        "end": 2147483647,
        "numberOfEmployees": 0
      }
    ]
  }
]

Obtém todas as conciliações dos funcionários da empresa correspondente ao CNPJ fornecido.

• • Parâmetros de caminho:

    • cnpj: (obrigatório) O CNPJ da empresa.
      Tipo: string

  • Parâmetros de consulta (query):

    • month: (obrigatório) O mês da conciliação.
      Tipo: integer ($int32)
    • year: (obrigatório) O ano da conciliação.
      Tipo: integer ($int32)

  • Exemplo de Requisição com curl:

    Bloco de código
    language bash
    curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/conciliation?month={month}&year={year}' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

    Resposta:

    • 200 OK: Retorna uma lista de conciliações dos funcionários.
    • 400 Bad Reques: Se o mês ou ano forem inválidos. 

    Bloco de código
    language bash
    {   "hasNext": true,   "items": [     {       "registration": "12345",       "cpf": "123.456.789-00",       "cnpjCompany": "00.000.000/0001-00",       "contractCode": "CONTRATO123",       "month": 7,       "year": 2024,       "installmentNumber": 1,       "installmentStatus": 1,       "reasonStatus": 1,       "endorsedValue": 500.00,       "notEndorsedValue": 100.00     }   ] }

Obtém todos os contratos associados a uma empresa identificada pelo CNPJ.

• Parâmetros de caminho (path):

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string
  • 200 OK: Retorna uma lista de contratos associados à empresa.
  • Exemplo de Resposta:

  • Exemplo de Requisição com curl:

    Bloco de código
    language bash
    curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/contract' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

    Resposta:

  • Exemplo de Resposta

• Bloco de código
  language bash title Json
  {   "hasNext": false,   "items": [     {       "employee": {         "cpf": "51868155005",         "cnpjCompany": "21867387000662",         "registration": "99000001"       },       "contractCode": "TESTE_2009",       "contractDate": "2024-07-15T20:08:12.372Z",       "totalDebit": 0,       "debitDate": "2024-07-15T20:08:12.372Z",       "contractDuration": "2024-07-15T20:08:12.372Z",       "totalToBorrow": 200,       "totalToPay": 0,       "installmentValue": 200,       "installmentQuantity": 1,       "taxes": {         "valueIOF": 1.2,         "monthlyTax": 4.5,         "yearlyTax": 2.5,         "monthlyCET": 3.5,         "yearlyCET": 1.3       },       "expirationDate": "2024-07-15T20:08:12.372Z",       "discountStartDate": "2024-07-15T20:08:12.372Z",       "partnerLawDescription": "string",       "partnerCode": null,       "status": 1,       "statusByPartner": null     }   ] }

  Erro 404 Not Found

  • Descrição: Este erro ocorre quando o contrato associado ao CNPJ fornecido não é localizado no sistema.
  • Resposta de Erro:

  Bloco de código
  language bash title Json
  [   {     "Key": "Contract_NotFound",     "Message": "Contrato não foi encontrado no sistema",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 404   } ]

  
  

Essa Api permite obter informações sobre uma parcela específica de um contrato e para listar todas as parcelas de um contrato associado a uma empresa identificada pelo CNPJ.

curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/contract/{contractCode}/installment/{installmentNumber}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {seu_token_aqui}'

Cria um novo contrato para a empresa identificada pelo CNPJ.

• Parâmetros de caminho (path):

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string

  • Exemplo de Requisição com curl:

    Bloco de código
    language bash
    curl --location --globoff --request POST '{{Base URL}}/api/partner/v2/company/{cnpj}/contract' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}' \ --header 'Content-Type: application/json' \ --data-raw '{   "employee": {     "cpf": "string",     "cnpjCompany": "string",     "registration": "string"   },   "contractCode": "string",   "contractDate": "2024-08-30T12:59:13.637Z",   "totalDebit": 0,   "debitDate": "2024-08-30T12:59:13.637Z",   "contractDuration": "2024-08-30T12:59:13.637Z",   "totalToBorrow": 0,   "totalToPay": 0,   "installmentValue": 0,   "installmentQuantity": 0,   "taxes": {     "valueIOF": 0,     "monthlyTax": 0,     "yearlyTax": 0,     "monthlyCET": 0,     "yearlyCET": 0   },   "expirationDate": "2024-08-30T12:59:13.637Z",   "discountStartDate": "2024-08-30T12:59:13.637Z",   "partnerLawDescription": "string",   "partnerCode": "string",   "status": 1,   "statusByPartner": {     "reasonType": 1,     "reason": "string",     "partnerContractNumber": "string",     "terminationDate": "2024-08-30T12:59:13.637Z"   } }'

    Campos Obrigatórios

    • CNPJ: Identificação da empresa.
      Tipo: string
      Local: Path (caminho)

    • Employee: Dados do funcionário associado ao contrato.

      • cpf: CPF do funcionário.
        Tipo: string
      • cnpjCompany: CNPJ da empresa.
        Tipo: string
      • registration: Matrícula do funcionário.
        Tipo: string

    • ContractCode: Código do contrato.
      Tipo: string

    • ContractDate: Data de início do contrato.
      Tipo: string (ISO 8601)

    • TotalDebit: Valor total do débito.
      Tipo: number

    • DebitDate: Data do débito.
      Tipo: string (ISO 8601)

    • ContractDuration: Duração do contrato.
      Tipo: string (ISO 8601)

    • TotalToBorrow: Valor total a ser emprestado.
      Tipo: number

    • TotalToPay: Valor total a ser pago.
      Tipo: number

    • InstallmentValue: Valor da parcela.
      Tipo: number

    • InstallmentQuantity: Quantidade de parcelas.
      Tipo: integer

    • Taxes: Informações sobre os impostos aplicáveis.

      • ValueIOF: Valor do IOF.
        Tipo: number
      • MonthlyTax: Taxa mensal.
        Tipo: number
      • YearlyTax: Taxa anual.
        Tipo: number
      • MonthlyCET: CET mensal.
        Tipo: number
      • YearlyCET: CET anual.
        Tipo: number

    • ExpirationDate: Data de expiração do contrato.
      Tipo: string (ISO 8601)

    • DiscountStartDate: Data de início do desconto.
      Tipo: string (ISO 8601)

    • PartnerLawDescription: Descrição das leis do parceiro.
      Tipo: string

    • PartnerCode: Código do parceiro.
      Tipo: string

    • Status: Status do contrato.
      Tipo: integer (Enum)

    • StatusByPartner: Informações adicionais sobre o status do contrato fornecido pelo parceiro.

      • ReasonType: Tipo de motivo.
        Tipo: integer (Enum)
      • Reason: Motivo.
        Tipo: string
      • PartnerContractNumber: Número do contrato fornecido pelo parceiro.
        Tipo: string
      • TerminationDate: Data de término do contrato (obrigatória para contratos encerrados).
        Tipo: string (ISO 8601)

    Estrutura da Resposta

    • 201 Created: Contrato criado com sucesso.

    • Exemplo de Resposta:

      Bloco de código
      language bash title Json
      {   "employee": {     "cpf": "06887896923",     "cnpjCompany": "21867387000743",     "registration": "00000025"   },   "contractCode": "200820261",   "contractDate": "2020-12-13T18:36:26.278Z",   "totalDebit": 888,   "debitDate": "0001-01-01T00:00:00Z",   "contractDuration": "0001-01-01T00:00:00Z",   "totalToBorrow": 888,   "totalToPay": 888,   "installmentValue": 108,   "installmentQuantity": 20,   "taxes": {     "valueIOF": 0.3,     "monthlyTax": 0.3,     "yearlyTax": 0.3,     "monthlyCET": 0.3,     "yearlyCET": 0.3   },   "expirationDate": "2022-08-13T18:36:26.278Z",   "discountStartDate": "2022-08-13T18:36:26.278Z",   "partnerLawDescription": "",   "partnerCode": null,   "status": 1,   "statusByPartner": {     "reasonType": 1,     "reason": "",     "partnerContractNumber": "20082024",     "terminationDate": "0001-01-01T00:00:00"   } }

      Tratamento de Erros

      1. Contrato Duplicado

         • Descrição: Já existe um contrato com o mesmo código para a empresa especificada.
         • Código de Status HTTP: 400 Bad Request

         • Resposta de Erro:

           Bloco de código
           language bash title Json
           [   {     "Key": "Contract_Duplicated",     "Message": "Já existe um contrato com o mesmo código nesta empresa",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 400   } ]

    2. Data Inválida

    • Descrição: Para contratos encerrados, a data de finalização (TerminationDate) deve ser informada.
    • Código de Status HTTP: 400 Bad Request

    • Resposta de Erro:

      Bloco de código
      language bash title Json
      [   {     "Key": "Invalid_Date",     "Message": "Para contratos fechados informe a data de finalização no campo TerminationDate.",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 400   } ]

    Tipos de Status do Contrato

public enum EContractStatusDTO
{
    Open = 1,       // Contrato aberto
    Terminated = 2, // Contrato encerrado
    Transferred = 3 // Contrato transferido
}

Tipos de ReasonType

public enum EReasonStatusDTO
{
    Normal = 1,     // Normal
    Refin,          // Refinanciamento
    Portability     // Portabilidade
}

Este documento descreve o endpoint utilizado para a criação de parcelas associadas a um contrato específico dentro de uma empresa, identificada pelo CNPJ.

Atualiza o débito total de um contrato específico identificado pelo contractCode, pertencente a uma empresa identificada pelo cnpj.

• Parâmetros de caminho (path):

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string
  • contractCode: (obrigatório) O código do contrato.
    Tipo: string

• Exemplo de Requisição com curl:

  Bloco de código
  language bash
  curl --location --globoff --request PUT '{{Base URL}}/api/partner/v2/company/{cnpj}/contract/{contractCode}/debit' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}' \ --header 'Content-Type: application/json' \ --data '{   "cpf": "string",   "cnpjCompany": "string",   "registration": "string",   "contractCode": "string",   "totalDebit": 0,   "debitDate": "2024-08-30T14:31:59.131Z" }'

  Campos Obrigatórios

  • CNPJ: Identificação da empresa.
    Tipo: string
    Local: Path (caminho)

  • ContractCode: Código do contrato.
    Tipo: string
    Local: Path (caminho)

  • Request Body:

    • cpf: CPF do funcionário associado ao contrato.
      Tipo: string
    • cnpjCompany: CNPJ da empresa associada ao contrato.
      Tipo: string
    • registration: Matrícula do funcionário.
      Tipo: string
    • contractCode: Código do contrato.
      Tipo: string
    • totalDebit: Valor total do débito associado ao contrato.
      Tipo: number
    • debitDate: Data do débito.
      Tipo: string (ISO 8601)

Estrutura da Resposta

• 200 OK: Débito registrado com sucesso.

• Exemplo de Resposta:

  Bloco de código
  language bash title Json
  {   "cpf": "06887896923",   "cnpjCompany": "21867387000743",   "registration": "00000025",   "contractCode": "200820261",   "totalDebit": 20000,   "debitDate": "2024-08-30T14:31:17.343Z" }

   

Tratamento de Erros

1. Código do Contrato Inconsistente

   • Descrição: O código do contrato na rota não corresponde ao código no corpo da requisição.
   • Código de Status HTTP: 400 Bad Request
   • Resposta de Erro:

[
  {
    "Key": "Invalid_Code",
    "Message": "Código do contrato da requisição inconsistente. Código do contrato 200820269 na rota e 200820261 no corpo.",
    "HttpStatusCode": 0,
    "DetailMessageError": null,
    "StatusCode": 400
  }
]

     2. Contrato Não Encontrado

• Descrição: O contrato especificado não foi encontrado no sistema.
• Código de Status HTTP: 404 Not Found

• Resposta de Erro:

  Bloco de código
  language bash title Json
  [   {     "Key": "Contract_NotFound",     "Message": "Contrato não foi encontrado no sistema",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 404   } ]

• 3. Funcionário Não Encontrado

  • Descrição: O funcionário especificado não foi encontrado no sistema.
  • Código de Status HTTP: 404 Not Found

  • Resposta de Erro:

    Bloco de código
    language bash title Json
    [   {     "Key": "Registration_NotFound",     "Message": "Funcionário não foi encontrado no sistema",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 404   } ]

    
    

     Campos Obrigatórios

• CNPJ: Identificação da empresa.
  Tipo: string
  Local: Path (caminho)

• ContractCode: Código do contrato.
  Tipo: string
  Local: Path (caminho)

• Request Body:

  • employee: Informações do funcionário associado ao contrato.
    • cpf: CPF do funcionário.
      Tipo: string
    • cnpjCompany: CNPJ da empresa associada ao contrato.
      Tipo: string
    • registration: Matrícula do funcionário.
      Tipo: string
  • contractCode: Código do contrato.
    Tipo: string
  • contractDate: Data de criação do contrato.
    Tipo: string (ISO 8601)
  • totalDebit: Valor total do débito associado ao contrato.
    Tipo: number
  • debitDate: Data do débito.
    Tipo: string (ISO 8601)
  • contractDuration: Duração do contrato.
    Tipo: string (ISO 8601)
  • totalToBorrow: Valor total a ser emprestado.
    Tipo: number
  • totalToPay: Valor total a ser pago.
    Tipo: number
  • installmentValue: Valor de cada parcela.
    Tipo: number
  • installmentQuantity: Quantidade de parcelas.
    Tipo: integer
  • taxes: Detalhes dos impostos aplicáveis.
    • valueIOF: Valor do IOF.
      Tipo: number
    • monthlyTax: Taxa mensal.
      Tipo: number
    • yearlyTax: Taxa anual.
      Tipo: number
    • monthlyCET: CET mensal.
      Tipo: number
    • yearlyCET: CET anual.
      Tipo: number
  • expirationDate: Data de expiração do contrato.
    Tipo: string (ISO 8601)
  • discountStartDate: Data de início do desconto.
    Tipo: string (ISO 8601)
  • partnerLawDescription: Descrição das leis aplicáveis ao parceiro.
    Tipo: string
  • partnerCode: Código do parceiro.
    Tipo: string
  • status: Status do contrato.
    Tipo: integer (enum)
    • 1: Aberto
    • 2: Encerrado
    • 3: Transferido
  • statusByPartner: Detalhes sobre o status fornecido pelo parceiro.
    • reasonType: Tipo de motivo.
      Tipo: integer (enum)
      • 1: Normal
      • 2: Refinanciamento
      • 3: Portabilidade
    • reason: Motivo detalhado.
      Tipo: string
    • partnerContractNumber: Número do contrato do parceiro.
      Tipo: string
    • terminationDate: Data de encerramento do contrato.
      Tipo: string (ISO 8601)

Estrutura da Resposta

• 200 OK: Contrato atualizado com sucesso.

• Exemplo de Resposta

  Bloco de código
  language bash title Json
  { "employee": { "cpf": "06887896923", "cnpjCompany": "21867387000743", "registration": "00000025" }, "contractCode": "200820261", "contractDate": "2020-12-13T18:36:26.278Z", "totalDebit": 988, "debitDate": "0001-01-01T00:00:00Z", "contractDuration": "0001-01-01T00:00:00Z", "totalToBorrow": 888, "totalToPay": 888, "installmentValue": 148, "installmentQuantity": 20, "taxes": { "valueIOF": 0.3, "monthlyTax": 0.3, "yearlyTax": 0.3, "monthlyCET": 0.3, "yearlyCET": 0.3 }, "expirationDate": "2022-08-13T18:36:26.278Z", "discountStartDate": "2022-08-13T18:36:26.278Z", "partnerLawDescription": "", "partnerCode": null, "status": 1, "statusByPartner": { "reasonType": 1, "reason": "", "partnerContractNumber": "20082024", "terminationDate": "0001-01-01T00:00:00Z" } }

1. • Tratamento de Erros

     Código de Status: 404 Not Found

     • Registration_NotFound: O funcionário especificado não foi encontrado no sistema.

     Exemplo de Resposta de Erro:

     Bloco de código
     language bash title Json
     [   {     "Key": "Registration_NotFound",     "Message": "Funcionário não foi encontrado no sistema",     "HttpStatusCode": 404,     "DetailMessageError": null,     "StatusCode": 404   } ]

     Código de Status: 400 Bad Request

     • Invalid_Code: O código do contrato na rota não corresponde ao código no corpo da requisição.

     Exemplo de Resposta de Erro:

     Bloco de código
     language bash title Json
     [   {     "Key": "Invalid_Code",     "Message": "Código do contrato da requisição inconsistente. Código do contrato 200820261 na rota e 200820211 no corpo.",     "HttpStatusCode": 400,     "DetailMessageError": null,     "StatusCode": 400   } ]

Atualiza as informações de um contrato específico identificado pelo contractCode, pertencente a uma empresa identificada pelo cnpj.

• Parâmetros de caminho (path):

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string
  • contractCode: (obrigatório) O código do contrato.
    Tipo: string

• Exemplo de Requisição com curl:

  Bloco de código
  language bash
  curl --location --globoff --request PUT '{{Base URL}}/api/partner/v2/company/{cnpj}/contract/{contractCode}' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}' \ --header 'Content-Type: application/json' \ --data-raw '{   "employee": {     "cpf": "string",     "cnpjCompany": "string",     "registration": "string"   },   "contractCode": "string",   "contractDate": "2024-08-30T17:12:06.582Z",   "totalDebit": 0,   "debitDate": "2024-08-30T17:12:06.582Z",   "contractDuration": "2024-08-30T17:12:06.582Z",   "totalToBorrow": 0,   "totalToPay": 0,   "installmentValue": 0,   "installmentQuantity": 0,   "taxes": {     "valueIOF": 0,     "monthlyTax": 0,     "yearlyTax": 0,     "monthlyCET": 0,     "yearlyCET": 0   },   "expirationDate": "2024-08-30T17:12:06.582Z",   "discountStartDate": "2024-08-30T17:12:06.582Z",   "partnerLawDescription": "string",   "partnerCode": "string",   "status": 1,   "statusByPartner": {     "reasonType": 1,     "reason": "string",     "partnerContractNumber": "string",     "terminationDate": "2024-08-30T17:12:06.582Z"   } }'

  Tratamento de Erros

  Código de Status: 400 Bad Request

  • ContractNotFoundToRegistration: Não foi encontrada parcela neste contrato para esse funcionário.
  • Installment_NotFound: Não existe uma parcela com o número {installmentNumber} no contrato.
  • InstallmentPaidValue_IsNull: O valor do pagamento da parcela {installmentNumber} e/ou data de pagamento devem ser informados.
  • Installment_Import: A parcela de número {installmentNumber} já foi importada para folha de pagamento.

  Exemplo de Resposta de Erro:

[
  {
    "Key": "ContractNotFoundToRegistration",
    "Message": "Não foi encontrada parcela neste contrato para esse funcionario.",
    "HttpStatusCode": 400,
    "DetailMessageError": null,
    "StatusCode": 400
  }
]

Este endpoint permite a atualização de uma parcela específica de um contrato de uma empresa.

curl --location --globoff --request PUT '{{Base URL}}/partner/v2/company/{cnpj}/contract/{contractCode}/installment/{installmentNumber}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {seu_token_aqui}' \
--header 'Content-Type: application/json' \
--data '{
  "cpf": "06887896923",
  "cnpjCompany": "21867387000743",
  "registration": "00000025",
  "contractCode": "200820261",
  "number": 1,
  "dueDate": "2024-08-30T13:39:47.615Z",
  "status": 1,
  "value": 500,
  "statusByPartner": {
    "endorsedValue": 0,
    "paymentDate": "2024-08-30T18:06:17.060Z",
    "notEndorsedValue": 0,
    "updateDate": "2024-08-30T18:09:20.799Z"
  }
}'

{
  "cpf": "06887896923",
  "cnpjCompany": "21867387000743",
  "registration": "00000025",
  "contractCode": "200820261",
  "number": 1,
  "dueDate": "2024-08-30T13:39:47.615Z",
  "status": 1,
  "value": 500,
  "statusByPartner": {
    "endorsedValue": 0,
    "paymentDate": "2024-08-30T18:06:17.060Z",
    "notEndorsedValue": 0,
    "updateDate": "2024-08-30T18:09:20.799Z"
  }
}

[
  {
    "Key": "ContractNotFoundToRegistration",
    "Message": "Não foi encontrada parcela neste contrato para esse funcionario.",
    "HttpStatusCode": 400,
    "DetailMessageError": null,
    "StatusCode": 400
  }
]

Obtém todos os funcionários de uma empresa com base em filtros aplicados.

• Parâmetros de caminho:

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string

• Parâmetros de consulta (query):

  • cpf: (obrigatório) CPF do funcionário.
    Tipo: string

• Exemplo de Requisição com curl:

  Bloco de código
  language bash
  curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/employee?cpf={cpf}' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

  Resposta:

  • 200 OK: Retorna uma lista de funcionários com base nos filtros aplicados. 

  • Exemplo de Resposta:

    Bloco de código
    language bash title Json
    {   "hasNext": false,   "items": [     {       "registration": "00000002",       "cpf": "75215950687",       "cnpjCompany": "21867387000662",       "name": "JOAO DA SILVA JORDAM",       "hiringDate": "1991-01-02T00:00:00Z",       "consignableMargin": 0,       "consignableMarginFull": 0,       "salary": 1355.29,       "phone": "(31) 2122-9000",       "externalLoan": false,       "terminationDate": null,       "status": 1,       "motherName": "MARIA HELENA DE QUEIROZ",       "maritalStatus": 3,       "email": "[email protected]",       "birthDate": "1950-05-28T00:00:00Z",       "address": {         "zipCode": "31140270",         "street": "Rua Prof. Marcolino",         "number": "450",         "addOn": "303",         "neighborhood": "Jatoba",         "city": "Belo Horizonte",         "state": "MG"       }     }   ] }

Obtém todas as informações sobre desligamentos de funcionários da empresa correspondente ao CNPJ fornecido.

• Parâmetros de caminho:

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string

• Parâmetros de consulta (query):

  • month: (obrigatório) O mês do desligamento.
    Tipo: integer ($int32)
  • year: (obrigatório) O ano do desligamento.
    Tipo: integer ($int32)

• Exemplo de Requisição com curl:

  Bloco de código
  curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/employee/termination?month={month}&year={year}' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

  Resposta:

  • 200 OK: Retorna uma lista de desligamentos de funcionários.
  • 400 Bad Reques: Se o mês ou ano forem inválidos. 

  • Exemplo de Resposta:

    Bloco de código
    language bash title Json
    {   "hasNext": true,   "items": [     {       "cpf": "123.456.789-00",       "cnpjCompany": "00000000000100",       "name": "John Doe",       "registration": "REG123",       "terminationDate": "2024-08-29T19:28:46.036Z",       "paymentDate": "2024-08-29T19:28:46.036Z",       "year": 2024,       "month": 8,       "reason": 1,       "discountValue": 0.00     }   ] }

Obtém todas as folhas de pagamento da empresa correspondente ao CNPJ fornecido para um mês e ano específicos.

• Parâmetros de caminho (path):

  • cnpj: (obrigatório) O CNPJ da empresa.
    Tipo: string

• Parâmetros de consulta (query):

  • month: (obrigatório) O mês da folha de pagamento.
    Tipo: integer ($int32)
  • year: (obrigatório) O ano da folha de pagamento.
    Tipo: integer ($int32)

• Exemplo de Requisição com curl:

  Bloco de código
  language bash
  curl --location --globoff '{{Base URL}}/api/partner/v2/company/{cnpj}/payroll?month={month}&year={year}' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

  Resposta:

  • 200 OK: Retorna uma lista de folhas de pagamento geradas para o mês e ano especificados.
  • 400 Bad Reques: Se o mês ou ano forem inválidos. 
  • Exemplo de Resposta:

  Bloco de código
  language bash title Json
  {   "hasNext": true,   "items": [     {       "registration": "REG123",       "cpf": "123.456.789-00",       "cnpjCompany": "00.000.000/0001-00",       "month": 8,       "year": 2024,       "generated": true     }   ] }

Obtém todas as relações entre uma pessoa e as empresas associadas ao CPF fornecido.

• Parâmetros de caminho (path):

  • cpf: (obrigatório) O CPF da pessoa.
    Tipo: string

• Exemplo de Requisição com curl:

  Bloco de código
  language bash
  curl --location --globoff '{{Base URL}}/api/partner/v2/person/{cpf}/company' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {seu_token_aqui}'

  Resposta:

  • 200 OK: Retorna uma lista de relações entre a pessoa e as empresas associadas.

  • Exemplo de Resposta:

    Bloco de código
    language bash title Json
    {   "hasNext": false,   "items": [     {       "cnpj": "21867387000662",       "cpf": "75215950687",       "registration": "00000002"     }   ] }

    Erro 404 Not Found

    • Descrição: Este erro ocorre quando o funcionário associado ao CPF fornecido não é localizado no sistema.
    • Resposta de Erro:

  Bloco de código
  language bash title Json
  [   {     "Key": "PersonCompanyRelationship_Not_Found",     "Message": "Funcionário não localizado.",     "HttpStatusCode": 0,     "DetailMessageError": null,     "StatusCode": 404   } ]