REST API · Fato
Receivables
Contas a receber — Os 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
| Campo | O que é | Tipo | Nulo |
|---|---|---|---|
idchave | Identificador da linha. | Edm.Int64inteiro | — |
issueDate | Data de emissão. | Edm.Datedata | sim |
dueDate | Data de vencimento. | Edm.Datedata | sim |
paymentDate | Data de pagamento informada. | Edm.Datedata | sim |
settlementDate | Data de liquidação informada. | Edm.Datedata | sim |
counterparty | Contraparte (cliente ou fornecedor). | Edm.Stringtexto | sim |
farm | Nome da fazenda. | Edm.Stringtexto | sim |
farmKey | Chave de relacionamento com a fazenda. | Edm.Stringtexto | sim |
document | Documento. | Edm.Stringtexto | sim |
title | Título. | Edm.Stringtexto | sim |
group | Grupo. | Edm.Stringtexto | sim |
account | Conta. | Edm.Stringtexto | sim |
subaccount | Subconta. | Edm.Stringtexto | sim |
reconciledDate | Data de conferência manual posterior à baixa. Não é sinônimo de paid. | Edm.Datedata | sim |
bankEntryId | Chave do lançamento bancário correspondente ao título, quando existir. | Edm.Doublenúmero | sim |
cashBook | Se o título participa do Livro Caixa. | Edm.Booleanbooleano | — |
amount | Valor do título. | Edm.Doublenúmero | — |
finalAmount | Valor final, já com juros e desconto. | Edm.Doublenúmero | — |
interest | Juros. | Edm.Doublenúmero | sim |
discount | Desconto. | Edm.Doublenúmero | sim |
paid | Sinal 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.