1. Projetos
  • Introdução
    • Integração ONE
    • Visão Geral da API Rest
    • Ciclo de Vida da API
  • Ambiente
    • Ambiente
  • Autenticação
    • Gerando Chaves de Acesso
    • Autenticando-se
    • Token de Acesso
      POST
  • Projetos
    • Entendendo Projetos
    • Criação de Projeto
      POST
  • Medição
    • Entendendo a Medição
    • Criação de Medição
      POST
    • Consulta de Impostos da Empresa
      GET
    • Adição de Retenções Fiscais em uma Medição
      POST
    • Criação de Parcela em Medição
      POST
    • Validação das Parcelas
      POST
    • Validação da Medição
      PATCH
    • Mudança de Status da Medição
      PATCH
  • Contas a Pagar
    • Entendendo o Contas a Pagar
    • Adicinar Comprovante de Pagamento em Parcela
      POST
  • Fluxo Financeiro
    • Entendendo o Fluxo Financeiro
  • Webhooks
    • Entendendo o Payload
    • Eventos
      • Utilizando Webhooks
      • Criação de Medição
      • Atualização de Medição
      • Criação e Atualização de Parcela
      • Criação e Atualização de Fluxo Financeiro
  1. Projetos

Criação de Projeto

POST
api/v1/oneos/project
Endpoint para criar projetos.

Requisição

Parâmetros Bodyapplication/json
name
string 
requerido
Nme do Projeto
startDate
string 
requerido
Data de Inicial
endDate
string 
requerido
Data Final
address
object 
requerido
Endereço do Projeto
street
string 
requerido
Rua/Avenida
number
string 
requerido
Número
complement
string 
requerido
Complemento
zipCode
string 
requerido
CEP
city
string 
requerido
Cidade
district
string 
requerido
Bairro
state
string 
requerido
Estado
clientTaxId
string 
requerido
CPF/CNPJ do Cliente
clientPersonType
string 
requerido
Tipo de Cliente: PF ou PJ
clientName
string 
requerido
Nome e Sobrenome do Cliente
clientEmail
string 
requerido
E-mail do Cliente
estimatedValue
string 
requerido
Valor Estimado do Projeto
customerAddress
object 
requerido
Endereço do Cliente
street
string 
requerido
Rua/Avenida
number
string 
requerido
Número
complement
string 
requerido
Complemento
zipCode
string 
requerido
CEP
city
string 
requerido
Cidade
district
string 
requerido
Bairro
state
string 
requerido
Estado
customerPhone
string 
requerido
Telefone do Cliente
id
string 
requerido
Exemplo
{
  "id": 1,
  "name": "Nome do projeto",
  "exhibitionId": 1,
  "endDate": "2022-12-31",
  "startDate": "2024-04-10",
  "measure": 0,
  "address": {
    "id": 0,
    "city": "string",
    "complement": "string",
    "number": "string",
    "street": "string",
    "state": "string",
    "zipCode": "string",
    "district": "string",
    "type": "string"
  },
  "companyId": 1,
  "clientTaxId": "99999999999999",
  "clientName": "Cliente Teste",
  "clientEmail": "test@test.com",
  "clientPersonType": "string",
  "estimatedValue": 100,
  "status": "string",
  "customerAddress": {
    "id": 0,
    "city": "string",
    "complement": "string",
    "number": "string",
    "street": "string",
    "state": "string",
    "zipCode": "string",
    "district": "string",
    "type": "string"
  },
  "customerPhone": "string"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'api/v1/oneos/project' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": 1,
  "name": "Nome do projeto",
  "exhibitionId": 1,
  "endDate": "2022-12-31",
  "startDate": "2024-04-10",
  "measure": 0,
  "address": {
    "id": 0,
    "city": "string",
    "complement": "string",
    "number": "string",
    "street": "string",
    "state": "string",
    "zipCode": "string",
    "district": "string",
    "type": "string"
  },
  "companyId": 1,
  "clientTaxId": "99999999999999",
  "clientName": "Cliente Teste",
  "clientEmail": "test@test.com",
  "clientPersonType": "string",
  "estimatedValue": 100,
  "status": "string",
  "customerAddress": {
    "id": 0,
    "city": "string",
    "complement": "string",
    "number": "string",
    "street": "string",
    "state": "string",
    "zipCode": "string",
    "district": "string",
    "type": "string"
  },
  "customerPhone": "string"
}'

Respostas

🟢200Success
application/json
Body
id
string 
requerido
Identificador do Projeto
name
string 
requerido
Nme do Projeto
startDate
string 
opcional
Data de Inicial
endDate
string 
opcional
Data Final
address
object 
requerido
Endereço do Projeto
id
string 
requerido
Identificador do Endereço
street
string 
requerido
Rua/Avenida
number
string 
requerido
Número
complement
string 
requerido
Complemento
zipCode
string 
requerido
CEP
city
string 
requerido
Cidade
district
string 
requerido
Bairro
state
string 
requerido
Estado
companyId
string 
requerido
Empresa que Está Criando o Projeto
clientTaxId
string 
requerido
CPF/CNPJ do Cliente
clientPersonType
string 
requerido
Tipo de Cliente: PF ou PJ
clientName
string 
requerido
Nome e Sobrenome do Cliente
clientEmail
string 
requerido
E-mail do Cliente
estimatedValue
string 
requerido
Valor Estimado do Projeto
status
string 
requerido
Status do Projeto
customerAddress
object 
requerido
Endereço do Cliente
id
string 
requerido
Identificador do Endereço
street
string 
requerido
Rua/Avenida
number
string 
requerido
Número
complement
string 
requerido
Complemento
zipCode
string 
requerido
CEP
city
string 
requerido
Cidade
district
string 
requerido
Bairro
state
string 
requerido
Estado
customerPhone
string 
requerido
Telefone do Cliente
Exemplo
{
    "id": 1,
    "name": "Nome do projeto",
    "exhibitionId": 1,
    "endDate": "2022-12-31",
    "startDate": "2024-04-10",
    "measure": 0,
    "address": {
        "id": 0,
        "city": "string",
        "complement": "string",
        "number": "string",
        "street": "string",
        "state": "string",
        "zipCode": "string",
        "district": "string",
        "type": "string"
    },
    "companyId": 1,
    "clientTaxId": "99999999999999",
    "clientName": "Cliente Teste",
    "clientEmail": "test@test.com",
    "clientPersonType": "string",
    "estimatedValue": 100,
    "status": "string",
    "customerAddress": {
        "id": 0,
        "city": "string",
        "complement": "string",
        "number": "string",
        "street": "string",
        "state": "string",
        "zipCode": "string",
        "district": "string",
        "type": "string"
    },
    "customerPhone": "string"
}
Modificado em 2024-04-10 19:03:03
Página anterior
Entendendo Projetos
Próxima página
Entendendo a Medição
Built with