### Omie API v1 Financas MovimentosFinanceiros ListarMovimentos Request Example

Source: https://app.omie.com.br/api/v1/financas/mf

Example JSON request payload for the 'ListarMovimentos' method in the Omie API v1 Financas MovimentosFinanceiros service. This specifies pagination parameters.

```JSON
{
  "nPagina": 1,
  "nRegPorPagina": 500
}
```

--------------------------------

### GET /websites/app_omie_br_api_v1/detalhes

Source: https://app.omie.com.br/api/v1/financas/mf

Recupera detalhes de um movimento financeiro com base em vários parâmetros.

```APIDOC
## GET /websites/app_omie_br_api_v1/detalhes

### Description
Recupera detalhes de um movimento financeiro específico. Este endpoint permite consultar informações detalhadas sobre títulos financeiros, como datas de emissão e vencimento, valores, status, informações do cliente/fornecedor, e detalhes de documentos fiscais associados.

### Method
GET

### Endpoint
/websites/app_omie_br_api_v1/detalhes

### Parameters
#### Query Parameters
- **nCodTitulo** (integer) - Optional - Código do título.
- **cCodIntTitulo** (string60) - Optional - Código de integração do título.
- **cNumTitulo** (string20) - Optional - Número do título.
- **dDtEmissao** (string10) - Optional - Data de emissão do título (formato DD/MM/AAAA).
- **dDtVenc** (string10) - Optional - Data de vencimento do título (formato DD/MM/AAAA).
- **dDtPrevisao** (string10) - Optional - Data de previsão de Pagamento/Recebimento (formato DD/MM/AAAA).
- **dDtPagamento** (string10) - Optional - Data de pagamento do título (formato DD/MM/AAAA).
- **nCodCliente** (integer) - Optional - Código de Cliente / Fornecedor.
- **cCPFCNPJCliente** (string20) - Optional - CPF/CNPJ do cliente para filtrar títulos.
- **nCodCtr** (integer) - Optional - Código do contrato associado ao título.
- **cNumCtr** (string20) - Optional - Número do contrato associado ao título.
- **nCodOS** (integer) - Optional - Código do Pedido de Venda / Ordem de Serviço.
- **cNumOS** (string15) - Optional - Número do pedido de venda / Ordem de Serviço.
- **nCodCC** (integer) - Optional - Código da conta corrente.
- **cStatus** (string100) - Optional - Status do título. Valores possíveis: CANCELADO, RECEBIDO, LIQUIDADO, EMABERTO, PAGTO_PARCIAL, VENCEHOJE, AVENCER, ATRASADO.
- **cNatureza** (string1) - Optional - Natureza do título. Valores possíveis: P (Contas a Pagar), R (Contas a Receber).
- **cTipo** (string5) - Optional - Tipo de documento. Valores possíveis: ADI, BOL, CRT, CHQ, CON, CRE, DRF, DAS, DEB, DIN, DOC, GUIA, PROT, REC, RPA, TED, TRA, 99999.
- **cOperacao** (string2) - Optional - Operação do título. Valores possíveis: 01, 11, 12, 13, 14, 16, 21, 23, 24, 26, 22, 28.
- **cNumDocFiscal** (string20) - Optional - Número do documento fiscal.
- **cCodCateg** (string20) - Optional - Código da Categoria.
- **cNumParcela** (string7) - Optional - Número da parcela (formato 999/999).
- **nValorTitulo** (decimal) - Optional - Valor do título.
- **nValorPIS** (decimal) - Optional - Valor do PIS.
- **cRetPIS** (string1) - Optional - Indica se o Valor do PIS deve ser retido (S/N).
- **nValorCOFINS** (decimal) - Optional - Valor do COFINS.
- **cRetCOFINS** (string1) - Optional - Indica se o Valor do COFINS deve ser retido (S/N).
- **nValorCSLL** (decimal) - Optional - Valor do CSLL.
- **cRetCSLL** (string1) - Optional - Indica se o Valor do CSLL deve ser retido (S/N).
- **nValorIR** (decimal) - Optional - Valor do Imposto de Renda.
- **cRetIR** (string1) - Optional - Indica se o Valor do IR deve ser retido (S/N).
- **nValorISS** (decimal) - Optional - Valor do ISS.
- **cRetISS** (string1) - Optional - Indica se o Valor do ISS deve ser retido (S/N).
- **nValorINSS** (decimal) - Optional - Valor do INSS.
- **cRetINSS** (string1) - Optional - Indica se o Valor do INSS deve ser retido (S/N).
- **cCodProjeto** (integer) - Optional - Código do projeto.
- **observacao** (text) - Optional - Observações do título.
- **cCodVendedor** (integer) - Optional - Código do vendedor.
- **nCodComprador** (integer) - Optional - Código do comprador.
- **cCodigoBarras** (string70) - Optional - Código de Barras do título.
- **cNSU** (string100) - Optional - Número Sequencial Único - Comprovante de pagamento.
- **nCodNF** (integer) - Optional - Código da Nota Fiscal.
- **dDtRegistro** (string10) - Optional - Data de registro da NF (formato DD/MM/AAAA).
- **cNumBoleto** (string30) - Optional - Número do Boleto.
- **cChaveNFe** (string44) - Optional - Chave da NF-e de origem.
- **cOrigem** (string4) - Optional - Origem do lançamento. Valores possíveis: APBP, APBR, APEP, APER, APIP, APIR, BARP, BARR, BAXP, BAXR, COMP, DEVP, DEVR, EXTP, EXTR, IMPP, MANP, MANR, NFEP.

### Request Example
```json
{
  "nCodTitulo": 12345,
  "dDtVenc": "31/12/2023"
}
```

### Response
#### Success Response (200)
- **nCodTitulo** (integer) - Código do título.
- **cCodIntTitulo** (string60) - Código de integração do título.
- **cNumTitulo** (string20) - Número do título.
- **dDtEmissao** (string10) - Data de emissão do título.
- **dDtVenc** (string10) - Data de vencimento do título.
- **dDtPrevisao** (string10) - Data de previsão de Pagamento/Recebimento.
- **dDtPagamento** (string10) - Data de pagamento do título.
- **nCodCliente** (integer) - Código de Cliente / Fornecedor.
- **cCPFCNPJCliente** (string20) - CPF/CNPJ do cliente.
- **nCodCtr** (integer) - Código do contrato associado ao título.
- **cNumCtr** (string20) - Número do contrato associado ao título.
- **nCodOS** (integer) - Código do Pedido de Venda / Ordem de Serviço.
- **cNumOS** (string15) - Número do pedido de venda / Ordem de Serviço.
- **nCodCC** (integer) - Código da conta corrente.
- **cStatus** (string100) - Status do título.
- **cNatureza** (string1) - Natureza do título.
- **cTipo** (string5) - Tipo de documento.
- **cOperacao** (string2) - Operação do título.
- **cNumDocFiscal** (string20) - Número do documento fiscal.
- **cCodCateg** (string20) - Código da Categoria.
- **cNumParcela** (string7) - Número da parcela.
- **nValorTitulo** (decimal) - Valor do título.
- **nValorPIS** (decimal) - Valor do PIS.
- **cRetPIS** (string1) - Indica se o Valor do PIS informado deve ser retido.
- **nValorCOFINS** (decimal) - Valor do COFINS.
- **cRetCOFINS** (string1) - Indica se o Valor do COFINS informado deve ser retido.
- **nValorCSLL** (decimal) - Valor do CSLL.
- **cRetCSLL** (string1) - Indica se o Valor do CSLL informado deve ser retido.
- **nValorIR** (decimal) - Valor do Imposto de Renda.
- **cRetIR** (string1) - Indica se o Valor do IR informado deve ser retido.
- **nValorISS** (decimal) - Valor do ISS.
- **cRetISS** (string1) - Indica se o Valor do ISS informado deve ser retido.
- **nValorINSS** (decimal) - Valor do INSS.
- **cRetINSS** (string1) - Indica se o Valor do INSS informado deve ser retido.
- **cCodProjeto** (integer) - Código do projeto.
- **observacao** (text) - Observações do título.
- **cCodVendedor** (integer) - Código do vendedor.
- **nCodComprador** (integer) - Código do comprador.
- **cCodigoBarras** (string70) - Código de Barras do título.
- **cNSU** (string100) - Número Sequencial Único - Comprovante de pagamento.
- **nCodNF** (integer) - Código da Nota Fiscal.
- **dDtRegistro** (string10) - Data de registro da NF.
- **cNumBoleto** (string30) - Número do Boleto.
- **cChaveNFe** (string44) - Chave da NF-e de origem.
- **cOrigem** (string4) - Origem do lançamento.

#### Response Example
```json
{
  "nCodTitulo": 12345,
  "cCodIntTitulo": "INT-001",
  "cNumTitulo": "T-0001",
  "dDtEmissao": "01/12/2023",
  "dDtVenc": "31/12/2023",
  "dDtPrevisao": "30/12/2023",
  "dDtPagamento": null,
  "nCodCliente": 6789,
  "cCPFCNPJCliente": "123.456.789-00",
  "nCodCtr": null,
  "cNumCtr": "",
  "nCodOS": null,
  "cNumOS": "",
  "nCodCC": 10,
  "cStatus": "AVENCER",
  "cNatureza": "R",
  "cTipo": "BOL",
  "cOperacao": "11",
  "cNumDocFiscal": "NF-12345",
  "cCodCateg": "VENDA",
  "cNumParcela": "1/1",
  "nValorTitulo": 150.75,
  "nValorPIS": 0.00,
  "cRetPIS": "N",
  "nValorCOFINS": 0.00,
  "cRetCOFINS": "N",
  "nValorCSLL": 0.00,
  "cRetCSLL": "N",
  "nValorIR": 0.00,
  "cRetIR": "N",
  "nValorISS": 0.00,
  "cRetISS": "N",
  "nValorINSS": 0.00,
  "cRetINSS": "N",
  "cCodProjeto": null,
  "observacao": "Pagamento via boleto.",
  "cCodVendedor": null,
  "nCodComprador": null,
  "cCodigoBarras": "4567891234567890",
  "cNSU": "",
  "nCodNF": null,
  "dDtRegistro": "01/12/2023",
  "cNumBoleto": "BOL-001",
  "cChaveNFe": "",
  "cOrigem": "MANR"
}
```

--------------------------------

### Listar Títulos (GET /geral/titulos/)

Source: https://app.omie.com.br/api/v1/financas/mf

Este endpoint permite listar títulos com base em uma variedade de parâmetros de filtragem e ordenação.

```APIDOC
## GET /geral/titulos/

