Sign in

v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB
Contas

Criar

post/v1/company

Request body

documentType'CPF' | 'CNPJ'

Tipo de documento (CPF ou CNPJ)

documentIdstring nullable

Número do documento (CPF ou CNPJ)

legalNamestring nullable

Razão social da empresa

namestring nullable

Nome fantasia da empresa

categorystring nullable

Categoria da empresa

customCategorystring nullable

Categoria personalizada da empresa

type'UNDEFINED' | 'MEI' | 'LIMITED' | 'INDIVIDUAL' | 'ASSOCIATION'

Tipo da conta

status'DEMO' | 'ONBOARDING' | 'PRODUCTION' | 'DELAYED' | 'SUSPENDED' | 'CANCELED'

Status da conta

appsstring[] nullable

Apps da conta

resourcersstring[] nullable

Recursos da conta

Response

Success

idstring uuid

Identificador único da conta

createdAtstring date-time

Data de criação da conta

updatedAtstring date-time

Data da última atualização da conta

activeboolean

Indica se a conta está ativa

legalNamestring nullable

Razão social da empresa

documentType'CPF' | 'CNPJ'

Tipo de documento (CPF ou CNPJ)

documentIdstring nullable

Número do documento (CPF ou CNPJ)

namestring nullable

Nome fantasia da empresa

partnerNamestring nullable

Nome do parceiro associado à conta

ownerIdstring uuid nullable

ID do proprietário da conta

categorystring nullable

Categoria da empresa

customCategorystring nullable

Categoria personalizada da empresa

type'UNDEFINED' | 'MEI' | 'LIMITED' | 'INDIVIDUAL' | 'ASSOCIATION'

Tipo da conta

invoiceType'HELENA' | 'DIALOG360'

Tipo de faturamento

partnerIdstring uuid nullable

ID do parceiro

pictureUrlstring nullable

URL da imagem de perfil

wppNumberstring nullable

Número de WhatsApp

phoneNumberstring nullable

Número de telefone

phoneNumberFormattedstring nullable

Número de telefone formatado

emailstring nullable

Email de contato

defaultDepartmentIdstring uuid nullable

ID da equipe padrão

setupStatus'DEMO' | 'ONBOARDING' | 'PRODUCTION' | 'DELAYED' | 'SUSPENDED' | 'CANCELED'

Status de configuração da conta