Financeiro / Lançamentos / Documento Receitas

Retorna todos os lançamentos Receita

Query strings

Query StringFinalidade
offsetdeslocamento, salta a quantidade de registros informada
limitquantidade de registros retornados
orderordenação ascendente ou descendente
FieldTypeField Name correspondingDescriptionReturn Type
records>bills>billets
accountIdIntegerID da contaRetorna o ID do registro da conta do boleto.null ou integer
billetIntegerNúmero do boletoRetorna o número do boleto.null ou integer
billetIdIntegerID do boletoRetorna o ID do boleto.null ou integer
billetValueDecimalValor do boletoRetorna o valor do boleto.null ou decimal
createdDateDatetimeData e hora de criaçãoRetorna data e hora da criação do boleto. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
descriptionStringDescriçãoRetorna a descrição do boleto.null ou string
finBillIdIntegerReferência no financeiroRetorna o ID do documento de referência no financeiro.null ou integer
fineForDelayDecimalMultas e taxasRetorna valor de multas ou taxas.null ou decimal
instructionsStringInstruções de pagamentoRetornas as instruções para pagamento do boleto.null ou string
latePaymentInterestDecimalMulta por atrasoRetorna o valor da multa por atraso de pagamentonull ou decimal
remittanceIdIntegerID da remessaRetorna o ID da remessa do boleto.null ou integer
situationEnumStatus/SituaçãoRetorna a situação/status do documento.null ou [' ', 'active', 'settled', 'removed']
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
urlStringUrl do boletoRetorna a URL do boletonull ou datetime
records>bills>finAccounts
accountNameStringContaRetorna o nome da conta bancaria cadastrada documento.Traz o nome da conta vinculada como padrão
actualSituationEnumStatus/SituaçãoRetorna a situação/status da conta.retorna 'active' ou 'disabled'
bankIdIntegerID de cadastro do bancoRetorna o ID de cadastro do banco no sistema.retorna integer
companyIdIntegerID da empresaRetorna o ID da empresa.retorna por padrão '0' ou id da empresa
createdDateDatetimeData e hora de criaçãoRetorna data e hora de criação do cadastro do banco no documento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
extraObject (JSON)Informações de conta"Retorna um json com as informações da conta: agency, account, operation, station ,sysBankId, bankCode, bankName."Object (JSON)
Estrutura Objeto extra
agencyStringAgênciaRetorna o número da agência bancáriastring vazia ou número
accountStringContaRetorna o número da conta bancáriastring vazia ou número
operationStringOperaçãoRetorna o tipo de operaçãostring vazia ou tipo da operação
stationIntegerPresente apenas quando os bancos são sicredi e sicoobPresente apenas quando os bancos são sicredi e sicoobstring vazia ou integer
sysBankIdIntegerID de cadastro do bancoRetorno o ID de cadastro do banco no sistema.string vazia ou integer
bankCodeIntegerCódigo do banco no COMPERetorna o código de cadastro do banco Sistema de Operações Monetárias e Compensação de Outros Papéis.string vazia ou integer
bankNameStringNome do bancoRetorna o nome do bancostring vazia ou nome do banco
finAccountIdIntegerPosição de cadastroRetorna a posição do banco na lista de bancos cadastradosstring vazia ou integer
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e hora da última alteração na conta. Formatos: YYYY-MM-DD HH:MM:SS.string vazia ou datetime
records>bills>finBills
accrualDateDatetimeCompetênciaRetorna a data e hora de competencia da fatura. Formatos: YYYY-MM-DD HH:MM:SS.datetime
attachmentsArray of Object(s)AnexosRetorna um array de um ou mais objetos, contendo dados sobre o(s) anexosnull ou array de objeto(s)
billNumberIntegerParcelaRetorna o número correspondente da parcela.integer
billQuantityIntegerParcelaRetorna o número total de parcelas.integer
billTitleStringTítuloRetorna o título do documento.string
billTypeEnumTipo de clienteInforma o tipo de cliente.'client','provider','supplier','vehicle','employee','transfer','balance'
companyIdIntegerID da EmpresaRetorna o ID de cadastro da empresa.integer
createdDateDatetimeData e hora de criaçãoRetorna data e hora da criação do documento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
discountValueDecimalDescontoRetorna o valor de desconto da fatura.decimal
documentNumberStringN° Documento ou NFRetorna o número do documento ou da Nota Fiscal.string vazia ou número do codumento
dueDateDatetimeVencimentoRetorna a data e hora de vencimento da fatura. Formatos: YYYY-MM-DD HH:MM:SS.datetime
entPersonIdBigintID cadastroRetorna o ID de cadastro.bigint
finAccountIdIntegerID da contaRetorna o ID da conta bancária do documento.integer
finBillGroupIdBigintReceber do clienteRetorna o ID do documentobigint
finBillIdIntegerNúmero do documentoRetorna o número do documento.integer
finCategoryIdIntegerID da categoriaRetorna o ID da categoria.integer
finCostCenterIdIntegerID do Centro de CustoRetorna o ID do Centro de Custo.integer
finPaymentMethodIdIntegerID do Método de PagamentoRetorna o ID do Método de Pagamento.integer
hasBillingTinyintVerifica se há faturamentoRetorna código indicando se há faturamento.tinyint
increaseValueDecimalAcréscimoRetorna o valor de acréscimo no valor da fatura.decimal
orderNumberStringNúmero da ordemRetorna o número da ordemstring vazia ou número da ordem
paymentConditionEnumCondição de PagamentoRetorna a condição de pagamento.'unique','installment','weekly','biweekly','monthly','trimonthly','semiannually','annually'
paymentDateDatetimeData de PagamentoRetorna data e hora do pagamento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
positiveValueTinyintValor PositivoValor Positivotinyint
referrerClientIdBigintID do cliente de referênciaRetorna o ID do cliente de referência.bigint
relatedDocStringTipo de relacionamentoRetorna o tipo do relacionamento.
relatedDocumentsArrayTipo e ID do relacionamentoRetorna array com o tipo do relacionamento e seu respectivo IDArray pode conter uma chave vazia(branco), ou o tipo do relacionamento 'relatedDoc:docid'
situationEnumStatus/SituaçãoRetorna a situação/status do documento.'active' ou 'disabled'
statusIdIntegerID Status/SituaçãoRetorna o ID do situação/status do documento.integer
totalValueDecimalValor TotalRetorna o valor total do documento.decimal
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS.datime time
userIdIntegerID do usuárioRetorna o ID do usuário que criou o documento.integer
valueDecimalValor sem acréscimo ou descontoRetorna o valor do documento sem acréscimo ou desconto.decimal
records>bills>finCategories
actualSituationEnumStatus/SituaçãoRetorna a situação/status da categoria.'active' ou 'disabled'
categoryNameStringCategoriaRetorna o nome da categoria.string
colorStringCor do campoRetorna o código de cor do campo.string
createdDateDatetimeData e hora de criaçãoRetorna data e hora da criação do documento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
expenseBooleanValida se é receita ou despesaRetorna se o lançamento é tipo despesa'true' ou 'false'
finCategoryIdIntegerID da categoriaRetorna o ID da categoria.null ou integer
pathStringPosição da categoriaRetorna a posição hierárquica da categoria.null ou string
positionStringPosição da categoriaRetorna a posição hierárquica da categoria.null ou string
revenueBooleanValor ReceitaValor Receitanull ou 'true'
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS.datetime ou null
records>bills>finCostCenters
actualSituationEnumStatus/SituaçãoRetorna a situação/status do centro de custo.'active' ou 'disabled'
costCenterStringCentro de custoRetorna o centro de custo do documento.null ou string
createdDateDatetimeData e hora de criaçãoRetorna data e hora da criação do centro de custo. Formatos: YYYY-MM-DD HH:MM:SS.null ou string
finCostCenterIdIntegerID do centro de custoRetorna o ID do centro de custo.null ou integer
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
records>bills>finNfe
amountNetDecimalValor líquido da NFeRetorna o valor líquido da NFe.null ou decimal
batchCheckNumberIntegerNúmero do loteRetorna o número do lote da NFe.null ou integer
cityServiceCodeStringCódigo de serviço da cidadeRetorna o código de serviço da cidade.null ou string
cnaeCodeStringCódigo do CnaeRetorna o código do Cnaenull ou string
cofinsAmountWithheldDecimalValor do CofinsRetorna o valor retido de Cofinsnull ou decimal
companyIdIntegerID da empresaRetorna o ID da empresanull ou integer
createdDateDatetimeData e hora de criaçãoRetorna data e hora da criação da NFe. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
csllAmountWithheldDecimalValor do CSLLRetorna o valor do CSLL.null ou decimal
deductionsAmountDecimalValor de deduçõesRetorna o valor de deduções.null ou decimal
descriptionStrintDescriçãoRetorna a descrição.null ou string
discountConditionedAmountDecimalDesconto condicionadoRetorna o valor de desconto condicionadonull ou decimal
discountUnconditionedAmountDecimalDesconto não condicionadoRetorna o valor de desconto não condicionadonull ou decimal
docStringNúmero do documentoRetorna o Número do documentonull ou string
errorStringErrosRetorna os erros.null ou string
federalServiceCodeStringCódigo do serviço federalRetonar o código do serviço federal.null ou string
finNfeIdIntegerID da NFeRetorna o ID da NFe.null ou integer
inssAmountWithheldDecimalValor do INSSRetorna o valor de dedução referente ao INSS.null ou decimal
irAmountWithheldDecimalValor do IRRetorna o valor de dedução referente ao imposto de renda (IR).null ou decimal
issAmountWithheldDecimalValor do ISSRetorna o valor de dedução referente ao ISS.null ou decimal
issRateDecimalValor avaliação do ISSRetorna o valor avaliado referente ao ISS.null ou decimal
issTaxAmountDecimalValor imposto sobre o ISSRetorna o valor do imposto referente ao ISS.null ou decimal
issuedOnDatetimeData e hora de emissãoRetorna a data e horário de emissão da NFe. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
nfeIntegerNúmero da NFeRetorna o número da NFe.null ou integer
numberIntegerNúmero da NFeRetorna o número da NFe.null ou integer
othersAmountWithheldDecimalValor de outras deduçõesRetorna o valor referente a outras deduções.null ou decimal
pisAmountWithheldDecimalValor do PISRetorna o valor referente ao PIS.null ou decimal
rpsNumberStringNúmero do RPSRetorna o número do Recibo Provisário de Serviço (RPS).null ou string
rpsSerialNumberStringSerial do RPSRetorna o serial do Recibo Provisário de Serviço (RPS).null ou string
serviceNameEnumNome do serviçoRetorna o nome do serviçonull ou ('', 'NFeio')
situationEnumSituaçãoRetorna a situação da NFenull ou ('waiting', 'errored', 'canceled', 'issued')
taxationTypeStringTipo de taxaçãoRetorna o tipo de taxaçãonull ou string
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração na NFe. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
urlPdfStringURL do PDF da NFeRetorna a URL do PDF da Nfenull ou string
urlXmlStringURL do XML da NFeRetorna a URL do XML da Nfenull ou string
records>bills>finPaymentMethods
actualSituationEnumStatus/SituaçãoRetorna a situação/status do centro de custo.'active' ou 'disabled'
createdDateDatetimeData e hora de criaçãoRetorna a data e horário de criação da forma de pagamento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
finPaymentMethodIdIntegerID do método de pagamentoRetorna o ID do método de pagamento.integer
paymentMethodStringForma de PagamentoRetorna a forma de pagamento do documento.string
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração do método de pagamento. Formatos: YYYY-MM-DD HH:MM:SS.datetime
records>bills>finReconciliation
createdDateDatetimeData e hora de conciliaçãoRetorna a data e horário da conciliação. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
documentStringID DocumentoID Documentonull ou string
finBillIdIntegerID da faturaRetorna o ID da fatura.null ou integer
finReconciliationBatchIdIntegerID do lote de conciliaçãoRetorna o ID do lote de conciliação.null ou integer
finReconciliationIdIntegerID da conciliaçãoRetorna o ID da conciliação.null ou integer
operationDateDatetimeData e hora da operaçãoRetorna a data e horário da operação. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
situationEnumSituaçãoRetorna a situação da conciliação.null ou ( '','active','inactive','removed')
transactionStringIdentificação da transaçãoRetorna a identificação da transação.null ou string
transactionIdIntegerID da transaçãoRetorna o ID da transação.null ou integer
transactionTypeStringTipo de transaçãoRetorna o tipo de transação.null ou ('','CREDIT','DEBIT','INT','DIV','FEE','SRVCHG','DEP','ATM','POS','XFER','CHECK','PAYMENT','CASH','DIRECTDEP','DIRECTDEBIT','REPEATPMT','OTHER' )
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração da conciliação. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
valueDecimalValor da transaçãoRetorna o valor da transação.null ou decimal
records>bills>finStatus
actualSituationEnumStatus/SituaçãoRetorna a situação/status do centro de custo.'active' ou 'disabled'
colorStringCor do campoRetorna o código de cor do campo.string
createdDateDatetimeData e hora de criaçãoRetorna a data e horário de criação da fatura. Formatos: YYYY-MM-DD HH:MM:SS.datetime
denyDelayTinyintNegar atrasoNegar atrasonull ou 1 = true, 0 = false
typeDocEnumTipo de documentoRetorna o tipo de documento.null ou 'financial', 'financialExpense', 'financialRevenue'
fixedKeyStringChave fixaRetorna o valor da chave fixa.string vazia ou string
orderIntegerOrdenaçãoOrdenação do statusinteger
statusIdIntegerID do statusRetorna o ID do status.null ou integer
updatedDateDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração do status. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
orderIntegerOrdenaçãointeger
records>bills>persons
actualSituationEnumSituaçãoRetorna a situação do cadastro.'active' ou 'disabled'
addressStringLogradouroRetorna o logradouro do cadastro.string vazia ou string com dados
addressComplementStringComplementoRetorna o complemento de endereço do cadastro.string vazia ou string com dados
addressNumberStringNúmero do logradouroRetorno o número do logradouro do cadastro.string vazia ou string com dados
briefingStringResumoRetorna o resumo do cadastrostring vazia ou string com dados
cepStringCEPRetorna o CEP.string vazia ou string com dados
cityStringCidadeRetorna a cidade.string vazia ou string com dados
clientBooleanValidação do tipo de cadastroRetorna se o cadastro é de cliente.true ou false
companyBooleanValidação PJRetorna se o cadastro é de do tipo PJ.true ou false
countryStringPaísRetorna o país.string vazia ou string com dados
createdDatetimeData e hora de criaçãoRetorna a data e horário de criação do cadastro. Formatos: YYYY-MM-DD HH:MM:SS.null ou datetime
dataBankingObject (JSON)Informações do bancoRetorna um json com as informações: bank, bankAccountType, agency, account, AccountVariation, Pix, description, defaultObject (JSON)
Estrutura dataBanking
bankStringBancoRetorna o nome do bancostring vazia ou string com dados
bankAccountTypeStringTipo de contaRetorna o tipo de contastring vazia ou string com dados
agencyStringAgênciaRetorna a identificação da agênciastring vazia ou string com dados
accountStringContaRetorna a identificação da contastring vazia ou string com dados
accountVariationStringVariação / PostoRetorna a identificação da variação / posto.string vazia ou string com dados
pixArrayArray com as informações do PixRetorna a descrição e a preferência da chave pix.Array vazio ou com valores
descriptionStringDescriçãoRetorna a Descrição da cahve pix.string vazia ou string com dados
defaultTinyintPadrãoRetorna a preferência da chave pix.null ou informa o vinculo
districtStringBairroRetorna o bairro.string vazia ou string com dados
emailStringE-mailRetorna o e-mail.string vazia ou string com dados
employeeBooleanValidação se é funcionárioRetorna se o cadastro é de um funcionário.true ou false
facebookStringFacebookRetorna o perfil no Facebook.string vazia ou string com dados
idPersonIntegerID do cadastroRetorna o ID de cadastro.string vazia ou integer
localityObject (JSON)Informações do endereçoRetorna um json com as informações: cep, address, addressNumber, addressComplement, district, state, state, city, codIBGE, countryTodos os valores podem retornar string vazia ou com dados
Estrutura Locality
cepStringCEPRetorna o CEP.string vazia ou string com dados
addressStringLogradouroRetorna o logradouro do cadastro.string vazia ou string com dados
addressNumberStringNúmero do logradouroRetorno o número do logradouro do cadastro.string vazia ou string com dados
addressComplementStringComplementoRetorna o complemento de endereço do cadastro.string vazia ou string com dados
districtStringBairroRetorna o bairro.string vazia ou string com dados
stateStringUFRetorna a Unidade Federativa (UF).string vazia ou string com dados
stateStringUFRetorna a Unidade Federativa (UF).string vazia ou string com dados
cityStringCidade (Estado)Retorna a cidade e a Unidade Federativa (UF).string vazia ou string com dados
cityIntegerCódigo da cidadeRetorna o código da cidadestring vazia ou string com dados
codIBGEIntegerCódigo da cidade no IBGERetorno o código da cidade no cadastro do IBGEstring vazia ou string com dados
countryStringPaísRetorna o país.string vazia ou string com dados
municipalDocumentStringInscrição MunicipalRetorna o valor do campo Inscrição Municipalstring vazia ou string com dados
nationalDocumentStringCPF ou CNPJRetorna o valor do campo CPF ou CNPJstring vazia ou string com dados
oficialPersonStringNome Civil ou Razão SocialRetorna o nome civil ou razão social do cadastro.string vazia ou string com dados
personStringNome FantasiaRetorna o nome fantasia do cadastro.string vazia ou string com dados
phoneStringTelefone 1Retorna o número do telefone do cadastro.string vazia ou string com dados
phone2StringTelefone 2Retorna o número do telefone do cadastro.string vazia ou string com dados
providerTinyintPrestadorRetorna se o cadastro é de um prestador.string vazia ou string com dados
rateObject (JSON)AvaliaçãoRetorna um json com as informações: deadline, quality, price, attendanceObject (JSON) 0 = minima pontuação 5 = máxima pontuação
Estruturra Rate
deadlineIntegerAvaliação de prazoRetorna a avalição de prazo.string vazia ou 0 ou 5
qualityIntegerAvaliação de qualidadeRetorna a avaliação de qualidade.string vazia ou 0 ou 5
priceIntegerAvaliação de preçoRetorna a avaliação de preço.string vazia ou 0 ou 5
attendanceIntegerAvaliação de atendimentoRetorna a avaliação de atendimento.string vazia ou 0 ou 5
siteStringSiteRetorna a informação de site do cadastro.string vazia ou string com dados
skypeStringSkypeRetorna a informação de Skype do cadastro.string vazia ou string com dados
stateStringUFRetorna a Unidade Federativa (UF).string vazia ou string com dados
stateDocumentStringInscrição EstadualRetorna o valor do campo Inscrição Estadual.string vazia ou string com dados
statusBooleanStatusRetorna o status do cadastro.true ou false
supplierBooleanFornecedorRetorna se o cadastro é de um fornecedor.true ou false
twitterStringTwitterRetorna a informação de Twitter do cadastro.string vazia ou string com dados
updatedDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração do status. Formatos: YYYY-MM-DD HH:MM:SS.string vazia ou string com dados datetime
vehicleBooleanVeículoRetorna se o cadastro é de um veículo.true ou false
referrerClientStringNome FantasiaRetorna o nome fantasia do cadastro.string vazia ou string com dados
relatedDocumentObject (JSON)Informações de relacionamentoRetorna um json com as informações de relacionamento: idDoc, campaign, document,, item, typeDocument, mediaType, relatedDocNameObject (JSON)
Estrutura relatedDocument
idDocIntegerID de referencia de origemRetorna o ID da refererência de origem do documento.integer
idCampaignIntegerID do Projeto relacionadoRetorna o ID do projeto de refererência do documento.integer
campaignStringTítulo do Projeto relacionadoRetorna o título do projeto de refererência do documento.string
typeDocStringTipo do documento relacionadoRetorna o tipo de documento de origem da fatura.string
documentStringNome do projeto relacionadoRetorna o nome do projeto de referência do documento.
itemInteger
relatedDocNameStringTipo e ID de relacionamentoRetorna o tipo e o ID de relacionamento.string
records>bills>vehicleDetails
actualSituationEnumSituaçãoRetorna a sintuação atual do veículo.'active', 'disabled'
createdDatetimeData e hora de de CriaçãoRetorna a data e hora de criação do veículo. Formatos: YYYY-MM-DD HH:MM:SS.null ou string datetime
entVehicleNetworkIdIntegerID de rede de cadastro do veículoRetorna o ID da rede de cadastro do veículo no sistema.null ou string integer
mediaTypeEnumTipo de mídiaRetorna o tipo de mídia.('','tv','radio','newspaper','magazine','external','internet','other')
networkStringRedeRetorna a rede do veículo.null ou string integer
personIdIntegerID de cadastro do veículoRetorna o ID de cadastro do veículo no sistema.null ou string integer
shortNameStringNome do veículoRetorna o nome do veículo.null ou string integer
updatedDatetimeData e hora de atualizaçãoRetorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS.null ou string datetime
vehicleDetailsIntegerDetalhes do veículoRetorna o valor dos detalhes do veículo.null ou string integer
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json