### Description
Este endpoint permite listar títulos com base em uma variedade de parâmetros de filtragem e ordenação.

### Method
GET

### Endpoint
https://app.omie.com.br/api/v1/geral/titulos/

### Parameters
#### Query Parameters
- **nPagina** (integer) - Opcional - Número da página que será listada.
- **nRegPorPagina** (integer) - Opcional - Número de registros retornados por página.
- **cOrdenarPor** (string100) - Opcional - Ordem de exibição dos dados. Pode ser: CODIGO, CODIGO_INTEGRACAO.
- **cOrdemDecrescente** (string1) - Opcional - Indica ordem decrescente (S/N). DEPRECATED.
- **lDadosCad** (boolean) - Opcional - Exibir dados cadastrais como Data de Inclusão, Alteração do Título e Observações (S/N).
- **nCodTitulo** (integer) - Opcional - Código do título.
- **cCodIntTitulo** (string60) - Opcional - Código de integração do título.
- **cNumTitulo** (string20) - Opcional - Número do título.
- **dDtEmisDe** (string10) - Opcional - Filtrar os títulos pela data de emissão - a partir de (formato DD/MM/AAAA).
- **dDtEmisAte** (string10) - Opcional - Filtrar os títulos pela data de emissão - até (formato DD/MM/AAAA).
- **dDtVencDe** (string10) - Opcional - Filtrar os títulos pela data de vencimento - a partir de (formato DD/MM/AAAA).
- **dDtVencAte** (string10) - Opcional - Filtrar os títulos pela data de vencimento - até (formato DD/MM/AAAA).
- **dDtPagtoDe** (string10) - Opcional - Filtrar os títulos pela data de pagamento - a partir de (formato DD/MM/AAAA).
- **dDtPagtoAte** (string10) - Opcional - Filtrar os títulos pela data de pagamento - até (formato DD/MM/AAAA).
- **dDtPrevDe** (string10) - Opcional - Filtrar os títulos pela data de previsão de Pagamento/Recebimento - a partir de (formato DD/MM/AAAA).
- **dDtPrevAte** (string10) - Opcional - Filtrar os títulos pela data de previsão de Pagamento/Recebimento - até (formato DD/MM/AAAA).
- **dDtRegDe** (string10) - Opcional - Filtrar os títulos pela data de registro da NF - a partir de (formato DD/MM/AAAA).
- **dDtRegAte** (string10) - Opcional - Filtrar os títulos pela data de registro da NF - até (formato DD/MM/AAAA).
- **nCodCliente** (integer) - Opcional - Código de Cliente / Fornecedor.
- **cCPFCNPJCliente** (string20) - Opcional - Filtrar os títulos por CPF/CNPJ do cliente.
- **nCodCtr** (integer) - Opcional - Código do contrato associado ao título.
- **cNumCtr** (string20) - Opcional - Número do contrato associado ao título.
- **nCodOS** (integer) - Opcional - Código do Pedido de Venda / Ordem de Serviço.
- **cNumOS** (string15) - Opcional - Número do pedido de venda / Ordem de Serviço.
- **nCodCC** (integer) - Opcional - Código da conta corrente.
- **cStatus** (string100) - Opcional - Status do título. Pode ser: CANCELADO, RECEBIDO, LIQUIDADO, EMABERTO, PAGTO_PARCIAL, VENCEHOJE, AVENCER, ATRASADO.
- **cNatureza** (string1) - Opcional - Natureza do título. Pode ser: P (Contas a Pagar), R (Contas a Receber).
- **cTipo** (string5) - Opcional - Tipo de documento. Para obter a lista completa, consulte a tag 'codigo' do método 'PesquisarTipoDocumento' da API: https://app.omie.com.br/api/v1/geral/tiposdoc/. Exemplos: ADI, BOL, CRT, CHQ, CON, CRE, DRF, DAS, DEB, DIN, DOC, GUIA, PROT, REC, RPA, TED, TRA, 99999.
- **cOperacao** (string2) - Opcional - Operação do título. Exemplos: 01 (Venda de Serviço), 11 (Venda de Produto), 12 (Venda de Produto pelo PDV), 13 (Devolução de Venda), 14 (Remessa de Produto), 16 (Transferência), 21 (Compra de Produto), 23 (Devolução ao Fornecedor), 24 (Retorno de Remessa), 26 (Nota Complementar de Entrada), 22 (Compra de Produto - Importação), 28 (Ordem de Produção).
- **cNumDocFiscal** (string20) - Opcional - Número do documento fiscal (NF-e, NFC-e, NFS-e, etc).
- **cCodigoBarras** (string70) - Opcional - Código de Barras do título.
- **nCodProjeto** (integer) - Opcional - Código do projeto.
- **nCodVendedor** (integer) - Opcional - Código do vendedor.
- **nCodComprador** (integer) - Opcional - Código do comprador.
- **cCodCateg** (string20) - Opcional - Código da Categoria.
- **dDtIncDe** (string10) - Opcional - Data de inclusão - a partir de (formato DD/MM/AAAA).
- **dDtIncAte** (string10) - Opcional - Data de inclusão - até (formato DD/MM/AAAA).
- **dDtAltDe** (string10) - Opcional - Data de alteração - a partir de (formato DD/MM/AAAA).
- **dDtAltAte** (string10) - Opcional - Data de alteração - até (formato DD/MM/AAAA).
- **cTpLancamento** (string10) - Opcional - Tipo de registro que será exibido. Pode ser: CP, CR, CPCR, BX, BXCP, BXCR, CC, CCE, CCS, CCT, PV, POS, PPV.
- **cExibirDepartamentos** (string1) - Opcional - Exibir distribuição por departamentos (S/N).
- **nCodMovCC** (integer) - Opcional - Código do movimento de Conta Corrente.

