GET api/Financeiro?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&DataInicial={DataInicial}&DataFinal={DataFinal}&Documento={Documento}

Método para consultar informações financeiras detalhadas

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CNPJ

Numero do CNPJ da empresa (polo) que receberá as informações.

 string

Required
token

Código de acesso à API

 string

Required
codigoEmpresa

Código identificador da empresa

 integer

Required
DataInicial

Data Inicial da Busca

 date

Required
DataFinal

Data Final da Busca

 date

Required
Documento

Numero documento a pesquisa

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of FinanceiroDetalhadoModel
NameDescriptionTypeAdditional information
Codigo_Identificador_lancamento_unico

Identificador unico do lancamento

 integer

None.
Codigo_Identificador_lancamento

Identificador do lancamento

 integer

None.
identificador_prestador

Identificador do prestador de serviço - CPF ou CNPJ

 string

None.
razao_social_prestador

Razao Social ou nome do prestador de serviço

 string

None.
identificador_tomador

Identificador do tomador do serviço - CPF ou CNPJ

 string

None.
razao_social_tomador

Razao social ou nome do tomardor do servico

 string

None.
cd_centro_custo

codigo interno do centro de custo

 string

None.
ds_centro_custo

Nome do centro de custo

 string

None.
tipo_movimentacao

Tipo de Movimentacao - P=pagamento R=Recebimento

 string

None.
data_vencimento

Data de vencimento do pagamento ou recebimento

 string

None.
valor_previsto

Valor Previsto do Pagamento / Recebimento

 decimal number

None.
desconto

Desconto, se houver

 decimal number

None.
multa_juros

Multa e juros, se houver

 decimal number

None.
valor_efetivado

Valor pago ou recebido

 decimal number

None.
data_efetivacao

Data do pagamento ou recebimento

 string

None.
status_lancamento

Status do Lancamento - P=Previsto R=Realizado

 string

None.
codigo_tipo_documento

Codigo Interno do tipo de documento

 string

None.
codigo_pipefy

Codigo do Pipefy - se houver para pagamentos

 string

None.
documento_cliente

Numero do documento emitido ou recebido

 string

None.
observacoes

Observacoes do lancamento

 string

None.
codigo_banco

Codigo do Banco

 string

None.
agencia

Agencia do banco.

 string

None.
conta_corrente

Conta Corrente

 string

None.
codigo_interno_conta_contabil

Codigo Interno da Conta Contabil

 string

None.
codigo_conta_contabil

Codigo Analitico da Conta Contabil

 string

None.
conta_contabil

Descricao da Conta contabil

 string

None.
Anexos

Lista de Anexos

 Collection of AnexoModel

None.
CodigoRetorno

Código do retorno da API: 0 - erro || 1 - sucesso

 integer

None.
MensagemRetorno

