Get package

GET /v1/organizations/{organization_id}/packages/{package_id}

Get package

cURL

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/packages/{package_id}

200

{
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enable": true,
  "feeGroupLabel": "<string>",
  "fees": {},
  "id": "<string>",
  "ledgerId": "<string>",
  "maximumAmount": "<string>",
  "minimumAmount": "<string>",
  "segmentId": "<string>",
  "transactionRoute": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "waivedAccounts": [
    "<string>"
  ]
}

Headers

X-Request-Id · string<uuid>

A unique identifier used to trace and track each request.

Authorization · string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id · string<uuid> · required

The unique identifier of the Organization associated with the Ledger.

package_id · string · required

Package ID (UUID)

Response

200

application/json

OK

createdAt · string<date-time> · required

Example:

"2021-01-01T00:00:00Z"

deletedAt · string<date-time> | null · required

Example:

"2021-01-01T00:00:00Z"

description · string | null · required

Example:

"Pacote de taxas administrativas padrão"

enable · boolean | null · required

feeGroupLabel · string · required

Example:

"Pacote Padrão"

fees · object · required

Show child attributes

id · string · required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId · string · required

Example:

"00000000-0000-0000-0000-000000000000"

maximumAmount · string · required

Example:

"2"

minimumAmount · string · required

Example:

"100"

segmentId · string · required

Example:

"00000000-0000-0000-0000-000000000000"

transactionRoute · string | null · required

Example:

"debitoted"

updatedAt · string<date-time> · required

Example:

"2021-01-01T00:00:00Z"

waivedAccounts · string[] | null · required

Example:

["acc001", "acc002"]