Sign in
latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Clientes

Criar cliente

Cria um novo cliente na sua organização.

  • Para vincular todas as mesas em um cliente durante a sua criação, você pode informar o atributo add_all_desks como true no body dessa requisição.
  • Para vincular todos os grupos técnicos em um cliente durante a sua criação, você pode informar o atributo add_all_technical_groups como true no body dessa requisição.
post/clients

Request body

namestring required

Nome do cliente

socialstring required

Razão social

social_revenuestring

CPF/CNPJ

desk_idsinteger[]

IDs das mesas que serão relacionadas nesse cliente

add_all_desksboolean

Vincular todas as mesas no cliente durante a sua criação

technical_group_idsinteger[]

IDs dos grupos técnicos que serão relacionados nesse cliente

add_all_technical_groupsboolean

Vincular todas os grupos técnicos no cliente durante a sua criação

statusboolean

Cliente ativo?

max_agentsinteger

Configuração de número máximo de agentes

email_financialstring

E-mail principal de envio de faturamento

sms_financialstring

Número de telefone. Para envio de SMS para integrações de faturamento

municipal_registrationstring

Inscrição municipal

estadual_registrationstring

Inscrição estadual

anotationsstring

Campo de anotações do cadastro do cliente

visible_to_clientsboolean

Visível para clientes

work_folderstring

Pasta de trabalho

quarterly_billingboolean

Faturamento quarteirizado?

quarterly_bill_client_idinteger

Faturar em nome do cliente com esse ID

billing_report_type'detailed_with_appointment' | 'detailed' | 'synthetic' | ''

Relatório de fechamento do faturamento, pode ser 3 valores

authorization_flowboolean

Se o fluxo de autorização para novos tickets está ativo ou não no cliente

Response

Cliente criado com sucesso

idinteger

ID do cliente

address_idsinteger[]

ID dos endereços cadastrados no cliente

anotationsstring nullable

Campo de anotações do cadastro do cliente

authorization_flowboolean

Se o fluxo de autorização para novos tickets está ativo ou não no cliente

billing_report_type'detailed_with_appointment' | 'detailed' | 'synthetic' | ''

Relatório de fechamento do faturamento, pode ser 3 valores

contact_idsinteger[]

ID dos contatos cadastrados no cliente

desk_idsinteger[]

ID das mesas vinculadas no cliente

email_financialstring

E-mail principal de envio de faturamento

equipment_counterinteger

Contagem de quantos equipamentos tem cadastrados no cliente

estadual_registrationstring nullable

Inscrição estadual

form_of_payment'BOLETO' | 'CREDIT_CARD' | 'UNDEFINED' | 'PIX'

Tipo de pagamento definido para integrações de faturamento

group_counterinteger

Contagem de quantos grupos de recursos tem cadastrados no cliente

logostring nullable

URL de acesso para a imagem definida de logo do cliente

max_agentsinteger

Máximo de agentes definidos no cliente

municipal_registrationstring nullable

Inscrição municipal

namestring

Nome do cliente

quarterly_bill_client_idinteger nullable

Faturar em nome do cliente com esse ID

quarterly_billingboolean

Faturamento quarteirizado ativo?

sms_financialstring nullable

Envio de SMS para integrações de faturamento

socialstring

Razão social

social_revenuestring nullable

CPF/CNPJ

statusboolean

Cliente ativo?

technical_group_idsinteger[]

ID dos grupos técnicos vinculados no cliente

user_counterinteger

Contagem de quantos usuários clientes tem cadastrados/vinculados no cliente

user_idsinteger[]

ID dos usuários clientes vinculados no cliente

work_folderstring nullable

Pasta de trabalho