GET {folder}/TitulosPagar/{token}/{colecao}/{campo}/{orderBy}/{pageSize}/{pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required

colecao

integer

Default value is 0

campo

integer

Default value is 0

orderBy

integer

Default value is 0

pageSize

integer

Default value is 0

pageNumber

integer

Default value is 0

folder

string

None.

Body Parameters

None.

Response Information

Resource Description

RetornoTitulosPagar
NameDescriptionTypeAdditional information
Registros

Collection of TitulosPagarRetorno

None.

TotalDeRegistros

integer

None.

ItensPorPagina

integer

None.

PaginaAtual

integer

None.

Totais

Dictionary of string [key] and Object [value]

None.

TotalDePaginas

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Registros": [
    {
      "idTituloPagar": 1,
      "idPessoaEmpresaVarejista": 2,
      "idPessoaFornecedor": 3,
      "nrCNPJEmpresaVarejista": "sample string 4",
      "dsFantasiaEmpresaVarejista": "sample string 5",
      "nrCPFCNPJFornecedor": "sample string 6",
      "dsFantasiaFornecedor": "sample string 7",
      "cdFornecedor": "sample string 8",
      "cdTituloERP": "sample string 9",
      "dtEmissaoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "dtVencimentoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "vlTitulo": 1.0,
      "vlPago": 1.0,
      "dtPagamentoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "nrParcela": 1,
      "nrTitulo": "sample string 10",
      "nrNota": "sample string 11",
      "dtEmissaoNota": "2025-12-06T02:01:26.0095067-03:00",
      "dtEntradaNota": "2025-12-06T02:01:26.0095067-03:00",
      "vlTotalNota": 1.0,
      "dtInsert": "2025-12-06T02:01:26.0095067-03:00",
      "dtUltimaAtualizacao": "2025-12-06T02:01:26.0095067-03:00"
    },
    {
      "idTituloPagar": 1,
      "idPessoaEmpresaVarejista": 2,
      "idPessoaFornecedor": 3,
      "nrCNPJEmpresaVarejista": "sample string 4",
      "dsFantasiaEmpresaVarejista": "sample string 5",
      "nrCPFCNPJFornecedor": "sample string 6",
      "dsFantasiaFornecedor": "sample string 7",
      "cdFornecedor": "sample string 8",
      "cdTituloERP": "sample string 9",
      "dtEmissaoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "dtVencimentoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "vlTitulo": 1.0,
      "vlPago": 1.0,
      "dtPagamentoTitulo": "2025-12-06T02:01:26.0085063-03:00",
      "nrParcela": 1,
      "nrTitulo": "sample string 10",
      "nrNota": "sample string 11",
      "dtEmissaoNota": "2025-12-06T02:01:26.0095067-03:00",
      "dtEntradaNota": "2025-12-06T02:01:26.0095067-03:00",
      "vlTotalNota": 1.0,
      "dtInsert": "2025-12-06T02:01:26.0095067-03:00",
      "dtUltimaAtualizacao": "2025-12-06T02:01:26.0095067-03:00"
    }
  ],
  "TotalDeRegistros": 1,
  "ItensPorPagina": 2,
  "PaginaAtual": 3,
  "Totais": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "TotalDePaginas": 4
}

application/xml, text/xml

Sample:
<RetornoTitulosPagar xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models.Object">
  <ItensPorPagina>2</ItensPorPagina>
  <PaginaAtual>3</PaginaAtual>
  <Registros>
    <TitulosPagarRetorno>
      <cdFornecedor>sample string 8</cdFornecedor>
      <cdTituloERP>sample string 9</cdTituloERP>
      <dsFantasiaEmpresaVarejista>sample string 5</dsFantasiaEmpresaVarejista>
      <dsFantasiaFornecedor>sample string 7</dsFantasiaFornecedor>
      <dtEmissaoNota>2025-12-06T02:01:26.0095067-03:00</dtEmissaoNota>
      <dtEmissaoTitulo>2025-12-06T02:01:26.0085063-03:00</dtEmissaoTitulo>
      <dtEntradaNota>2025-12-06T02:01:26.0095067-03:00</dtEntradaNota>
      <dtInsert>2025-12-06T02:01:26.0095067-03:00</dtInsert>
      <dtPagamentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtPagamentoTitulo>
      <dtUltimaAtualizacao>2025-12-06T02:01:26.0095067-03:00</dtUltimaAtualizacao>
      <dtVencimentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtVencimentoTitulo>
      <idPessoaEmpresaVarejista>2</idPessoaEmpresaVarejista>
      <idPessoaFornecedor>3</idPessoaFornecedor>
      <idTituloPagar>1</idTituloPagar>
      <nrCNPJEmpresaVarejista>sample string 4</nrCNPJEmpresaVarejista>
      <nrCPFCNPJFornecedor>sample string 6</nrCPFCNPJFornecedor>
      <nrNota>sample string 11</nrNota>
      <nrParcela>1</nrParcela>
      <nrTitulo>sample string 10</nrTitulo>
      <vlPago>1</vlPago>
      <vlTitulo>1</vlTitulo>
      <vlTotalNota>1</vlTotalNota>
    </TitulosPagarRetorno>
    <TitulosPagarRetorno>
      <cdFornecedor>sample string 8</cdFornecedor>
      <cdTituloERP>sample string 9</cdTituloERP>
      <dsFantasiaEmpresaVarejista>sample string 5</dsFantasiaEmpresaVarejista>
      <dsFantasiaFornecedor>sample string 7</dsFantasiaFornecedor>
      <dtEmissaoNota>2025-12-06T02:01:26.0095067-03:00</dtEmissaoNota>
      <dtEmissaoTitulo>2025-12-06T02:01:26.0085063-03:00</dtEmissaoTitulo>
      <dtEntradaNota>2025-12-06T02:01:26.0095067-03:00</dtEntradaNota>
      <dtInsert>2025-12-06T02:01:26.0095067-03:00</dtInsert>
      <dtPagamentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtPagamentoTitulo>
      <dtUltimaAtualizacao>2025-12-06T02:01:26.0095067-03:00</dtUltimaAtualizacao>
      <dtVencimentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtVencimentoTitulo>
      <idPessoaEmpresaVarejista>2</idPessoaEmpresaVarejista>
      <idPessoaFornecedor>3</idPessoaFornecedor>
      <idTituloPagar>1</idTituloPagar>
      <nrCNPJEmpresaVarejista>sample string 4</nrCNPJEmpresaVarejista>
      <nrCPFCNPJFornecedor>sample string 6</nrCPFCNPJFornecedor>
      <nrNota>sample string 11</nrNota>
      <nrParcela>1</nrParcela>
      <nrTitulo>sample string 10</nrTitulo>
      <vlPago>1</vlPago>
      <vlTitulo>1</vlTitulo>
      <vlTotalNota>1</vlTotalNota>
    </TitulosPagarRetorno>
  </Registros>
  <Totais xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Totais>
  <TotalDePaginas>4</TotalDePaginas>
  <TotalDeRegistros>1</TotalDeRegistros>
