Schemas

Error

success

boolean

message

string

WorkspaceExcedentesResumo

workspaceId

string · uuid

anoMes

string

notasPlano

integer | null

notasUsadas

integer

excedentesNotas

integer

valorUnitarioNotas

string | null

Preço unitário de excedente de NFS-e (decimal serializado como string)

Example: 0.75

totalNotas

string

Total em excedentes de NFS-e (decimal serializado como string)

Example: 7.50

empresasPlano

integer | null

empresasUsadas

integer

excedentesEmpresas

integer

valorUnitarioEmpresas

string | null

Preço unitário de excedente de empresa (decimal como string)

Example: 10.00

totalEmpresas

string

Total em excedentes de empresas (decimal como string)

Example: 10.00

usuariosPlano

integer | null

usuariosUsados

integer

excedentesUsuarios

integer

valorUnitarioUsuarios

string | null

Preço unitário de excedente de usuário (decimal como string)

Example: 5.00

totalUsuarios

string

Total em excedentes de usuários (decimal como string)

Example: 5.00

valorTotal

string

Soma de todos os excedentes (decimal como string)

Example: 22.50

WorkspaceExcedentesCobranca

id

string · uuid

workspaceId

string · uuid

anoMes

string

notasPlano

integer | null

notasUsadas

integer

excedentesNotas

integer

valorUnitarioNotas

string | null

Preço unitário de excedente de NFS-e (decimal como string)

totalNotas

string

Total em excedentes de NFS-e (decimal como string)

empresasPlano

integer | null

empresasUsadas

integer

empresasExcedentes

integer

empresasValorUnitario

string | null

Preço unitário de excedente de empresa (decimal como string)

usuariosPlano

integer | null

usuariosUsados

integer

usuariosExcedentes

integer

usuariosValorUnitario

string | null

Preço unitário de excedente de usuário (decimal como string)

asaasPaymentId

string | null

status

string

dueDate

string | null · date-time

paidAt

string | null · date-time

criadoEm

string · date-time

Plano

codigo

string

nome

string

precoMensal

string

Decimal serializado como string

Example: 74.90

notasPorMes

integer | null

maxEmpresas

integer | null

maxUsuarios

integer | null

permiteRecorrencia

boolean

acessoContador

boolean

suporteNivel

string

a1DescontoPercentual

integer | null

a1GratisNaAnuidade

boolean

valorUnitarioExcedenteNotas

string | null

Preço unitário de excedente de NFS-e para este plano (precoMensal/notasPorMes/2), decimal como string

Example: 0,75

valorUnitarioExcedenteEmpresas

string | null

Preço unitário de excedente de empresa para este plano (precoMensal/maxEmpresas/2), decimal como string

Example: 10,00

valorUnitarioExcedenteUsuarios

string | null

Preço unitário de excedente de usuário para este plano (precoMensal/maxUsuarios/2), decimal como string

Example: 5,00

WorkspaceAssinaturaCobranca

asaasPaymentId

string

status

string

valor

string

Decimal serializado como string

Example: 74.90

dueDate

string · date

paidAt

string | null · date-time

invoiceUrl

string | null

boletoUrl

string | null

pixQrCode

string | null

WorkspaceAssinatura

id

string · uuid

workspaceId

string · uuid

status

string

billingType

string | null

nextDueDate

string | null · date-time

currentPeriodStart

string | null · date-time

currentPeriodEnd

string | null · date-time

asaasCustomerId

string | null

asaasSubscriptionId

string | null

cancelamentoMotivo

string | null

canceladoEm

string | null · date-time

object

AssinaturaAtualResponse

object

assinaturaLiberada

boolean

Indica se o workspace deve ser considerado com acesso liberado (com base no status da última cobrança/pagamento).

Example: false

object

Uso atual e quanto falta para atingir os limites do plano do workspace.

CheckoutCartaoRequest

planoCodigo

string · required

object · required

TrocarPlanoRequest

planoCodigo

string · required

AsaasWebhookResponse

id

string

duplicated

boolean

Usuario

id

string · uuid

email

string · email

nome

string

empresaId

string · uuid

Empresa

id

string · uuid

cnpj

string

razaoSocial

string

nomeFantasia

string

inscricaoMunicipal

string

cep

string

logradouro

string

numero

string

bairro

string

nomeMunicipio

string

uf

string · maxLength: 2

telefone

string

email

string · email

optanteSimplesNacional

boolean

Tomador

id

string · uuid

cpfCnpj

string

nome

string

nomeFantasia

string

cep

string

logradouro

string

numero

string

bairro

string

nomeMunicipio

string

uf

string

telefone

string

email

string · email

Servico

codigo

string

descricao

string

regraIncidencia

string · enum

Enum values:

aliquotaPadrao

number

Nfse

id

string · uuid

serie

string

numero

integer

chaveAcesso

string

numeroNfse

string

dataEmissao

string · date-time

dataCompetencia

string · date

valorServico

number

valorDeducoes

number

valorDesconto

number

baseCalculo

number

aliquotaIss

number

valorIss

number

descricaoServico

string

status

string · enum

Enum values:

PENDENTE

AUTORIZADA

REJEITADA

CANCELADA

EmitirNfseInput

tomadorId

string · uuid · required

servicoCodigo

string · required

valorServico

number · required

descricaoServico

string · required

