POST
/
v1
/
companies
Criar empresa
curl --request POST \
  --url https://api.base39.io/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "active",
  "document": "12123123000112",
  "name": "Big Corporation SA",
  "friendlyName": "Big Corp",
  "group": "cgrp_5f92f01728e009f403d8502e",
  "address": {
    "city": "São Paulo",
    "state": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "creditPolicies": [
    {
      "id": "cpol_63ss07b6c39f5d3d917009b631"
    }
  ],
  "settings": {
    "steps": {
      "title": "<string>",
      "type": "signature",
      "methodData": {
        "schema": {
          "type": "operator",
          "role": "approver"
        }
      },
      "needs": [
        "<string>"
      ],
      "hooks": {
        "onFailure": [
          "void_loan"
        ]
      },
      "onStart": [
        "mark_loan_as_pending"
      ]
    },
    "loans": {
      "concurrency": [
        {
          "quantityAllowed": 123,
          "status": [
            "open"
          ]
        }
      ],
      "conditions": [
        {
          "title": "<string>",
          "content": "<string>"
        }
      ]
    },
    "invoices": {
      "payOff": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "absolute",
          "amount": 1
        },
        "updateInvoiceItemOnInsert": true
      },
      "companyRecurring": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "static",
          "amount": 10
        },
        "create": {
          "cutoffDay": 25,
          "autoCreate": true
        },
        "updateInvoiceItemOnInsert": false
      }
    },
    "employments": {
      "expireInDays": 30,
      "canUpdateEmploymentData": true
    }
  },
  "metadata": {}
}'
{
  "id": "comp_5f92f01728e009f403d8502e",
  "status": "active",
  "document": "12123123000112",
  "name": "Big Corporation SA",
  "friendlyName": "Big Corp",
  "group": "cgrp_5f92f01728e009f403d8502e",
  "address": {
    "city": "São Paulo",
    "state": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "creditPolicies": [
    {
      "id": "cpol_63ss07b6c39f5d3d917009b631"
    }
  ],
  "settings": {
    "steps": {
      "title": "<string>",
      "type": "signature",
      "methodData": {
        "schema": {
          "type": "operator",
          "role": "approver"
        }
      },
      "needs": [
        "<string>"
      ],
      "slug": "<string>",
      "hooks": {
        "onFailure": [
          "void_loan"
        ]
      },
      "onStart": [
        "mark_loan_as_pending"
      ]
    },
    "loans": {
      "concurrency": [
        {
          "quantityAllowed": 123,
          "status": [
            "open"
          ]
        }
      ],
      "conditions": [
        {
          "title": "<string>",
          "content": "<string>"
        }
      ]
    },
    "invoices": {
      "payOff": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "absolute",
          "amount": 1
        },
        "updateInvoiceItemOnInsert": true
      },
      "companyRecurring": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "static",
          "amount": 10
        },
        "create": {
          "cutoffDay": 25,
          "autoCreate": true
        },
        "updateInvoiceItemOnInsert": false
      }
    },
    "employments": {
      "expireInDays": 30,
      "canUpdateEmploymentData": true
    }
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar uma empresa

​
document
string
required

Documento de identificação da empresa. Deve ser o CNPJ.

Example:

"12123123000112"

​
name
string
required

Razão social

Example:

"Big Corporation SA"

​
status
enum<string>
default:active

Identifica se a empresa está ativa para receber novos empréstimos.

Available options:
active,
inactive
Example:

"active"

​
friendlyName
string

Nome fantasia

Example:

"Big Corp"

​
group
string

Grupo empresarial que a empresa faz parte. [Expansível]

Example:

"cgrp_5f92f01728e009f403d8502e"

​
address
object

A especificação de um endereço

​
creditPolicies
object[]
​
settings
object
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

201 - application/json

Retorna o objeto Company se a atualização for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa uma empresa do seu negócio. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.

​
id
string

Identificador exclusivo para o objeto.

Example:

"comp_5f92f01728e009f403d8502e"

​
status
enum<string>
default:active

Identifica se a empresa está ativa para receber novos empréstimos.

Available options:
active,
inactive
Example:

"active"

​
document
string

Documento de identificação da empresa. Deve ser o CNPJ.

Example:

"12123123000112"

​
name
string

Razão social

Example:

"Big Corporation SA"

​
friendlyName
string

Nome fantasia

Example:

"Big Corp"

​
group
string

Grupo empresarial que a empresa faz parte. [Expansível]

Example:

"cgrp_5f92f01728e009f403d8502e"

​
address
object

A especificação de um endereço

​
creditPolicies
object[]
​
settings
object
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

​
createdAt
string<date-time>

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string<date-time>

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false