</RetornoTitulosPagar>

multipart/form-data

Sample:
<RetornoTitulosPagar xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models.Object"><ItensPorPagina>2</ItensPorPagina><PaginaAtual>3</PaginaAtual><Registros><TitulosPagarRetorno><cdFornecedor>sample string 8</cdFornecedor><cdTituloERP>sample string 9</cdTituloERP><dsFantasiaEmpresaVarejista>sample string 5</dsFantasiaEmpresaVarejista><dsFantasiaFornecedor>sample string 7</dsFantasiaFornecedor><dtEmissaoNota>2025-12-06T02:01:26.0095067-03:00</dtEmissaoNota><dtEmissaoTitulo>2025-12-06T02:01:26.0085063-03:00</dtEmissaoTitulo><dtEntradaNota>2025-12-06T02:01:26.0095067-03:00</dtEntradaNota><dtInsert>2025-12-06T02:01:26.0095067-03:00</dtInsert><dtPagamentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtPagamentoTitulo><dtUltimaAtualizacao>2025-12-06T02:01:26.0095067-03:00</dtUltimaAtualizacao><dtVencimentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtVencimentoTitulo><idPessoaEmpresaVarejista>2</idPessoaEmpresaVarejista><idPessoaFornecedor>3</idPessoaFornecedor><idTituloPagar>1</idTituloPagar><nrCNPJEmpresaVarejista>sample string 4</nrCNPJEmpresaVarejista><nrCPFCNPJFornecedor>sample string 6</nrCPFCNPJFornecedor><nrNota>sample string 11</nrNota><nrParcela>1</nrParcela><nrTitulo>sample string 10</nrTitulo><vlPago>1</vlPago><vlTitulo>1</vlTitulo><vlTotalNota>1</vlTotalNota></TitulosPagarRetorno><TitulosPagarRetorno><cdFornecedor>sample string 8</cdFornecedor><cdTituloERP>sample string 9</cdTituloERP><dsFantasiaEmpresaVarejista>sample string 5</dsFantasiaEmpresaVarejista><dsFantasiaFornecedor>sample string 7</dsFantasiaFornecedor><dtEmissaoNota>2025-12-06T02:01:26.0095067-03:00</dtEmissaoNota><dtEmissaoTitulo>2025-12-06T02:01:26.0085063-03:00</dtEmissaoTitulo><dtEntradaNota>2025-12-06T02:01:26.0095067-03:00</dtEntradaNota><dtInsert>2025-12-06T02:01:26.0095067-03:00</dtInsert><dtPagamentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtPagamentoTitulo><dtUltimaAtualizacao>2025-12-06T02:01:26.0095067-03:00</dtUltimaAtualizacao><dtVencimentoTitulo>2025-12-06T02:01:26.0085063-03:00</dtVencimentoTitulo><idPessoaEmpresaVarejista>2</idPessoaEmpresaVarejista><idPessoaFornecedor>3</idPessoaFornecedor><idTituloPagar>1</idTituloPagar><nrCNPJEmpresaVarejista>sample string 4</nrCNPJEmpresaVarejista><nrCPFCNPJFornecedor>sample string 6</nrCPFCNPJFornecedor><nrNota>sample string 11</nrNota><nrParcela>1</nrParcela><nrTitulo>sample string 10</nrTitulo><vlPago>1</vlPago><vlTitulo>1</vlTitulo><vlTotalNota>1</vlTotalNota></TitulosPagarRetorno></Registros><Totais xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringanyType><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value /></d2p1:KeyValueOfstringanyType><d2p1:KeyValueOfstringanyType><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value /></d2p1:KeyValueOfstringanyType></Totais><TotalDePaginas>4</TotalDePaginas><TotalDeRegistros>1</TotalDeRegistros></RetornoTitulosPagar>