Obter Arquivo Financeiro

Por meio desta API é possível realizar o download do arquivo financeiro.

O arquivo financeiro é gerado com as movimentações financeiras do dia anterior. Utilizado para obter o fluxo de caixa realizado.

🚧

IMPORTANTE

Por padrão, a Conciliação está desabilitada em sua conta Moip de produção.
Não é possível usá-la em ambiente sandbox.
O período máximo de consulta é dos últimos 180 dias.
Para ter acesso à Conciliação em sua conta, por favor, entre em contato com [email protected]

📘

Identificando entradas antecipadas

Para o detalhamento de lançamentos financeiros com Recebimento Antecipado de Vendas (RAV Manual) no arquivo de conciliação financeira, a identificação se dá pela presença, no campo fee, de uma entrada com o tipo MANUAL_RAV (referente à taxa de antecipação imediata pós-contratada aplicada lançamento a lançamento) em conjunto à fee do tipo TRANSACTION (referente à taxa transacional), como exemplificado abaixo:

"fees": [
{ "amount": 353, "type": "TRANSACTION" },
{ "amount": xxx, "type": "MANUAL_RAV" }],

Atributos retornados:

Nome

Descrição

Detalhes

id

Id identificador do arquivo.

string(16)

moipAccountId

Identificador de Conta Moip

string(16)

createdAt

Data e hora da geração do arquivo.

date

eventsCreatedAt

Data referente à liquidação dos lançamentos financeiros.

date

type

Tipo do arquivo. Valores possíveis: FINANCIALS.

string(16)

count

Quantidade de lançamentos financeiros liquidados presentes no arquivo.

integer

_links

Links do recurso.

structured

└─file

Hyperlink para o arquivo contendo movimentações financeiras no formato JSON.

string

🚧

IMPORTANTE

A API não retorna a lista de movimentações diretamente, e sim um link para um arquivo JSON contendo a lista de movimentações. O link está no atributo _links.file.

Atributos do arquivo:

Nome

Descrição

Detalhes

id

Id identificador do arquivo.

string(16)

moipAccountId

Identificador de Conta Moip.

string(16)

createdAt

Data e hora da geração do arquivo.

date

eventsCreatedAt

Data referente à liquidação dos lançamentos financeiros.

date

type

Tipo do arquivo. Valores possíveis: FINANCIALS.

string(16)

settledEntries

Resumo.

structured

├─summary

├───count

Quantidade de lançamentos financeiros liquidados presentes no arquivo.

integer

├───amount

Valor total dos lançamentos financeiros.

integer

└───netAmount

integer

└─resources

Lista com os eventos do tipo ENTRY.SETTLED.

list Resources

└──type

Tipos de lançamentos. Ver lista dos tipos.

string

📘

Os atributos contidos dentro do array resources seguem o padrão de response dos GETs do recurso Lançamentos.

Exemplo de Arquivo Financeiro

{  
   "id":"REC-SHU2HRCRZ27F",
   "moipAccountId":"MPA-3748CA9C2940",
   "createdAt":"2019-01-08T09:39:44-0200",
   "eventsCreatedAt":"2018-12-14",
   "type":"FINANCIALS",
   "settledEntries":{  
      "summary":{  
         "count":9752, //Quantidade de lançamentos financeiros liquidados presentes no arquivo.
         "amount":-9759527, //Valor total dos lançamentos financeiros.
         "netAmount":-9759527 //Valor líquido
      },
      "resources":[  
         {  
            "id":275318557,
            "externalId":"ENT-678T9VR45TYQ",
            "description":"Reembolso da Comissao do Pagamento PAY-LGHODG0JGHF5",
            "moipAccount":{  
               "account":"MPA-3748CA9C2940"
            },
            "grossAmount":-325, //Valor bruto
            "liquidAmount":-325, //Valor líquido
            "type":"COMMISSION_REFUND", //Tipo de lançamento (entry)
            "eventId":"REF-BMH5E4TMJ67J",
            "createdAt":"2018-12-14T23:12:39-0200",
            "updatedAt":"2018-12-14T23:12:39-0200",
            "settledAt":"2018-12-14T23:12:39-0200",
            "scheduledFor":"2018-12-13T10:18:37-0200",
            "fees":[  

            ],
            "references":[ //Referência aos eventos do lançamento (entry)
               {  
                  "type":"PAYMENT",
                  "value":"PAY-LGHODG0JGHF5"
               },
               {  
                  "type":"OWN_ID",
                  "value":"TRA-726AF84FA19B473F9D7F4D381C9F04E4"
               },
               {  
                  "type":"ORDER",
                  "value":"ORD-U5C56VPGN0KG"
               },
               {  
                  "type":"REFUND",
                  "value":"REF-BMH5E4TMJ67J"
               }
            ],
            "installment":{  
               "amount":1,
               "number":1
            },
            "status":"SETTLED", //Status do lançamento (entry)
            "reschedule":[  

            ]
         },
         {
        "id": 294054737,
        "externalId": "ENT-1GHNJPT3JUHY",
        "description": "Cartao de credito - Pedido PAY-IP6SGTDFYM2Y parcela 1 de 2",
        "moipAccount": {
          "account": "MPA-3748CA9C2940"
        },
        "grossAmount": 3863,
        "liquidAmount": 3709,
        "type": "CREDIT_CARD_INSTALLMENT", //Tipo de lançamento (entry)
        "eventId": "PAY-IP6SGTDFYM2Y",
        "createdAt": "2019-04-10T21:13:44-0300",
        "updatedAt": "2019-05-10T02:17:40-0300",
        "settledAt": "2019-05-10T02:17:40-0300",
        "scheduledFor": "2019-05-10T21:13:44-0300",
        "fees": [
          {
            "amount": 154,
            "type": "TRANSACTION"
          }
        ],
        "references": [
          {
            "type": "ORDER",
            "value": "ORD-JUHVZPUFX234"
          },
          {
            "type": "OWN_ID",
            "value": "4194341242"
          },
          {
            "type": "PAYMENT",
            "value": "PAY-IP6SGTDFYM2Y"
          }
        ],
        "installment": {
          "amount": 2,
          "number": 1
        },
        "status": "SETTLED",
        "reschedule": []
      },
        {
        "id": 297528221,
        "externalId": "ENT-ENJPP74P3D16",
        "description": "Bloqueio de saldo - PAY-S9HY0L853Z5O",
        "moipAccount": {
          "account": "MPA-3748CA9C2940"
        },
        "grossAmount": -11982,
        "liquidAmount": -11982,
        "type": "AMOUNT_BLOCKED", //Tipo de lançamento (entry)
        "eventId": "CBK-S8VE0L083Z1O",
        "createdAt": "2019-05-02T08:01:08-0300",
        "updatedAt": "2019-05-10T02:21:09-0300",
        "settledAt": "2019-05-10T02:21:09-0300",
        "scheduledFor": "2019-05-10T22:13:42-0300",
        "fees": [],
        "references": [
          {
            "type": "PAYMENT",
            "value": "PAY-S9HY0L853Z5O"
          }
        ],
        "installment": {
          "amount": 1,
          "number": 1
        },
        "status": "SETTLED",
        "reschedule": []
      }
      ]
   }
}
Language