POST
/
v1
/
companies
/
batch
curl --request POST \
  --url https://api.base39.io/v1/companies/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companies": [
    "comp_5f92f01728e009f403d8502e"
  ],
  "fields": {
    "group": "<string>"
  }
}'
[
  {
    "id": "comp_5f92f01728e009f403d8502e",
    "status": "active",
    "document": "12123123000112",
    "name": "Big Corporation SA",
    "friendlyName": "Big Corp",
    "group": "cgrp_5f92f01728e009f403d8502e",
    "address": {
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "line1": "Av Paulista",
      "line2": "Sala 404",
      "number": "123",
      "postalCode": "12123123",
      "neighborhood": "Bela Vista"
    },
    "creditPolicies": [
      {
        "id": "cpol_63ss07b6c39f5d3d917009b631"
      }
    ],
    "settings": {
      "steps": {},
      "loans": {
        "concurrency": [
          {
            "quantityAllowed": 123,
            "status": [
              "open"
            ]
          }
        ],
        "conditions": [
          {
            "title": "<string>",
            "content": "<string>"
          }
        ],
        "refin": {
          "minDays": 123
        },
        "expireInDays": 123
      },
      "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,
    "createdBy": {
      "clientId": "client_identifier",
      "externalClientId": "<string>",
      "app": "backoffice"
    },
    "updatedBy": {
      "clientId": "client_identifier",
      "externalClientId": "<string>",
      "app": "backoffice"
    }
  }
]

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.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

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

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json
​
companies
string[]
required

Lista de IDs de empresas.

Example:
["comp_5f92f01728e009f403d8502e"]
​
fields
object

Campos a serem atualizados.

Response

200 - application/json
Retorna um array de `Company`.
​
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

Data de criação do objeto

Example:

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

​
updatedAt
string

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

​
createdBy
object
​
updatedBy
object