Pular para o conteúdo
AGROsOpenAGROs
Navegaçãomenu

REST API · Fato

Receivables

Contas a receberOs títulos a receber, com emissão, vencimento e sinais de baixa.

Mesmas regras de Payables: sem situação derivada, e amount diferente de finalAmount. Fazenda, conferência manual, vínculo bancário e Livro Caixa vêm como sinais independentes.

Endereço
/v1/openagros/receivables
Chave
id
Escopo
finance.read
Campos
21
REST não filtra

A superfície REST aceita apenas page e pageSize. Para filtrar ou ordenar no servidor, use OData; em REST, o recorte é do lado do cliente.

Campos

CampoO que éTipoNulo
idchaveIdentificador da linha.Edm.Int64inteiro
issueDateData de emissão.Edm.Datedatasim
dueDateData de vencimento.Edm.Datedatasim
paymentDateData de pagamento informada.Edm.Datedatasim
settlementDateData de liquidação informada.Edm.Datedatasim
counterpartyContraparte (cliente ou fornecedor).Edm.Stringtextosim
farmNome da fazenda.Edm.Stringtextosim
farmKeyChave de relacionamento com a fazenda.Edm.Stringtextosim
documentDocumento.Edm.Stringtextosim
titleTítulo.Edm.Stringtextosim
groupGrupo.Edm.Stringtextosim
accountConta.Edm.Stringtextosim
subaccountSubconta.Edm.Stringtextosim
reconciledDateData de conferência manual posterior à baixa. Não é sinônimo de paid.Edm.Datedatasim
bankEntryIdChave do lançamento bancário correspondente ao título, quando existir.Edm.Doublenúmerosim
cashBookSe o título participa do Livro Caixa.Edm.Booleanbooleano
amountValor do título.Edm.Doublenúmero
finalAmountValor final, já com juros e desconto.Edm.Doublenúmero
interestJuros.Edm.Doublenúmerosim
discountDesconto.Edm.Doublenúmerosim
paidSinal de baixa informado.Edm.Booleanbooleano

Exemplos

curl
curl -H "Authorization: Bearer oag_SEU_TOKEN" \
  "https://service.agrosti.com.br/v1/openagros/receivables?pageSize=200&page=1"

Sintaxe completa em REST API.