GET
/
v1
/
companies
curl --request GET \
  --url https://api.base39.io/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "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.

Query Parameters

​
document
string

Um filtro com base no campo document da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

​
creditPolicy
string

Um filtro com base no campo creditPolicies.id da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

​
group
string

Um filtro com base no campo group da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

​
id
string

Um filtro com base no campo id da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

​
status
enum<string>

Um filtro com base no campo status. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
active,
inactive
​
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.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

​
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.

Response

200 - application/json
Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Company` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de empresas.

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
object[]

Uma lista de empresas

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.