Skip to main content
GET
/
contas-receber
Listar contas a receber
curl --request GET \
  --url https://api.tiny.com.br/public-api/v3/contas-receber \
  --header 'Authorization: Bearer <token>'
{
  "itens": [
    {
      "id": 123,
      "situacao": "aberto",
      "data": "2024-01-01",
      "dataVencimento": "2024-01-01",
      "historico": "<string>",
      "valor": 123,
      "numeroDocumento": "<string>",
      "numeroBanco": "<string>",
      "serieDocumento": "<string>",
      "cliente": {
        "nome": "<string>",
        "codigo": "<string>",
        "fantasia": "<string>",
        "tipoPessoa": "J",
        "cpfCnpj": "<string>",
        "inscricaoEstadual": "<string>",
        "rg": "<string>",
        "telefone": "<string>",
        "celular": "<string>",
        "email": "<string>",
        "endereco": {
          "endereco": "<string>",
          "numero": "<string>",
          "complemento": "<string>",
          "bairro": "<string>",
          "municipio": "<string>",
          "cep": "<string>",
          "uf": "<string>",
          "pais": "<string>"
        },
        "id": 123
      },
      "quantidadeParcelasAntecipadas": 123,
      "saldo": 123
    }
  ],
  "paginacao": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Query Parameters

nomeCliente
string

Pesquisa por nome do cliente de contas a receber

situacao
enum<string>

Pesquisa por situação de contas a receber

  • aberto - Aberto
  • cancelada - Cancelada
  • pago - Pago
  • parcial - Parcial
  • prevista - Prevista
  • atrasadas - Atrasadas
  • emissao - Emissao
Available options:
aberto,
cancelada,
pago,
parcial,
prevista,
atrasadas,
emissao
dataInicialEmissao
string

Pesquisa por data inicial da emissão de contas a receber

Example:

"2024-01-01"

dataFinalEmissao
string

Pesquisa por data final da emissão de contas a receber

Example:

"2024-01-01"

dataInicialVencimento
string

Pesquisa por data inicial do vencimento de contas a receber

Example:

"2024-01-01"

dataFinalVencimento
string

Pesquisa por data final do vencimento de contas a receber

Example:

"2024-01-01"

numeroDocumento
string

Pesquisa por número do documento de contas a receber. O número do documento é a concatenação do campo serie + numeroDocumento

numeroBanco
string

Pesquisa por número do banco de contas a receber

idNota
integer

Pesquisa por identificador da nota de contas a receber

idVenda
integer

Pesquisa por identificador da venda de contas a receber

marcadores
string[]

Pesquisa por marcadores

orderBy
enum<string>

Define a ordenação da listagem por ordem crescente ou decrescente

  • asc - Crescente
  • desc - Descrescente
Available options:
asc,
desc
limit
integer
default:100

Limite da paginação

offset
integer
default:0

Offset da paginação

Response

OK

itens
· object[]
paginacao
· object