Skip to main content
POST
/
cadastrarEmpresa
Cadastrar empresa
curl --request POST \
  --url https://api-vendas.taximachine.com.br/api/integracao/cadastrarEmpresa \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "documento": "97.553.510/0001-28",
  "tipo_documento": "CNPJ",
  "numero_contrato": "104536",
  "razao_social": "Razão social nova empresa",
  "nome_fantasia": "Nome nova empresa",
  "endereco": {
    "logradouro": "Avenida Barão do Rio Branco 261",
    "complemento": null,
    "uf": "AP",
    "cidade": "Oiapoque",
    "bairro": "Centro",
    "cep": "68980-000"
  },
  "telefone": {
    "ddd": "85",
    "numero": "99999-8888"
  },
  "situacao_cadastral": "S",
  "categorias": [
    71
  ],
  "tipos_pagamento": [
    "B",
    "C",
    "D",
    "F",
    "H",
    "P",
    "R",
    "X"
  ],
  "area_atuacao_empresa_id": 38,
  "cobrar_retorno": true,
  "obrigar_finalizacao_com_retorno_pela_empresa": false,
  "solicitacao_rapida": {
    "habilitar": true,
    "categoria": 71,
    "tipo_pagamento": "D"
  },
  "observacao_condutor": "Obs",
  "dados_extras": "Dados"
}
'
{
  "success": true,
  "response": {
    "status": "OK",
    "mensagem": "Empresa cadastrada com sucesso."
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

​
api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
​
documento
string

(Obrigatório). Exemplo: 83.769.522/0001-80

​
tipo_documento
enum<string>

(Obrigatório). Exemplo: CNPJ

Available options:
CNPJ,
CPF
​
numero_contrato
string

(Obrigatório). Exemplo: 104536

​
razao_social
string

Razão social da empresa. Exemplo: Razão social nova empresa

​
nome_fantasia
string

(Obrigatório). Exemplo: Nome nova empresa

​
endereco
object

Dados de endereço da empresa.

​
telefone
object

Dados de telefone da empresa.

​
situacao_cadastral
enum<string>

A - Ativo, G - Aguardando ativação ou S - Suspenso. Exemplo: S

Available options:
A,
G,
S
​
categorias
integer[]

Array de inteiros indicando o id da categoria que deseja disponibilizar para empresa. Um array vazio ([]) significa todas as categorias. Exemplo: [71]

​
tipos_pagamento
enum<string>[]

Array de string contendo a sigla do tipo de pagamento. Um array vazio ([]) significa todos os tipos de pagamento. B: Débito (máquina) C: Crédito (máquina) D: Dinheiro F: Faturado H: WhatsApp P: Picpay R: Carteira de Créditos X: Pix Exemplo: ["B", "C", "D", "F", "H", "P", "R", "X"]

Available options:
B,
C,
D,
F,
H,
P,
R,
X
​
area_atuacao_empresa_id
integer

ID da área de atuação da empresa.

​
cobrar_retorno
boolean

Indica se deve cobrar retorno.

​
obrigar_finalizacao_com_retorno_pela_empresa
boolean

Indica se deve obrigar a finalização com retorno pela empresa.

​
solicitacao_rapida
object
​
observacao_condutor
string | null

Indicar observação se tiver (passar null caso contrário). Exemplo: Obs

​
dados_extras
string | null

Indicar dados extras se tiver (passar null caso contrário). Exemplo: Dados

Response

200 - application/json

Sucesso