Mensagem de retorno da API

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Codigo_Identificador_lancamento_unico": 1,
    "Codigo_Identificador_lancamento": 2,
    "identificador_prestador": "sample string 3",
    "razao_social_prestador": "sample string 4",
    "identificador_tomador": "sample string 5",
    "razao_social_tomador": "sample string 6",
    "cd_centro_custo": "sample string 7",
    "ds_centro_custo": "sample string 8",
    "tipo_movimentacao": "sample string 9",
    "data_vencimento": "sample string 10",
    "valor_previsto": 11.0,
    "desconto": 12.0,
    "multa_juros": 13.0,
    "valor_efetivado": 14.0,
    "data_efetivacao": "sample string 15",
    "status_lancamento": "sample string 16",
    "codigo_tipo_documento": "sample string 17",
    "codigo_pipefy": "sample string 18",
    "documento_cliente": "sample string 19",
    "observacoes": "sample string 20",
    "codigo_banco": "sample string 21",
    "agencia": "sample string 22",
    "conta_corrente": "sample string 23",
    "codigo_interno_conta_contabil": "sample string 24",
    "codigo_conta_contabil": "sample string 25",
    "conta_contabil": "sample string 26",
    "Anexos": [
      {
        "Codigo_Identificador_lancamento": 1,
        "CaminhoArquivo": "sample string 2",
        "Nome": "sample string 3"
      },
      {
        "Codigo_Identificador_lancamento": 1,
        "CaminhoArquivo": "sample string 2",
        "Nome": "sample string 3"
      }
    ],
    "CodigoRetorno": 27,
    "MensagemRetorno": "sample string 28"
  },
  {
    "Codigo_Identificador_lancamento_unico": 1,
    "Codigo_Identificador_lancamento": 2,
    "identificador_prestador": "sample string 3",
    "razao_social_prestador": "sample string 4",
    "identificador_tomador": "sample string 5",
    "razao_social_tomador": "sample string 6",
    "cd_centro_custo": "sample string 7",
    "ds_centro_custo": "sample string 8",
    "tipo_movimentacao": "sample string 9",
    "data_vencimento": "sample string 10",
    "valor_previsto": 11.0,
    "desconto": 12.0,
    "multa_juros": 13.0,
    "valor_efetivado": 14.0,
    "data_efetivacao": "sample string 15",
    "status_lancamento": "sample string 16",
    "codigo_tipo_documento": "sample string 17",
    "codigo_pipefy": "sample string 18",
    "documento_cliente": "sample string 19",
    "observacoes": "sample string 20",
    "codigo_banco": "sample string 21",
    "agencia": "sample string 22",
    "conta_corrente": "sample string 23",
    "codigo_interno_conta_contabil": "sample string 24",
    "codigo_conta_contabil": "sample string 25",
    "conta_contabil": "sample string 26",
    "Anexos": [
      {
        "Codigo_Identificador_lancamento": 1,
        "CaminhoArquivo": "sample string 2",
        "Nome": "sample string 3"
      },
      {
        "Codigo_Identificador_lancamento": 1,
        "CaminhoArquivo": "sample string 2",
        "Nome": "sample string 3"
      }
    ],
    "CodigoRetorno": 27,
    "MensagemRetorno": "sample string 28"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfFinanceiroDetalhadoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
  <FinanceiroDetalhadoModel>
    <Anexos>
      <AnexoModel>
        <CaminhoArquivo>sample string 2</CaminhoArquivo>
        <Codigo_Identificador_lancamento>1</Codigo_Identificador_lancamento>
        <Nome>sample string 3</Nome>
      </AnexoModel>
      <AnexoModel>
        <CaminhoArquivo>sample string 2</CaminhoArquivo>
        <Codigo_Identificador_lancamento>1</Codigo_Identificador_lancamento>
        <Nome>sample string 3</Nome>
      </AnexoModel>
    </Anexos>
    <CodigoRetorno>27</CodigoRetorno>
    <Codigo_Identificador_lancamento>2</Codigo_Identificador_lancamento>
    <Codigo_Identificador_lancamento_unico>1</Codigo_Identificador_lancamento_unico>
    <MensagemRetorno>sample string 28</MensagemRetorno>
    <agencia>sample string 22</agencia>
    <cd_centro_custo>sample string 7</cd_centro_custo>
    <codigo_banco>sample string 21</codigo_banco>
    <codigo_conta_contabil>sample string 25</codigo_conta_contabil>
    <codigo_interno_conta_contabil>sample string 24</codigo_interno_conta_contabil>
    <codigo_pipefy>sample string 18</codigo_pipefy>
    <codigo_tipo_documento>sample string 17</codigo_tipo_documento>
    <conta_contabil>sample string 26</conta_contabil>
    <conta_corrente>sample string 23</conta_corrente>
    <data_efetivacao>sample string 15</data_efetivacao>
    <data_vencimento>sample string 10</data_vencimento>
    <desconto>12</desconto>
    <documento_cliente>sample string 19</documento_cliente>
    <ds_centro_custo>sample string 8</ds_centro_custo>
    <identificador_prestador>sample string 3</identificador_prestador>
    <identificador_tomador>sample string 5</identificador_tomador>
    <multa_juros>13</multa_juros>
    <observacoes>sample string 20</observacoes>
    <razao_social_prestador>sample string 4</razao_social_prestador>
    <razao_social_tomador>sample string 6</razao_social_tomador>
    <status_lancamento>sample string 16</status_lancamento>
    <tipo_movimentacao>sample string 9</tipo_movimentacao>
    <valor_efetivado>14</valor_efetivado>
    <valor_previsto>11</valor_previsto>
  </FinanceiroDetalhadoModel>
  <FinanceiroDetalhadoModel>
    <Anexos>
      <AnexoModel>
        <CaminhoArquivo>sample string 2</CaminhoArquivo>
        <Codigo_Identificador_lancamento>1</Codigo_Identificador_lancamento>
        <Nome>sample string 3</Nome>
      </AnexoModel>
      <AnexoModel>
        <CaminhoArquivo>sample string 2</CaminhoArquivo>
        <Codigo_Identificador_lancamento>1</Codigo_Identificador_lancamento>
        <Nome>sample string 3</Nome>
      </AnexoModel>
    </Anexos>
    <CodigoRetorno>27</CodigoRetorno>
    <Codigo_Identificador_lancamento>2</Codigo_Identificador_lancamento>
    <Codigo_Identificador_lancamento_unico>1</Codigo_Identificador_lancamento_unico>
    <MensagemRetorno>sample string 28</MensagemRetorno>
    <agencia>sample string 22</agencia>
    <cd_centro_custo>sample string 7</cd_centro_custo>
    <codigo_banco>sample string 21</codigo_banco>
    <codigo_conta_contabil>sample string 25</codigo_conta_contabil>
    <codigo_interno_conta_contabil>sample string 24</codigo_interno_conta_contabil>
    <codigo_pipefy>sample string 18</codigo_pipefy>
    <codigo_tipo_documento>sample string 17</codigo_tipo_documento>
    <conta_contabil>sample string 26</conta_contabil>
    <conta_corrente>sample string 23</conta_corrente>
    <data_efetivacao>sample string 15</data_efetivacao>
    <data_vencimento>sample string 10</data_vencimento>
    <desconto>12</desconto>
    <documento_cliente>sample string 19</documento_cliente>
    <ds_centro_custo>sample string 8</ds_centro_custo>
    <identificador_prestador>sample string 3</identificador_prestador>
    <identificador_tomador>sample string 5</identificador_tomador>
    <multa_juros>13</multa_juros>
    <observacoes>sample string 20</observacoes>
    <razao_social_prestador>sample string 4</razao_social_prestador>
    <razao_social_tomador>sample string 6</razao_social_tomador>
    <status_lancamento>sample string 16</status_lancamento>
    <tipo_movimentacao>sample string 9</tipo_movimentacao>
    <valor_efetivado>14</valor_efetivado>
    <valor_previsto>11</valor_previsto>
  </FinanceiroDetalhadoModel>
</ArrayOfFinanceiroDetalhadoModel>