Clientes

Download schema

Devedores (pessoa física ou jurídica) cadastrados na sua conta. Um cliente precisa existir antes de qualquer dívida ser criada para ele.

Listar clientes

GET

https://app.quyta.com.br/api/v1

/customers

Retorna uma lista paginada de clientes.

Listar clientes › query Parameters

document

string

Filtrar por documento

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar clientes › Responses

Lista de clientes

Customer[]

Dados do item.

object

Metadados da paginacao.

Criar cliente

POST

https://app.quyta.com.br/api/v1

/customers

Cria um novo cliente

Criar cliente › Request Body

name

string · maxLength: 255 · required

Nome do registro.

document

string · required

Documento (CPF/CNPJ).

addr_zipcode

string · pattern: ^[0-9]{8}$ · required

CEP do endereco.

addr_street

string · maxLength: 255 · required

Logradouro do endereco.

addr_number

string · maxLength: 20 · required

Numero do endereco.

addr_district

string · maxLength: 255 · required

Bairro do endereco.

addr_city

string · maxLength: 255 · required

Cidade do endereco.

addr_state

string · maxLength: 255 · required

Estado do endereco.

emails

string[] · minItems: 1 · required

Lista de emails.

phones

string[] · minItems: 1 · required

Lista de telefones.

addr_extra

string · maxLength: 255

Complemento do endereco.

Criar cliente › Responses

Cliente criado com sucesso

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

POST/customers

curl https://app.quyta.com.br/api/v1/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "John Doe",
  "document": "12345678909",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45",
  "emails": [
    "john.doe@domain.com",
    "mary.doe@domain.com"
  ],
  "phones": [
    "+5511999999999",
    "+5511988888888"
  ]
}'

Example Request Body

{
  "name": "John Doe",
  "document": "12345678909",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45",
  "emails": [
    "john.doe@domain.com",
    "mary.doe@domain.com"
  ],
  "phones": [
    "+5511999999999",
    "+5511988888888"
  ]
}

json

Example Responses

