v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Packages API

Create a Package

post/v1/organizations/{organization_id}/packages

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

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>

Request body

createdAtstring date-time required

deletedAtstring date-time nullable required

descriptionstring nullable required

enableboolean nullable required

feeGroupLabelstring required

feesobject required

idstring required

ledgerIdstring required

maximumAmountstring required

minimumAmountstring required

segmentIdstring required

transactionRoutestring nullable required

updatedAtstring date-time required

waivedAccountsstring[] nullable required

Example request

{
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Pacote de taxas administrativas padrão",
  "feeGroupLabel": "Pacote Padrão",
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "maximumAmount": "2",
  "minimumAmount": "100",
  "segmentId": "00000000-0000-0000-0000-000000000000",
  "transactionRoute": "debitoted",
  "updatedAt": "2021-01-01T00:00:00Z",
  "waivedAccounts": [
    "acc001",
    "acc002"
  ]
}

Response