OLolist
Contas a receber

Listar contas a receber

Changed on
get/contas-receber

Request

  • Base URL
    https://api.tiny.com.br/public-api/v3
  • URL
    https://api.tiny.com.br/public-api/v3/contas-receber
  • Auth
    HTTP bearer

Query parameters

nomeClientestring

Pesquisa por nome do cliente de contas a receber

situacao'aberto' | 'cancelada' | 'pago' | 'parcial' | 'prevista' | 'atrasadas' | 'emissao'

Pesquisa por situação de contas a receber

  • aberto - Aberto
  • cancelada - Cancelada
  • pago - Pago
  • parcial - Parcial
  • prevista - Prevista
  • atrasadas - Atrasadas
  • emissao - Emissao
dataInicialEmissaostring
Example:2024-01-01

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

dataFinalEmissaostring
Example:2024-01-01

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

dataInicialVencimentostring
Example:2024-01-01

Pesquisa por data inicial do vencimento de contas a receber

dataFinalVencimentostring
Example:2024-01-01

Pesquisa por data final do vencimento de contas a receber

numeroDocumentostring

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

numeroBancostring

Pesquisa por número do banco de contas a receber

idNotainteger

Pesquisa por identificador da nota de contas a receber

idVendainteger

Pesquisa por identificador da venda de contas a receber

marcadoresstring[]

Pesquisa por marcadores

dataAtualizacaostring
Example:2024-01-01 10:00:00

Pesquisa por data de atualização, no horário de Brasília. Vale para qualquer situação

orderBy'asc' | 'desc'

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

  • asc - Crescente
  • desc - Descrescente
limitinteger

Limite da paginação

offsetinteger

Offset da paginação

Response

OK

Example response

{
  "itens": [
    {
      "data": "2024-01-01",
      "dataVencimento": "2024-01-01",
      "dataAtualizacao": "2024-01-01 10:00:00"
    }
  ]
}

Changes

  • 107f8d039de2Revision changes
    • info

      added the new optional query request parameter dataAtualizacao

    • info

      added the optional property /// to the response with the status