{
  "id": 1,
  "business_unit_id": 1,
  "name": "John Doe",
  "document": "12345678909",
  "person_type": "F",
  "emails": [
    {
      "id": 1,
      "email": "john.doe@domain.com"
    }
  ],
  "phones": [
    {
      "id": 1,
      "phone": "5511999999999"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Obter cliente

GET

https://app.quyta.com.br/api/v1

/customers/{id}

Retorna os detalhes de um cliente específico

Obter cliente › path Parameters

id

integer · required

ID do cliente

Obter cliente › Responses

Detalhes do cliente

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

Atualizar cliente

PUT

https://app.quyta.com.br/api/v1

/customers/{id}

Atualiza os dados de um cliente existente

Atualizar cliente › path Parameters

id

integer · required

ID do cliente

Atualizar cliente › Request Body

name

string · maxLength: 255 · required

Nome do registro.

addr_zipcode

string · pattern: ^[0-9]{8}$ · required

CEP do endereco.

addr_street

string · maxLength: 255 · required

Logradouro do endereco.

addr_number

string · maxLength: 20 · required

Numero do endereco.

addr_district

string · maxLength: 255 · required

Bairro do endereco.

addr_city

string · maxLength: 255 · required

Cidade do endereco.

addr_state

string · maxLength: 255 · required

Estado do endereco.

addr_extra

string · maxLength: 255

Complemento do endereco.

Atualizar cliente › Responses

Cliente atualizado com sucesso

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

PUT/customers/{id}

curl https://app.quyta.com.br/api/v1/customers/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "John Doe",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45"
}'

Example Request Body

{
  "name": "John Doe",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45"
}

json

Example Responses

{
  "id": 1,
  "business_unit_id": 1,
  "name": "John Doe",
  "document": "12345678909",
  "person_type": "F",
  "emails": [
    {
      "id": 1,
      "email": "john.doe@domain.com"
    }
  ],
  "phones": [
    {
      "id": 1,
      "phone": "5511999999999"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Listar dívidas do cliente

GET

https://app.quyta.com.br/api/v1

/customers/{id}/debts

Retorna uma lista paginada das dívidas de um cliente específico. Equivale a GET /debts?customer_id={id}, mas retorna 404 quando o cliente não existe.

Listar dívidas do cliente › path Parameters

id

integer · required

ID do cliente

Listar dívidas do cliente › query Parameters

status

string

Filtrar por status. Aceita múltiplos valores separados por vírgula (PENDING, SETTLED, ON_HOLD, ARCHIVED, UNDER_CONTRACT).

external_id

string

Filtrar por external_id

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar dívidas do cliente › Responses

Lista de dívidas do cliente

Debt[]

Dados do item.

object

Metadados da paginacao.

GET/customers/{id}/debts

curl https://app.quyta.com.br/api/v1/customers/:id/debts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "customer_id": 1,
      "debt_group_id": 1,
      "business_unit_id": 1,
      "status": "PENDING",
      "is_collectable": true,
      "is_contractable": true,
      "original_value": 1000,
      "today_value": 1100,
      "due_date": "2026-01-15",
      "origin_date": "2025-12-01",
      "external_id": "EXT123",
      "origin_contract_id": "767",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "per_page": 0,
    "current_page": 0,
    "total_pages": 0
  }
}

json

application/json

Adicionar telefones ao cliente

POST

https://app.quyta.com.br/api/v1

/customers/{id}/phones

Adiciona um ou mais telefones ao cliente

Adicionar telefones ao cliente › path Parameters

id

integer · required

ID do cliente

Adicionar telefones ao cliente › Request Body

phones

string[] · minItems: 1 · required

Lista de telefones.

Adicionar telefones ao cliente › Responses

Telefones adicionados com sucesso. Sem corpo na resposta.

No data returned

Remover telefone do cliente

DELETE

https://app.quyta.com.br/api/v1

/customers/phones/{phoneId}

Remove um telefone de um cliente

Remover telefone do cliente › path Parameters

phoneId

integer · required

ID do telefone

Remover telefone do cliente › Responses

Telefone removido com sucesso. Sem corpo na resposta.

No data returned

Adicionar emails ao cliente

POST

https://app.quyta.com.br/api/v1

/customers/{id}/emails

Adiciona um ou mais emails ao cliente

Adicionar emails ao cliente › path Parameters

id

integer · required

ID do cliente

Adicionar emails ao cliente › Request Body

emails

string[] · minItems: 1 · required

Lista de emails.

Adicionar emails ao cliente › Responses

Emails adicionados com sucesso. Sem corpo na resposta.

No data returned

Remover email do cliente

DELETE

https://app.quyta.com.br/api/v1

/customers/emails/{emailId}

Remove um email de um cliente

Remover email do cliente › path Parameters

emailId

integer · required

ID do email

Remover email do cliente › Responses

Email removido com sucesso. Sem corpo na resposta.

No data returned

Grupos de Dívidas

Quyta

Clientes

Download schema

Devedores (pessoa física ou jurídica) cadastrados na sua conta. Um cliente precisa existir antes de qualquer dívida ser criada para ele.

Listar clientes

GET

https://app.quyta.com.br/api/v1

/customers

Retorna uma lista paginada de clientes.

Listar clientes › query Parameters

document

string

Filtrar por documento

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar clientes › Responses

Lista de clientes

Customer[]

Dados do item.

object

Metadados da paginacao.

Criar cliente

POST

https://app.quyta.com.br/api/v1

/customers

Cria um novo cliente

Criar cliente › Request Body

name

string · maxLength: 255 · required

Nome do registro.

document

string · required

Documento (CPF/CNPJ).

addr_zipcode

string · pattern: ^[0-9]{8}$ · required

CEP do endereco.

addr_street

string · maxLength: 255 · required

Logradouro do endereco.

addr_number

string · maxLength: 20 · required

Numero do endereco.

addr_district

string · maxLength: 255 · required

Bairro do endereco.

addr_city

string · maxLength: 255 · required

Cidade do endereco.

addr_state

string · maxLength: 255 · required

Estado do endereco.

emails

string[] · minItems: 1 · required

Lista de emails.

phones

string[] · minItems: 1 · required

Lista de telefones.

addr_extra

string · maxLength: 255

Complemento do endereco.

Criar cliente › Responses

Cliente criado com sucesso

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

POST/customers

curl https://app.quyta.com.br/api/v1/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "John Doe",
  "document": "12345678909",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45",
  "emails": [
    "john.doe@domain.com",
    "mary.doe@domain.com"
  ],
  "phones": [
    "+5511999999999",
    "+5511988888888"
  ]
}'

Example Request Body

{
  "name": "John Doe",
  "document": "12345678909",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45",
  "emails": [
    "john.doe@domain.com",
    "mary.doe@domain.com"
  ],
  "phones": [
    "+5511999999999",
    "+5511988888888"
  ]
}

json

Example Responses

{
  "id": 1,
  "business_unit_id": 1,
  "name": "John Doe",
  "document": "12345678909",
  "person_type": "F",
  "emails": [
    {
      "id": 1,
      "email": "john.doe@domain.com"
    }
  ],
  "phones": [
    {
      "id": 1,
      "phone": "5511999999999"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Obter cliente

GET

https://app.quyta.com.br/api/v1

/customers/{id}

Retorna os detalhes de um cliente específico

Obter cliente › path Parameters

id

integer · required

ID do cliente

Obter cliente › Responses

Detalhes do cliente

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

Atualizar cliente

PUT

https://app.quyta.com.br/api/v1

/customers/{id}

Atualiza os dados de um cliente existente

Atualizar cliente › path Parameters

id

integer · required

ID do cliente

Atualizar cliente › Request Body

name

string · maxLength: 255 · required

Nome do registro.

addr_zipcode

string · pattern: ^[0-9]{8}$ · required

CEP do endereco.

addr_street

string · maxLength: 255 · required

Logradouro do endereco.

addr_number

string · maxLength: 20 · required

Numero do endereco.

addr_district

string · maxLength: 255 · required

Bairro do endereco.

addr_city

string · maxLength: 255 · required

Cidade do endereco.

addr_state

string · maxLength: 255 · required

Estado do endereco.

addr_extra

string · maxLength: 255

Complemento do endereco.

Atualizar cliente › Responses

Cliente atualizado com sucesso

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

object[]

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

created_at

string · date-time

Data e hora de criacao do cliente, em UTC.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente, em UTC.

PUT/customers/{id}

curl https://app.quyta.com.br/api/v1/customers/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "John Doe",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45"
}'

Example Request Body

{
  "name": "John Doe",
  "addr_zipcode": "01234567",
  "addr_street": "Rua do John Doe",
  "addr_number": "123",
  "addr_district": "Centro",
  "addr_city": "São Paulo",
  "addr_state": "SP",
  "addr_extra": "Apto 45"
}

json

Example Responses

{
  "id": 1,
  "business_unit_id": 1,
  "name": "John Doe",
  "document": "12345678909",
  "person_type": "F",
  "emails": [
    {
      "id": 1,
      "email": "john.doe@domain.com"
    }
  ],
  "phones": [
    {
      "id": 1,
      "phone": "5511999999999"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Listar dívidas do cliente

GET

https://app.quyta.com.br/api/v1

/customers/{id}/debts

Retorna uma lista paginada das dívidas de um cliente específico. Equivale a GET /debts?customer_id={id}, mas retorna 404 quando o cliente não existe.

Listar dívidas do cliente › path Parameters

id

integer · required

ID do cliente

Listar dívidas do cliente › query Parameters

status

string

Filtrar por status. Aceita múltiplos valores separados por vírgula (PENDING, SETTLED, ON_HOLD, ARCHIVED, UNDER_CONTRACT).

external_id

string

Filtrar por external_id

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar dívidas do cliente › Responses

Lista de dívidas do cliente

Debt[]

Dados do item.

object

Metadados da paginacao.

GET/customers/{id}/debts

curl https://app.quyta.com.br/api/v1/customers/:id/debts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "customer_id": 1,
      "debt_group_id": 1,
      "business_unit_id": 1,
      "status": "PENDING",
      "is_collectable": true,
      "is_contractable": true,
      "original_value": 1000,
      "today_value": 1100,
      "due_date": "2026-01-15",
      "origin_date": "2025-12-01",
      "external_id": "EXT123",
      "origin_contract_id": "767",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "per_page": 0,
    "current_page": 0,
    "total_pages": 0
  }
}

json

application/json

Adicionar telefones ao cliente

POST

https://app.quyta.com.br/api/v1

/customers/{id}/phones

Adiciona um ou mais telefones ao cliente

Adicionar telefones ao cliente › path Parameters

id

integer · required

ID do cliente

Adicionar telefones ao cliente › Request Body

phones

string[] · minItems: 1 · required

Lista de telefones.

Adicionar telefones ao cliente › Responses

Telefones adicionados com sucesso. Sem corpo na resposta.

No data returned

Remover telefone do cliente

DELETE

https://app.quyta.com.br/api/v1

/customers/phones/{phoneId}

Remove um telefone de um cliente

Remover telefone do cliente › path Parameters

phoneId

integer · required

ID do telefone

Remover telefone do cliente › Responses

Telefone removido com sucesso. Sem corpo na resposta.

No data returned

Adicionar emails ao cliente

POST

https://app.quyta.com.br/api/v1

/customers/{id}/emails

Adiciona um ou mais emails ao cliente

Adicionar emails ao cliente › path Parameters

id

integer · required

ID do cliente

Adicionar emails ao cliente › Request Body

emails

string[] · minItems: 1 · required

Lista de emails.

Adicionar emails ao cliente › Responses

Emails adicionados com sucesso. Sem corpo na resposta.

No data returned

Remover email do cliente

DELETE

https://app.quyta.com.br/api/v1

/customers/emails/{emailId}

Remove um email de um cliente

Remover email do cliente › path Parameters

emailId

integer · required

ID do email

Remover email do cliente › Responses

Email removido com sucesso. Sem corpo na resposta.

No data returned

Grupos de Dívidas