--- title: "Obter Receitas" method: GET path: "/v1/financeiros/receitas" tags: ["Financeiros Movimentos"] --- # Obter Receitas `GET /v1/financeiros/receitas` Endpoint `GET /v1/financeiros/receitas` - Fornece acesso aos dados financeiros de receitas cadastrados no SankhyaOM, com suporte a ordenação dinâmica via parâmetro sort. A paginação é controlada automaticamente pela integração (routeWithRepeat). ## Query parameters - `page` integer - `sort` string - `codigoEmpresa` integer - `codigoParceiro` integer - `statusFinanceiro` 1 | 2 | 3 - `nomeNatureza` string - `tipoFinanceiro` 1 | 2 | 3 - `dataNegociacaoInicio` string - `dataNegociacaoFinal` string - `dataVencimentoInicio` string - `dataVencimentoFinal` string ## Response `200` Operação bem sucedida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - FinanceiroResponseList - `pagination` PaginacaoResponse — Metadados de paginação retornados nas listagens. - `page` integer — Página atual (inicia em 1). - `pageSize` integer — Quantidade de registros por página. - `total` integer — Total de registros encontrados. - `totalPages` integer — Total de páginas disponíveis. - `hasMore` boolean — Indica se existem mais páginas após a atual. - `financeiros` FinanceiroResponse[] - `codigoFinanceiro` integer — Identificador único do financeiro (NUFIN). - `origemFinanceiro` string — Origem do financeiro (ORIGEM). Indica se foi gerado por nota fiscal, manualmente, etc. - `dataNegociacaoInicio` string — Data de negociação do financeiro (DTNEG), formato yyyy-MM-dd. - `codigoEmpresa` integer — Código da empresa (CODEMP). - `codigoTipoOperacao` integer — Código do tipo de operação (CODTIPOPER). - `codigoNatureza` integer — Código da natureza financeira (CODNAT). - `codigoProjeto` integer — Código do projeto (CODPROJ). - `codigoCentroResultado` integer — Código do centro de resultado (CODCENCUS). - `codigoParceiro` integer — Código do parceiro (CODPARC). - `codigoContaBancaria` integer — Código da conta bancária (CODCTABCOINT). - `codigoMoeda` integer — Código da moeda (CODMOEDA). - `codigoTipoPagamento` integer — Código do tipo de pagamento / tipo de título (CODTIPTIT). - `numeroNota` integer — Número da nota vinculada ao financeiro (NUMNOTA). - `dataNegociacao` string — Data de negociação do financeiro (DTNEG), formato yyyy-MM-dd. - `dataVencimento` string — Data de vencimento do financeiro (DTVENC), formato yyyy-MM-dd. - `numeroParcela` integer — Número da parcela / desdobramento (DESDOBRAMENTO). - `maiorNumeroParcela` integer — Maior número de parcela da nota (máximo de DESDOBRAMENTO por NUMNOTA). - `valorParcela` number — Valor total da parcela (VLRDESDOB). - `valorBaixa` number — Valor efetivamente baixado. - `dataBaixa` string — Data da baixa financeira, formato yyyy-MM-dd. - `observacao` string — Observação / histórico do financeiro (HISTORICO). - `nomeEmpresa` string — Nome fantasia da empresa (TSIEMP.NOMEFANTASIA). - `nomeTipoOperacao` string — Descrição do tipo de operação (TGFTOP.DESCROPER). - `nomeNatureza` string — Descrição da natureza financeira (TGFNAT.DESCRNAT). - `nomeProjeto` string — Descrição do projeto (TGFPRO.DESCRPROJ). - `nomeCentroResultado` string — Descrição do centro de resultado (TSICUS.DESCRCENCUS). - `nomeParceiro` string — Nome do parceiro (TGFPAR.NOMEPARC). - `codigoNota` integer — Identificador interno da nota (NUNOTA). - `beneficiario` BeneficiarioResponse — Dados do beneficiário do financeiro. Em receitas representa a empresa (TSIEMP); em despesas, o parceiro (TGFPAR). - `nome` string — Nome do beneficiário. Em receitas, nome fantasia da empresa (TSIEMP.NOMEFANTASIA); em despesas, nome do parceiro (TGFPAR.NOMEPARC). - `razaoSocial` string — Razão social do beneficiário. Em receitas (TSIEMP.RAZAOSOCIAL); em despesas (TGFPAR.RAZAOSOCIAL). - `cnpjCpf` string — CNPJ ou CPF do beneficiário. Em receitas (TSIEMP.CGC); em despesas (TGFPAR.CGC_CPF). - `recebimento` RecebimentoResponse — Dados de recebimento do financeiro. Retornado apenas para receitas que possuam recebimento via PIX. - `pix` object — Dados do recebimento via PIX (TFTPIX). - `emvPix` string — Código EMV (copia e cola) do PIX (TFTPIX.EMV). - `status` string — Status do recebimento via PIX (TFTPIX.STATUS). - `idExterno` string — Identificador externo do PIX na integração (TFTPIX.IDAPI). - `conta` ContaFinanceiroResponse — Dados da conta bancária associada ao meio de recebimento/pagamento do financeiro. - `idContaExterna` string — Identificador externo da conta na integração (TFTCTA.ULIDAPI). - `codBanco` integer — Código do banco (TSICTA.CODBCO). - `nomeBanco` string — Nome do banco (TSIBCO.NOMEBCO). - `agencia` string — Número da agência (TSICTA.CODAGE). - `codConta` integer — Código da conta bancária (TFTCTA.CODCTA). - `pagamento` PagamentoResponse — Dados de pagamento do financeiro. Retornado apenas para despesas que possuam pagamento via boleto. - `boleto` object — Dados do pagamento via boleto (TFTPAG). - `codigoBarras` string — Código de barras do boleto (TGFFIN.CODBARRA). - `status` string — Status do pagamento (TFTPAG.STATUS). - `idExterno` string — Identificador externo do pagamento na integração (TFTPAG.ID_GATEWAY). - `conta` ContaFinanceiroResponse — Dados da conta bancária associada ao meio de recebimento/pagamento do financeiro. - `idContaExterna` string — Identificador externo da conta na integração (TFTCTA.ULIDAPI). - `codBanco` integer — Código do banco (TSICTA.CODBCO). - `nomeBanco` string — Nome do banco (TSIBCO.NOMEBCO). - `agencia` string — Número da agência (TSICTA.CODAGE). - `codConta` integer — Código da conta bancária (TFTCTA.CODCTA). - `contasElegiveis` ContaFinanceiroResponse[] — Lista de contas bancárias elegíveis para realizar o pagamento. - `idContaExterna` string — Identificador externo da conta na integração (TFTCTA.ULIDAPI). - `codBanco` integer — Código do banco (TSICTA.CODBCO). - `nomeBanco` string — Nome do banco (TSIBCO.NOMEBCO). - `agencia` string — Número da agência (TSICTA.CODAGE). - `codConta` integer — Código da conta bancária (TFTCTA.CODCTA). - `boleto` BoletoResponse — Dados do boleto retornados na listagem de financeiros. - `codigoBarras` string — Código de barras do boleto (TGFFIN.CODBARRA). - `nossoNumero` string — Nosso número do boleto (TGFFIN.NOSSONUM). - `linhaDigitavel` string — Linha digitável do boleto (TGFFIN.LINHADIGITAL). - `numeroRemessa` string — Número de remessa do boleto (TGFFIN.NUMREMESSA). - `rateios` RateioResponse[] - `codigoContaContabil` integer — Código da conta contábil do rateio (TGFRAT.CODCTACTB). - `percentual` number — Percentual do rateio (TGFRAT.PERCRATEIO). - `codigoNatureza` integer — Código da natureza do rateio (TGFRAT.CODNAT). - `codigoProjeto` integer — Código do projeto do rateio (TGFRAT.CODPROJ). - `codigoCentroResultado` integer — Código do centro de resultado do rateio (TGFRAT.CODCENCUS). - `codigoParceiro` integer — Código do parceiro do rateio (TGFRAT.CODPARC). - `cheque` ApiFinanceirocheque — Esta informação deve ser enviada "apenas" quando a opção de pagamento (atributo "codigoTipoPagamento") seja do subtipo "Cheque" ("4"). Recebe dados de Cheque utilizado como meio de pagamento - `codigoBarras` string, required — Código de barras do cheque (TGFCHQ.CMC7) - `numeroCheque` string — Número do cheque (TGFCHQ.NUMCHEQUE) - `banco` string — Código Banco emissor do cheque (TGFCHQ.CODBCO) - `agencia` string — Agência bancária emissora do cheque (TGFCHQ.AGENCIA) - `conta` string — Número conta bancária emissora do cheque (TGFCHQ.CONTA) - `nome` string — Nome emitente do cheque (TGFCHQ.NOMEEMITENTE) - `cnpjCpf` string — CNPJ/CPF emitente (TGFCHQ.CGC_CPF) - `valorCheque` number, required - `dataCheque` string, date — Data do Cheque (TGFCHQ.DATACHEQUE) - `cartao` ApiFinanceirocartao — Esta informação deve ser enviada "apenas" quando a opção de pagamento (atributo "codigoTipoPagamento") seja do subtipo 7 - Cartão de crédito ("7") ou Cartão de débito"Cheque" ("8"). Recebe dados da transação do cartão utilizado como meio de pagamento. - `bandeira` string, required — Segue padrão para bandeiras de cartões de créditos disponível no layout da nota fiscal eletronica (TGFTEF.BANDEIRA). As Bandeiras são cadastradas na tela "Bandeiras Tef" no SankhyaOM (TSIBTEF.BANDEIRA). Esse código é facilmente acessível através da nossa API, no endpoint "GET /v1/bandeirasTef". Obtenha essa informação e mantenha seus registros sempre atualizados. - `autorizacao` string, required — Código de autorização na transação fornecedido pela administradora do cartão de crédito (TGFTEF.AUTORIZACAO). - `NSU` string — NSU da transação fornecedido pela administradora do cartão de crédito (TGFTEF.NUMNSU) - `rede` string, required — Código da Rede (Adquirente) do cartão (TGFTEF.REDE). As Redes são cadastradas na tela "Rede Tef" no SankhyaOM (TSIRTEF.REDE). Esse código é facilmente acessível através da nossa API, no endpoint "GET /v1/redesTef". Obtenha essa informação e mantenha seus registros sempre atualizados. - `parcela` integer, required — Número da Parcela fornecida pela administradora do cartão de crédito (TGFTEF.DESDOBRAMENTO) - `dataHoraTransacao` string, datetime, required — Data e Hora da Transação fornecida pela administradora do cartão de crédito (TGFTEF.DTTRANSACAO) - `valorTaxa` number, required — Valor da Taxa fornecedida pela administradora do cartão de crédito (TGFTEF.VLRTAXA) ## Other responses - `400` — Informações Inválidas. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `401` — Não autenticado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `403` — Autenticação inválida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `404` — Dados não encontrados. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `500` — Erro interno no servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `501` — Não implementado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `502` — Retorno inválido do servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `503` — Serviço indisponível no momento. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. - `504` — Tempo de execução excedido. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes. --- [API](https://skmtc.net/sankhya/apis/api-sankhya.md) · [All operations](https://skmtc.net/sankhya/apis/api-sankhya/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sankhya/api-sankhya/revisions/0a3e81ca6195/schema)