v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Financeiros Movimentos

Obter 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).

get/v1/financeiros/receitas

Query parameters

pageinteger

Example:1

Número da página para paginação dos resultados. O valor mínimo é 1. Quando não informado, será considerada a página 1.

sortstring

Example:dataBaixa,desc

Ordenação dos resultados no formato campo,direcao. Permite múltiplos parâmetros.

Campos disponíveis:

dataVencimento
dataBaixa
valorParcela
nomeParceiro
nomeEmpresa
codigoNota

Direção:

asc
desc

Exemplo: ?sort=dataBaixa,desc

codigoEmpresainteger

Example:1456

Filtra registros retornando apenas financeiro da respectiva empresa enviada no filtro.

codigoParceirointeger

Example:1456

Filtra registros retornando apenas financeiro do respectivo parceiro enviado no filtro.

statusFinanceiro1 | 2 | 3

Status do Título Financeiro no SankhyaOM:

1 - Aberto
2 - Baixado
3 - Todos

nomeNaturezastring

Example:RECEITA COM VENDAS

Filtra registros cuja descrição da natureza financeira (TGFNAT.DESCRNAT) contenha o texto informado. A busca é parcial e não diferencia maiúsculas de minúsculas.

tipoFinanceiro1 | 2 | 3

Tipo do Título Financeiro no SankhyaOM:

1 - Real
2 - Provisao
3 - Todos

dataNegociacaoIniciostring

Example:10/02/2025

Filtra registros que foram negociados a partir da data enviada no filtro. O formato da data deve seguir o padrão dd/MM/yyyy.

dataNegociacaoFinalstring

Example:20/02/2025

Filtra registros que foram negociados até a data enviada no filtro. O formato da data deve seguir o padrão dd/MM/yyyy.

dataVencimentoIniciostring

Example:10/03/2025

Filtra registros com vencimento a partir da data enviada no filtro. O formato da data deve seguir o padrão dd/MM/yyyy.

dataVencimentoFinalstring

Example:20/03/2025

Filtra registros com vencimento até a data enviada no filtro. O formato da data deve seguir o padrão dd/MM/yyyy.

Response

Operação bem sucedida. Clique aqui para mais detalhes.

Example response

{
  "pagination": {
    "page": 1,
    "pageSize": 50,
    "total": 100,
    "totalPages": 2,
    "hasMore": true
  },
  "financeiros": [
    {
      "codigoFinanceiro": 8115,
      "origemFinanceiro": "N",
      "dataNegociacaoInicio": "2025-02-11",
      "codigoEmpresa": 1,
      "codigoTipoOperacao": 108,
      "codigoNatureza": 101005,
      "codigoProjeto": 10011,
      "codigoCentroResultado": 3004002,
      "codigoParceiro": 1581,
      "codigoContaBancaria": 42,
      "codigoMoeda": 22,
      "codigoTipoPagamento": 19,
      "numeroNota": 33569,
      "dataNegociacao": "2025-02-11",
      "dataVencimento": "2025-03-11",
      "numeroParcela": 1,
      "maiorNumeroParcela": 10,
      "valorParcela": 3.38,
      "valorBaixa": 3.38,
      "dataBaixa": "2025-02-15",
      "observacao": "Pagamento referente à NF 33569",
      "nomeEmpresa": "TECH SOLUTIONS",
      "nomeTipoOperacao": "VENDAS PARA FORA DO ESTADO",
      "nomeNatureza": "RECEITA COM VENDAS",
      "nomeProjeto": "SEM PROJETO",
      "nomeCentroResultado": "VENDAS PRONTA ENTREGA",
      "nomeParceiro": "JOÃO DA SILVA",
      "codigoNota": 456159,
      "beneficiario": {
        "nome": "TECH SOLUTIONS",
        "razaoSocial": "TECH SOLUTIONS LTDA",
        "cnpjCpf": "12345678000190"
      },
      "recebimento": {
        "pix": {
          "emvPix": "00020126360014BR.GOV.BCB.PIX0114+5511999999999520400005303986540510.005802BR5913FULANO DE TAL6008BRASILIA62070503***6304ABCD",
          "status": "CONCLUIDO",
          "idExterno": "pix-9f8e7d6c5b4a",
          "conta": {
            "idContaExterna": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "codBanco": 341,
            "nomeBanco": "ITAÚ UNIBANCO S.A.",
            "agencia": "1234",
            "codConta": 42
          }
        }
      },
      "pagamento": {
        "boleto": {
          "codigoBarras": "34191790010104351004791020150008291070026000",
          "status": "PENDENTE",
          "idExterno": "pag-1a2b3c4d5e6f",
          "conta": {
            "idContaExterna": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "codBanco": 341,
            "nomeBanco": "ITAÚ UNIBANCO S.A.",
            "agencia": "1234",
            "codConta": 42
          },
          "contasElegiveis": [
            {
              "idContaExterna": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
              "codBanco": 341,
              "nomeBanco": "ITAÚ UNIBANCO S.A.",
              "agencia": "1234",
              "codConta": 42
            }
          ]
        }
      },
      "boleto": {
        "codigoBarras": "341067330330018805201725766099",
        "nossoNumero": "568454558",
        "numeroRemessa": "0012"
      },
      "rateios": [
        {
          "codigoContaContabil": 42,
          "percentual": 50,
          "codigoNatureza": 101005,
          "codigoProjeto": 10011,
          "codigoCentroResultado": 3004002,
          "codigoParceiro": 1581
        }
      ],
      "cheque": {
        "codigoBarras": "341067330330018805201725766099",
        "numeroCheque": "66009",
        "banco": "341",
        "agencia": "673",
        "conta": "576609",
        "nome": "José da Silva Souza",
        "cnpjCpf": "14532515955",
        "valorCheque": 200
      },
      "cartao": {
        "bandeira": "2",
        "NSU": "123456",
        "rede": "1",
        "parcela": 1,
        "valorTaxa": 0.65
      }
    }
  ]
}