Listar todos agendamentos

Time	Status	User Agent
Retrieving recent requests…

Raiz

Propriedade	Tipo	Descrição
items	array	Lista de agendamentos
count	number	Total de agendamentos retornadas na consulta

items[]

Propriedade	Tipo	Descrição
scheduleId	string	Identificador único do agendamento
type	string	Tipo do agendamento (Credit ou Debit)
isDebitNote	boolean	Indica se o agendamento é uma nota de débito
isFlagged	boolean	Indica se o agendamento está marcado como favorito
isDued	boolean	Indica se o agendamento está vencido
dueDate	string	Data de vencimento do agendamentos
accrualDate	string	Data de competência
scheduleDate	string	Data da previsão para o recebimento "Previsto para"
createDate	string	Data e hora de criação do agendamento
createUser	string	Nome do usuário que criou o agendamento
updateDate	string	Data e hora da última atualização.
updateUser	string	Nome do usuário que realizou a última atualização
DeleteDate	string	Data de exclusão
DeleteUser	string	Nome do usuário que excluiu o agendamento
value	number	Valor total do agendamento
isPaid	boolean	Indica se o agendamento foi totalmente pago
costCenterValueType	number	Define o modo de cálculo utilizado no rateio dos centros de custo do agendamento. Indica se os valores em costcenters[] foram definidos por valor fixo ou por percentual
paidValue	number	Valor já pago
openValue	number	Valor ainda em aberto
stakeholder	object	Contato associado ao agendamento
description	string	Descrição do agendamento
reference	string	Referência do agendamento
categories	array	Rateio por categorias
costCenters	array	Rateio por categorias
hasInstallment	boolean	Indica se o agendamento faz parte de um parcelamento
installmentId	string	Identificador do parcelamento
hasRecurrence	boolean	Indica se o agendamento faz parte de uma recorrência
recurrence	object	Dados da recorrência, se houver
serviceProvisionLocationType	number	Local de prestação do serviço para fins de emissão de NFS-e. Utilizado apenas quando o agendamento possui automação de nota fiscal configurada
autoGenerateNFSeType	number	Define o gatilho de emissão automática de NFS-e vinculada ao agendamento. Quando 0, a emissão automática não está configurada
collectionId	string	Identificador da cobrança vinculada
autoGenerateCollectionType	number	Define o gatilho de geração automática de cobrança (boleto) vinculada ao agendamento. Quando 0, a geração automática não está configurada
collectionStatus	object	Status atual da cobrança
collectionProfileId	string	Identificador do perfil de cobrança.
isPaymentScheduled	boolean	Indica se há um agendamento programado no banco

serviceProvisionLocationType - Local de prestação do serviço para fins de emissão de NFS-e. Utilizado apenas quando o agendamento possui automação de nota fiscal configurada.
Valores possíveis:

Code	Descrição
0	Não definido
1	Prestação no endereço do prestador de serviço (empresa emissora)
2	Prestação no endereço do tomador de serviço (cliente)
3	Prestação em outro endereço

autoGenerateNFSeType - Define o gatilho de emissão automática de NFS-e vinculada ao agendamento. Quando 0, a emissão automática não está configurada. Valores possíveis:

Code	Descrição
0	Emissão automática não configurada
1	Emitir quando o agendamento for finalizado
2	Emitir X dias antes do vencimento
3	Emitir quando a baixa for realizada
4	Emitir quando a cobrança for criada
5	Emitir imediatamente
6	Emitir imediatamente via emissão em lote

costCenterValueType - Define o modo de cálculo do rateio de centro de custo — por valor fixo ou por percentual. Valores possíveis:

Code	Descrição
0	O rateio do centro de custo é definido por um valor fixo
1	O rateio do centro de custo é definido por um percentual do valor total do agendamento

items[].recurrence

Propriedade	Tipo	Descrição
id	string	Identificador da recorrência
interval	number	Intervalo numérico entre as ocorrências
intervalType	number	Tipo do intervalo (0 diário, 1 semanal, 2 mensal, 3 anual)
intervalTypeDescription	string	Descriçao do intervalo
endType	number	Define o tempo fim da recorrência. 0 = indeterminado, 1 = por ocorrência, 2 = por data.
endTypeDescription	string	Descrição do tempo fim da recorrência.
endDate	string	Data final da recorrência, se houver.
maxOccurrences	number	Quantidade máxima da recorrência.

items[].collectionStatus- Status atual da cobrança no ciclo de vida de emissão e pagamento

Propriedade	Tipo	Descrição
code	number	Código numérico do status da cobrança
description	string	Descrição textual do status

Valores dos status possíveis:

Code	Descrição	Significado
0	Em fila de geração	A cobrança foi criada e está aguardando o processamento para geração do boleto
1	Ativação pendente	O boleto foi gerado e está aguardando confirmação de registro no banco
2	Ativa	O boleto foi registrado com sucesso e está disponível para pagamento
3	Paga	A cobrança foi paga pelo devedor
-1	Cancelada	A cobrança foi cancelada
-2	Expirada	A cobrança venceu sem pagamento e o boleto foi fechado pelo banco

autoGenerateCollectionType - Valores possiveis

Code	Descrição
0	Geração automática de cobrança não configurada
1	Gerar cobrança quando o agendamento for finalizado
2	Gerar cobrança X dias antes do vencimento
3	Gerar cobrança imediatamente
4	Gerar cobrança imediatamente via emissão em lote
-1	Falha na geração automática da cobrança

items[].stakeholder - Valores possíveis

Propriedade	Tipo	Descrição
id	string	Código numérico do status da cobrança
name	string	Descrição textual do status
cpfCnpj	string	CPF ou CNPJ do contato
type	string	Tipo do contato: Customer,(Cliente) Supplier(Fornecedor), Partner(Parceiro) ou Employee(Funcionário)
isDeleted	boolean	Indica se o contato foi excluído

items[].categories[]- Rateio por categorias

Propriedade	Tipo	Descrição
id	string	Identificador do rateio de categoria
categoryId	string	Identificador da categoria
categoryName	string	Nome da categoria
value	number	Valor atribuído a esta categoria no rateio
description	string	Descrição do item de rateio.
type	string	Tipo da categoria: in para receita ou out para despesa
parent	string	Nome do grupo pai da categoria
parentId	string	Identificador do grupo pai da categoria

items[].costCenters[] — Rateio por centros de custo

Propriedade	Tipo	Descrição
costCenterId	string	Identificador do centro de custo
costCenterDescription	string	Nome do centro de custo
percent	number	Percentual do valor total do agendamento atribuído a este centro de custo
value	number	Valor calculado para este centro de custo com base no percentual

200200

500500