dataCompetencia

string · date · required

ambiente

string · enum

Ambiente de emissão (homologacao ou producao)

Enum values:

homologacao

producao

Default: homologacao

codigoNbs

string

Código NBS (9 dígitos) - se não informado, usa o cadastrado no serviço

Example: 123456789

deducoes

number

Valor das deduções

descontoIncondicionado

number

Desconto incondicionado

descontoCondicionado

number

Desconto condicionado

retencaoIssqn

boolean

Se há retenção de ISSQN

aliquotaIss

number

Alíquota do ISS (%). Obrigatória para Simples Nacional com retenção (mín: 2%)

Example: 5

observacoes

string

Observações adicionais na nota

object

Dados de obra (obrigatório para serviços do grupo 07 - construção civil)

WorkspaceExcedentesResumo

workspaceId

string · uuid

anoMes

string

notasPlano

integer | null

notasUsadas

integer

excedentesNotas

integer

valorUnitarioNotas

string | null

Preço unitário de excedente de NFS-e (decimal serializado como string)

Example: 0.75

totalNotas

string

Total em excedentes de NFS-e (decimal serializado como string)

Example: 7.50

empresasPlano

integer | null

empresasUsadas

integer

excedentesEmpresas

integer

valorUnitarioEmpresas

string | null

Preço unitário de excedente de empresa (decimal como string)

Example: 10.00

totalEmpresas

string

Total em excedentes de empresas (decimal como string)

Example: 10.00

usuariosPlano

integer | null

usuariosUsados

integer

excedentesUsuarios

integer

valorUnitarioUsuarios

string | null

Preço unitário de excedente de usuário (decimal como string)

Example: 5.00

totalUsuarios

string

Total em excedentes de usuários (decimal como string)

Example: 5.00

valorTotal

string

Soma de todos os excedentes (decimal como string)

Example: 22.50

WorkspaceExcedentesCobranca

id

string · uuid

workspaceId

string · uuid

anoMes

string

notasPlano

integer | null

notasUsadas

integer

excedentesNotas

integer

valorUnitarioNotas

string | null

Preço unitário de excedente de NFS-e (decimal como string)

totalNotas

string

Total em excedentes de NFS-e (decimal como string)

empresasPlano

integer | null

empresasUsadas

integer

empresasExcedentes

integer

empresasValorUnitario

string | null

Preço unitário de excedente de empresa (decimal como string)

usuariosPlano

integer | null

usuariosUsados

integer

usuariosExcedentes

integer

usuariosValorUnitario

string | null

Preço unitário de excedente de usuário (decimal como string)

asaasPaymentId

string | null

status

string

dueDate

string | null · date-time

paidAt

string | null · date-time

criadoEm

string · date-time

Plano

codigo

string

nome

string

precoMensal

string

Decimal serializado como string

Example: 74.90

notasPorMes

integer | null

maxEmpresas

integer | null

maxUsuarios

integer | null

permiteRecorrencia

boolean

acessoContador

boolean

suporteNivel

string

a1DescontoPercentual

integer | null

a1GratisNaAnuidade

boolean

valorUnitarioExcedenteNotas

string | null

Preço unitário de excedente de NFS-e para este plano (precoMensal/notasPorMes/2), decimal como string

Example: 0,75

valorUnitarioExcedenteEmpresas

string | null

Preço unitário de excedente de empresa para este plano (precoMensal/maxEmpresas/2), decimal como string

Example: 10,00

valorUnitarioExcedenteUsuarios

string | null

Preço unitário de excedente de usuário para este plano (precoMensal/maxUsuarios/2), decimal como string

Example: 5,00

WorkspaceAssinatura

id

string · uuid

workspaceId

string · uuid

status

string

billingType

string | null

nextDueDate

string | null · date-time

currentPeriodStart

string | null · date-time

currentPeriodEnd

string | null · date-time

asaasCustomerId

string | null

asaasSubscriptionId

string | null

cancelamentoMotivo

string | null

canceladoEm

string | null · date-time

object

Nfse

id

string · uuid

serie

string

numero

integer

chaveAcesso

string

numeroNfse

string

dataEmissao

string · date-time

dataCompetencia

string · date

valorServico

number

valorDeducoes

number

valorDesconto

number

baseCalculo

number

aliquotaIss

number

valorIss

number

descricaoServico

string

status

string · enum

Enum values:

PENDENTE

AUTORIZADA

REJEITADA

CANCELADA

EmitirNfseInput

tomadorId

string · uuid · required

servicoCodigo

string · required

valorServico

number · required

descricaoServico

string · required

dataCompetencia

string · date · required

ambiente

string · enum

Ambiente de emissão (homologacao ou producao)

Enum values:

homologacao

producao

Default: homologacao

codigoNbs

string

Código NBS (9 dígitos) - se não informado, usa o cadastrado no serviço

Example: 123456789

deducoes

number

Valor das deduções

descontoIncondicionado

number

Desconto incondicionado

descontoCondicionado

number

Desconto condicionado

retencaoIssqn

boolean

Se há retenção de ISSQN

aliquotaIss

number

Alíquota do ISS (%). Obrigatória para Simples Nacional com retenção (mín: 2%)

Example: 5

observacoes

string

Observações adicionais na nota

object

Dados de obra (obrigatório para serviços do grupo 07 - construção civil)