Skip to main content
GET
Get an entry
The entry is a charge (line item) of the invoice: it counts toward the invoice amount while its status is OPEN. Any member of the organization, or an admin of the realm, can read it.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization that issued the invoice.

Format: UUID

invoiceId
string<uuid>
required

ID of the invoice the entry belongs to.

Format: UUID

invoiceEntryId
string<uuid>
required

ID of the entry, as returned by GET .../invoices/{invoiceId}/entries.

Format: UUID

Response

Successful response

One charge (line item) of an invoice. The invoice amount is the sum of the amounts of its OPEN entries.

id
string<uuid>
required

ID of the entry.

Example:

"3f9a1c2e-7b4d-4e8a-9c1f-2d5b6a7c8e90"

identifier
string
required

What the charge is for: the identifier of the deal product that generated the entry, or the label sent when it was added through the API. Free text.

Example:

"MONTHLY_PLAN"

invoice
string<uuid>
required

ID of the invoice the entry belongs to.

Example:

"0b7c2a44-6f1e-4d3b-9a8e-5c2f1d0e9b7a"

amount
integer
required

Amount of the charge in centavos (15000 is R$ 150,00). It counts toward the invoice amount while the entry is OPEN.

Example:

15000

chargeMethod
enum<string>
required

When the charge is collected. LATER: it is added to the invoice and paid with it. INSTANT: it is also debited from the payer's Portão 3 account as soon as it is added.

Available options:
INSTANT,
LATER
Example:

"LATER"

productType
enum<string>
required

When the charge's product is billed. RECURRENT: on every invoice of the deal. ONE_TIME: on the first invoice only. ON_EVENT: never automatically; such an entry is added through the API, when the event happens.

Available options:
RECURRENT,
ONE_TIME,
ON_EVENT
Example:

"RECURRENT"

effectiveAt
string<date-time>
required

When the entry took effect: the moment it was created.

Example:

"2026-10-01T09:00:00.000Z"

external
object
required

References of the entry outside the invoice.

description
string
required

Free text describing the charge. Empty when there is none.

Example:

"Mensalidade do plano Pro"

status
enum<string>
required

OPEN: the entry counts toward the invoice amount. DELETED: the entry was deleted and no longer counts.

Available options:
OPEN,
DELETED
Example:

"OPEN"

createdBy
string
required

ID of who created the entry: the authenticated caller of the API that added it, or the Portão 3 service that generated it from the deal.

Example:

"5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b"

updatedBy
string
required

ID of who last changed the entry: who created it, until someone deletes it.

Example:

"5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b"

createdAt
string<date-time>
required

When the entry was created. Entries added in the same request are one minute apart, in the order they were sent, so that a listing keeps that order.

Example:

"2026-10-01T09:00:00.000Z"

updatedAt
string<date-time>
required

When the entry was last changed. Deleting an entry does not refresh it.

Example:

"2026-10-01T09:00:00.000Z"