### Response
#### Success Response (200)
- **total_registros** (integer) - O número total de registros encontrados.
- **pagina_atual** (integer) - O número da página atual.
- **total_paginas** (integer) - O número total de páginas.
- **lista_titulos** (array) - Uma lista de objetos de título, cada um contendo os detalhes do título.

#### Response Example
```json
{
  "total_registros": 100,
  "pagina_atual": 1,
  "total_paginas": 10,
  "lista_titulos": [
    {
      "nCodTitulo": 123,
      "cNumTitulo": "NF001",
      "dDtEmis": "10/10/2023",
      "dDtVenc": "10/11/2023",
      "nValor": 150.75,
      "cStatus": "EMABERTO",
      "cNatureza": "R"
    }
  ]
}
```
```

--------------------------------

### Omie API v1 Financas MovimentosFinanceiros Endpoint URIs

Source: https://app.omie.com.br/api/v1/financas/mf

Provides the main endpoint URI, WSDL URI, and URIs for downloading PHP SOAP, PHP JSON, and JavaScript JSON clients for the MovimentosFinanceiros service.

```URI
https://app.omie.com.br/api/v1/financas/mf/
```

```URI
https://app.omie.com.br/api/v1/financas/mf/?WSDL
```

```URI
https://app.omie.com.br/api/v1/financas/mf/?PHPSOAPCLIENT
```

```URI
https://app.omie.com.br/api/v1/financas/mf/?PHPJSONCLIENT
```

```URI
https://app.omie.com.br/api/v1/financas/mf/?JSJSONCLIENT
```

--------------------------------

### Financial Movement Summary

Source: https://app.omie.com.br/api/v1/financas/mf

Provides a summary of a financial movement, including payment status and values.

```APIDOC
## resumo

