> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> O objeto Receivable

Um `receivable` é um valor que você tem a receber de uma venda: quanto vai cair na
conta e em que data. Toda venda aprovada gera um ou mais receivables, e cada um já
nasce com valor e data previstos — você não espera o dinheiro liquidar para
enxergar o que tem a receber.

Numa venda parcelada, cada parcela é um receivable separado: uma venda em 3x gera
3 receivables, um por parcela.

`amount` está em centavos e já é o valor **líquido** — o que entra na sua conta
depois das taxas.

O receivable nasce do processamento da venda — não é criado nem alterado por
integrações. Use-o para previsão de caixa, agenda de recebimentos e conciliação
entre venda, recebível e liquidação.

<Note>
  Você só vê os receivables destinados a você. Com a sua API key, vê os da sua
  organização — o `principal` das suas vendas, já líquido. Uma plataforma vê a
  parte dela (`platform_fee`). A comissão da Chargefy não é retornada.
</Note>

## Data Object

Este é o formato completo retornado em `get`, itens de `list` e em `data.object`
dos webhooks `receivable.*`.

```json theme={}
{
  "id": "rec_123",
  "object": "receivable",
  "amount": 7830,
  "charge": "ch_123",
  "created_at": "2026-05-22T00:00:00Z",
  "currency": "brl",
  "expected_at": "2026-06-22T00:00:00Z",
  "installment": 1,
  "livemode": true,
  "metadata": {},
  "organization": "org_123",
  "payment_intent": "pi_123",
  "platform": null,
  "recipient": "organization",
  "settled_at": null,
  "source_organization": "org_123",
  "status": "pending",
  "type": "principal",
  "updated_at": null
}
```

<ResponseField name="id" type="string">
  Identificador do recebível. Usa o prefixo `rec_*`.
</ResponseField>

<ResponseField name="object" type="string">
  Sempre `"receivable"`.
</ResponseField>

<ResponseField name="amount" type="integer">
  Valor depositável esperado para o beneficiário deste recebível, em centavos.
</ResponseField>

<ResponseField name="charge" type="string">
  ID da charge que originou o recebível (`ch_*`).
</ResponseField>

<ResponseField name="currency" type="string">
  Moeda de três letras, em minúsculas (ex.: `brl`).
</ResponseField>

<ResponseField name="expected_at" type="string | null">
  Data prevista de liquidação, em ISO-8601. Pode ser `null` até a agenda de
  liquidação ser confirmada.
</ResponseField>

<ResponseField name="installment" type="integer | null">
  Número da parcela (1-based). Para pagamento à vista é `1`.
</ResponseField>

<ResponseField name="metadata" type="object">
  Pares chave-valor livres. Quando vazio, retorna `{}`.
</ResponseField>

<ResponseField name="organization" type="string | null">
  Organização recebedora, quando `recipient` é `"organization"`; caso contrário
  `null`.
</ResponseField>

<ResponseField name="payment_intent" type="string | null">
  ID do payment intent associado (`pi_*`), quando disponível.
</ResponseField>

<ResponseField name="platform" type="string | null">
  Plataforma de contexto, quando a venda veio por uma plataforma. Também
  identifica o recebedor quando `recipient` é `"platform"`. `null` em venda
  direta.
</ResponseField>

<ResponseField name="recipient" type="string | null">
  Classe do beneficiário econômico do recebível: `organization`, `platform` ou
  `chargefy`.
</ResponseField>

<ResponseField name="settled_at" type="string | null">
  Momento em que o recebível foi efetivamente liquidado, em ISO-8601. `null`
  enquanto pendente.
</ResponseField>

<ResponseField name="source_organization" type="string | null">
  Organização que originou a venda. Presente em todos os recebíveis da venda,
  inclusive os das taxas.
</ResponseField>

<ResponseField name="status" type="string">
  Estado do recebível: `pending`, `paid`, `canceled` ou `refunded`.
</ResponseField>

<ResponseField name="type" type="string | null">
  Perna do recebível: `principal` (vendedor), `chargefy_fee` (Chargefy) ou
  `platform_fee` (plataforma).
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Momento da última atualização, em ISO-8601.
</ResponseField>
