financ.getfinrecebermov
Este endpoint devolve dados financeiros movimentados.
Dados da requisição
| API | Método |
|---|---|
| api.rule - API principal | GET |
JSON da requisição
{
"resource": "financ",
"endpoint": "getfinrecebermov",
"versao": "v1",
"taggetfinrecebermov":[
{
"idconsumer": "yyyy",
"tpfiltro": "2",
"dtpiso":"2020-01-01T00:00:00-03:00",
"dtteto": "2020-01-01T23:59:59-03:00",
"cnpjemissor": "xxxxxxxxxxxxxx",
"serie": "20",
"duplicata":999999,
"parcela":1
}
]
}
Especificação das tags
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| idconsumer | 1 | N | ID interno para controle do ator |
| tpfiltro | 1 | N | Tipo do filtro para seleção dos documenetos 1 - Filtro pelo Emissor, Série, Duplicata e Parcela 2 (Default) - Filtro por data de alteração da fatura 3 - Filtro por data de emissão da fatura |
| dtpiso | 1 | N | Data piso para captura das contas a receber (duplicatas) formato ISO 8601:2019 com fuso horário - Obrigatório quando tpfiltro = 2 ou 3 |
| dtteto | 1 | N | Data teto para captura das contas a receber (duplicatas) formato ISO 8601:2019 com fuso horário - Obrigatório quando tpfiltro = 2 ou 3 |
| cnpjemissor | 1 | S | CNPJ do emissor da duplicatas, informar 14 posições com zeros não significativos |
| serie | 1 | N | Serie da duplicata - Obrigatório quando tpfiltro = 1 |
| duplicata | 1 | N | Número da duplicata - Obrigatório quando tpfiltro = 1 |
| parcela | 1 | N | Parcela da duplicata - Utilizado quando tpfiltro = 1 - Default = 1 |
✅ Resposta de Sucesso
{
"taggetfinrecebermov": [
{
"idconsumer": "12345678-ABCD-4321-9999-000000000000",
"erromensagemitem": null,
"documentos": [
{
"duplicata": {
"id": "B6B66FDE-5676-40DE-837D-5A9C38FEDC04",
"cnpjemitente": "1",
"serie": "1",
"numero": 10001,
"parcela": 1,
"dtemissao": "2025-01-10T00:00:00.000Z",
"dtvencimento": "2025-01-10T00:00:00.000Z",
"dtultalteracao": "2025-01-10T12:00:00.000Z",
"cancelado": null,
"carteirafinanceira": {
"id": "11111111-2222-3333-4444-555555555555",
"descricao": "carteira"
},
"nossonumerobancario": "23123123123123",
"descricao": "descricao",
"sacado": {
"id": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"docreceita": "99887766000155",
"razaosocial": "CLIENTE DESTINATÁRIO S/A"
},
"valorestotais": {
"bruto": 999999999.99,
"creditos": 999999999.99,
"debitos": 999999999.99,
"saldo": 999999999.99
},
"movimentos": [
{
"tpmovto": {
"id": "B6B66FDE-5676-40DE-837D-5A9C38FEDC04",
"descricao": "descricao",
"tipo": "descricao"
},
"dtmovimento": "2025-01-10T12:00:00.000Z",
"cancelado": null,
"valor": 999999999.99,
"especiecod": "01",
"especiedesc": "Dinheiro",
"observacao": "obs"
}
],
"doctosfaturados": [
{
"id": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"lotefaturamento": {
"id": "11111111-2222-3333-4444-555555555555",
"numero": 99
},
"dfe": {
"modelo": "57",
"cnpjemitente": "99999999999999",
"serie": "12345",
"numero": 999999,
"chaveacesso": "12345678901234567890123456789012345678901234"
}
]
}
}
]
}
]
}
Especificação das tags de retorno
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| idconsumer | 1 | id interno para controle do ator | |
| erromensagemitem | 1 | se possuir conteúdo, a chamada do endpoint não foi bem sucedida, se possuir conteúdo, traz o erro ocorrido | |
| documentos | 1 | lista de documentos retornados | |
| duplicata | 2 | dados da duplicata | |
| id | 3 | id da duplicata no T4ERP | |
| cnpjemitente | 3 | CNPJ da filial emitente da duplicata | |
| serie | 3 | série da duplicata | |
| numero | 3 | número da duplicata | |
| parcela | 3 | parcela | |
| dtemissao | 3 | data de emissão | |
| dtvencimento | 3 | data de vencimento | |
| dtultalteracao | 3 | data da ultima alteração | |
| cancelado | 3 | S - Registro Cancelado | |
| carteirafinanceira | 3 | carteira financeira da duplicata | |
| id | 4 | id da carteira no T4ERP | |
| descricao | 4 | descrição | |
| nossonumerobancario | 3 | Nosso número bancário dentro da carteira financeira | |
| descricao | 3 | Descrição da duplicata | |
| sacado | 3 | Sacado | |
| id | 4 | id do sacado no T4ERP | |
| docreceita | 4 | Documento identificador do sacado junto a receita federal (cnpj/cpf) | |
| razaosocial | 4 | Razão social | |
| valorestotais | 3 | Totais da duplicata por grupo | |
| bruto | 4 | Valor bruto da duplicata | |
| creditos | 4 | Valores de créditos (reduzem o saldo a pagar) | |
| debitos | 4 | Valores de débitos (aumentam o saldo a pagar) | |
| saldo | 4 | saldo da duplicata | |
| movimentos | 3 | movimentos individuais |
|
| tpmovto | 4 | Tipo de movimento | |
| id | 5 | id do movimento no T4ERP | |
| descricao | 5 | Descrição do movimento | |
| tipo | 5 | grupo do movimento C - Crédito financeiro (reduzem o saldo a pagar) D - Débito financeiro (aumentam o saldo a pagar) |
|
| dtmovimento | 4 | Data de movimento | |
| cancelado | 4 | S - Registro Cancelado | |
| valor | 4 | Valor do movimento | |
| especiecod | 4 | Código da espécie do movimento | |
| especiedesc | 4 | Descrição da espécie do movimento | |
| observacao | 4 | Observacao do lançamento | |
| doctosfaturados | 3 | Documentos faturados constantes nesta duplicata | |
| id | 4 | id | |
| lotefaturamento | 4 | lote de faturamento | |
| id | 5 | id do lote n T4ERP | |
| numero | 5 | número | |
| dfe | 4 | Dados do dfe do documento | |
| modelo | 5 | Modelo do DFe | |
| cnpjemitente | 5 | CNPJ do emitente | |
| serie | 5 | Série | |
| numero | 5 | Número | |
| chaveacesso | 5 | Chave de acesso do DFe |
❌ Possíveis Erros
- `400 Bad Request`
- JSON de parâmetros inválido
- `401 Unauthorized` → Credenciais inválidas.
- Header authorization não inciado com "token"
- Token inválido
- `405 Method Not Allowed`
- Tentativa de acesso ao endpoint com método diferente de GET.
Observações
- É possível escolher o filtros de dados através da tag tpfiltro do json de requisição.