### Description
This object provides a summary of a financial movement's status and financial values.

### Fields
- **cLiquidado** (string) - Indicates if the title is settled ('S' for Yes, 'N' for No).
- **nValPago** (decimal) - The total amount paid for the title.
- **nValAberto** (decimal) - The total amount open for the title.
- **nDesconto** (decimal) - The discount amount.
- **nJuros** (decimal) - The interest amount.
- **nMulta** (decimal) - The fine amount.
- **nValLiquido** (decimal) - The net value, calculated as (nValPago - nDesconto + Juros + nMulta).
```

--------------------------------

### Financial Movement Details

Source: https://app.omie.com.br/api/v1/financas/mf

Structure detailing individual financial movements, including summary, departments, and categories.

```APIDOC
## movimentos

### Description
This object represents the details of a single financial movement.

### Fields
- **detalhes** (detalhes) - Detailed information about the financial movement.
- **resumo** (resumo) - A summary of the financial movement's status and values.
- **departamentos** (departamentosArray) - An array detailing the distribution of the movement by department.
- **categorias** (categoriasArray) - An array detailing the distribution of the movement by category.
```

--------------------------------

### Financial Movement List Response

Source: https://app.omie.com.br/api/v1/financas/mf

Response structure for listing financial movements, including pagination details and movement arrays.

```APIDOC
## mfListarResponse

