financ.postbaixactefatura
Este endpoint registra o pagamento de um CTe relacionado em alguma fatura.
Dados da requisição
| API | Método |
|---|---|
| api.rule - API principal | POST |
JSON da requisição
{
"resource": "financ",
"endpoint": "postbaixactefatura",
"versao": "v1",
"tagpostbaixactefatura": [
{
"idconsumer":"xxxx",
"cte": {
"modelo": "99",
"cnpjemissor": "99999999999999",
"serie": 99999,
"numero": 9999999999
},
"chaveacesso": "12345678901234567890123456789012345678901234",
"movto": {
"acao":"I",
"dtmovto": "2020-01-01T00:00:00-03:00",
"tpmovto": "X",
"valormovto": 0.00,
"observacao": ""
}
}
]
}
Especificação das tags
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| idconsumer | 1 | S | ID interno para controle do ator Tamanho máximo: C(50) Deve ser um identificador único para cada movimento, informado pelo ator que consome o serviço. Este identificador tem a função de garantir regras dentro do T4ERP, como por exemplo: - Evitar lançamentos dobrados - Cancelar lançamentos |
| cte | 1 | N | Dados do CTe a ser baixado Esta tag não deve ser informada se a tag "chaveacesso" for informada |
| cnpjemissor | 2 | S | CNPJ do emissor do CTe |
| modelo | 2 | N | Modelo do documento Default = 57 (CTe) |
| serie | 2 | S | série do CTe |
| numero | 2 | S | Número do CTe |
| chaveacesso | 1 | N | Chave de acesso do CTe Esta tag não deve ser informada se a tag "cte" for informada |
| movto | 1 | S | Dados do movimento |
| acao | 2 | S | I - Incluir o lançamento |
| dtmovto | 2 | S | Data do movimento financeiro |
| tpmovto | 2 | S | 0 - Pagamento 1 - Taxa bancária 2 - Descontos 3 - Acréscimo 4 - Multa |
| valormovto | 2 | N | Valor do movimento |
| observacao | 2 | N | Observação a ser registrada no movimento |
✅ Resposta de Sucesso
{
"tagpostbaixactefatura": [
{
"idconsumer": "12345678-ABCD-4321-9999-000000000000",
"erromensagemitem": "",
"id": "B6B66FDE-5676-40DE-837D-5A9C38FEDC04",
"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 | |
| id | 1 | id do lançamento gerado Observação: Só possui conteúdo se o consumo estiver ok |
|
| duplicata | 1 | dados da duplicata | |
| id | 2 | id da duplicata no T4ERP | |
| cnpjemitente | 2 | CNPJ da filial emitente da duplicata | |
| serie | 2 | série da duplicata | |
| numero | 2 | número da duplicata | |
| parcela | 2 | parcela | |
| dtemissao | 2 | data de emissão | |
| dtvencimento | 2 | data de vencimento | |
| dtultalteracao | 2 | data da ultima alteração | |
| cancelado | 2 | S - Registro Cancelado | |
| carteirafinanceira | 2 | carteira financeira da duplicata | |
| id | 3 | id da carteira no T4ERP | |
| descricao | 3 | descrição | |
| nossonumerobancario | 2 | Nosso número bancário dentro da carteira financeira | |
| descricao | 2 | Descrição da duplicata | |
| sacado | 2 | Sacado | |
| id | 3 | id do sacado no T4ERP | |
| docreceita | 3 | Documento identificador do sacado junto a receita federal (cnpj/cpf) | |
| razaosocial | 3 | Razão social | |
| valorestotais | 2 | Totais da duplicata por grupo | |
| bruto | 3 | Valor bruto da duplicata | |
| creditos | 3 | Valores de créditos (reduzem o saldo a pagar) | |
| debitos | 3 | Valores de débitos (aumentam o saldo a pagar) | |
| saldo | 3 | saldo da duplicata | |
| movimentos | 2 | movimentos individuais |
|
| tpmovto | 3 | Tipo de movimento | |
| id | 4 | id do movimento no T4ERP | |
| descricao | 4 | Descrição do movimento | |
| tipo | 4 | grupo do movimento C - Crédito financeiro (reduzem o saldo a pagar) D - Débito financeiro (aumentam o saldo a pagar) |
|
| dtmovimento | 5 | Data de movimento | |
| cancelado | 5 | S - Registro Cancelado | |
| valor | 5 | Valor do movimento | |
| especiecod | 5 | Código da espécie do movimento | |
| especiedesc | 5 | Descrição da espécie do movimento | |
| observacao | 5 | Observacao do lançamento | |
| doctosfaturados | 4 | Documentos faturados constantes nesta duplicata | |
| id | 5 | id | |
| lotefaturamento | 5 | lote de faturamento | |
| id | 6 | id do lote n T4ERP | |
| numero | 6 | número | |
| dfe | 5 | Dados do dfe do documento | |
| modelo | 6 | Modelo do DFe | |
| cnpjemitente | 6 | CNPJ do emitente | |
| serie | 6 | Série | |
| numero | 6 | Número | |
| chaveacesso | 6 | 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 POST.