### Description
This object represents the response structure for listing financial movements. It includes pagination information and an array of financial movements.

### Fields
- **nPagina** (integer) - The current page number of the results.
- **nTotPaginas** (integer) - The total number of pages available.
- **nRegistros** (integer) - The number of records returned in the current page.
- **nTotRegistros** (integer) - The total number of records found.
- **movimentos** (movimentosArray) - An array containing the financial movement details.
```

--------------------------------

### POST /api/v1/financas/mf/ ListarMovimentos

Source: https://app.omie.com.br/api/v1/financas/mf

Retrieves a paginated list of financial movements such as accounts payable, accounts receivable, and bank statement entries. Send a JSON payload with pagination parameters.

```APIDOC
## POST https://app.omie.com.br/api/v1/financas/mf/

### Description
Retrieves a paginated list of financial movements (contas a pagar, contas a receber, lançamentos do conta corrente).

### Method
POST

### Endpoint
https://app.omie.com.br/api/v1/financas/mf/

### Parameters
#### Request Body
- **nPagina** (integer) - Required - Page number to retrieve.
- **nRegPorPagina** (integer) - Required - Number of records per page (maximum 500).

### Request Example
{
  "nPagina": 1,
  "nRegPorPagina": 500
}

### Response
#### Success Response (200)
- **movimentos** (array) - List of financial movement objects.
- **totalRegistros** (integer) - Total number of records available.
- **nPagina** (integer) - Current page number.
- **nRegPorPagina** (integer) - Records per page returned.

### Response Example
{
  "totalRegistros": 1240,
  "nPagina": 1,
  "nRegPorPagina": 500,
  "movimentos": [
    {
      "codigoMovimento": "001",
      "tipo": "Conta a Pagar",
      "valor": 1500.00,
      "dataVencimento": "2024-07-15"
    }
    // ... more items
  ]
}

### Error Handling
- **400 Bad Request** – Invalid or missing pagination parameters.
- **401 Unauthorized** – Authentication credentials are missing or invalid.
- **500 Internal Server Error** – Unexpected server error.
```

--------------------------------

### Omie API Error Response

Source: https://app.omie.com.br/api/v1/financas/mf

Structure for handling errors returned by the Omie API.

```APIDOC
## omie_fail

### Description
This object represents an error response from the Omie API.

### Fields
- **code** (integer) - The error code.
- **description** (text) - A description of the error.
- **referer** (text) - The origin or source of the error.
- **fatal** (boolean) - Indicates whether the error is fatal.
```

--------------------------------

### Movement Array Structure

Source: https://app.omie.com.br/api/v1/financas/mf

Defines the structure for an array of financial movements.

```APIDOC
## movimentosArray

### Description
This represents an array of financial movement objects. Each element in the array corresponds to a specific financial transaction.

### Content
An array of `movimentos` objects.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.