Clara · JSON-LD Context

Clara Cc Context

JSON-LD context defining the semantic vocabulary for Clara Cc from Clara.

35 Classes 64 Properties 4 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

dcterms: http://purl.org/dc/terms/

clara: https://clara.com/schema#

Classes

GetApiTestV3TransactionsResponse PostApiTestV3WebhooksEventsRequest PostApiTestV3WebhooksEventsResponse PostApiTestV3WebhooksSubscriptionsRequest PostApiV1SubscribersRequest GetApiV1VcnResponse PostApiV1VcnCardRequest PostApiV1VcnCardResponse PutApiV1VcnCardIdRequest PutApiV1VcnCardIdResponse PostApiV1VcnCardIdCancelResponse PostApiV2CardsUuidConfigurationsRequest PostApiV2CardsUuidConfigurationsResponse PostApiV2PaymentsRequest PostApiV2PaymentsResponse GetApiV3AccountsPayableResponse PostApiV3AccountsPayablePixRequest PostApiV3AccountsPayablePixResponse DeleteApiV3AccountsPayablePixExternalidResponse GetApiV3AccountsPayableExternalidResponse GetApiV3BillingStatementsResponse GetApiV3BillingStatementsUuidTransactionsResponse GetApiV3CardsResponse PostApiV3CardsRequest PostApiV3CardsResponse PatchApiV3CardsUuidLockRequest GetApiV3DigitalAccountsResponse GetApiV3DigitalAccountsBalanceResponse GetApiV3TransactionsUuidDocumentsResponse GetApiV3TransactionsUuidExtractedDocumentsResponse GetApiV3UsersResponse PostApiV3WebhooksSubscriptionsRequest PostApiV3WebhooksEntityResendRequest PostApiV3WebhooksEntityResendResponse PostOauthTokenResponse

Properties

Property	Type	Container
eventId	string
event	string
environment	string
outcome	string
deliveries		list
status	string
type	string
modelVersion	integer
data
callbackUrl	string
secret	string
events		list
rcnId	string
supplierId	string
templateId	string
amount	decimal
validFrom	string
validTo	string
cardNumber	string
cvv	string
expirationDate	string
id	string
period
atmCashLimit	decimal
weekdays
merchants
configurationId	string
barcodeDigitableLine	string
paymentId	string
content		list
totalElements	integer
totalPages	integer
size	integer
number	integer
paymentMethod.dictKey	string
paymentMethod.dictKeyType	string
paymentMethod.qrCode	string
beneficiary
externalId	string
uuid	string
statementStartDate	string
statementEndDate	string
currency	string
totalAmount	decimal
generatedAt	string
alias	string
userUuid	string
threshold	decimal
periodicity	string
businessType	string
maskedPan	string
user
lockCode	integer
meta
checkingAccount.available	decimal
collateralAccount.available	decimal
documents		list
extractedDocuments		list
entity	string
statuses		list
eventIds		list
resendId	string
access_token	string
expires_in	integer

JSON-LD Document

{
  "@context": {
    "@vocab": "https://clara.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "clara": "https://clara.com/schema#",
    "GetApiTestV3TransactionsResponse": "clara:GetApiTestV3TransactionsResponse",
    "eventId": {
      "@id": "clara:eventId",
      "@type": "xsd:string"
    },
    "event": {
      "@id": "clara:event",
      "@type": "xsd:string"
    },
    "environment": {
      "@id": "clara:environment",
      "@type": "xsd:string"
    },
    "outcome": {
      "@id": "clara:outcome",
      "@type": "xsd:string"
    },
    "deliveries": {
      "@id": "clara:deliveries",
      "@container": "@list"
    },
    "PostApiTestV3WebhooksEventsRequest": "clara:PostApiTestV3WebhooksEventsRequest",
    "status": {
      "@id": "clara:status",
      "@type": "xsd:string"
    },
    "type": {
      "@id": "clara:type",
      "@type": "xsd:string"
    },
    "modelVersion": {
      "@id": "clara:modelVersion",
      "@type": "xsd:integer"
    },
    "data": {
      "@id": "clara:data"
    },
    "PostApiTestV3WebhooksEventsResponse": "clara:PostApiTestV3WebhooksEventsResponse",
    "PostApiTestV3WebhooksSubscriptionsRequest": "clara:PostApiTestV3WebhooksSubscriptionsRequest",
    "callbackUrl": {
      "@id": "clara:callbackUrl",
      "@type": "xsd:string"
    },
    "secret": {
      "@id": "clara:secret",
      "@type": "xsd:string"
    },
    "events": {
      "@id": "clara:events",
      "@container": "@list"
    },
    "PostApiV1SubscribersRequest": "clara:PostApiV1SubscribersRequest",
    "GetApiV1VcnResponse": "clara:GetApiV1VcnResponse",
    "rcnId": {
      "@id": "clara:rcnId",
      "@type": "xsd:string"
    },
    "supplierId": {
      "@id": "clara:supplierId",
      "@type": "xsd:string"
    },
    "templateId": {
      "@id": "clara:templateId",
      "@type": "xsd:string"
    },
    "PostApiV1VcnCardRequest": "clara:PostApiV1VcnCardRequest",
    "amount": {
      "@id": "clara:amount",
      "@type": "xsd:decimal"
    },
    "validFrom": {
      "@id": "clara:validFrom",
      "@type": "xsd:string"
    },
    "validTo": {
      "@id": "clara:validTo",
      "@type": "xsd:string"
    },
    "PostApiV1VcnCardResponse": "clara:PostApiV1VcnCardResponse",
    "cardNumber": {
      "@id": "clara:cardNumber",
      "@type": "xsd:string"
    },
    "cvv": {
      "@id": "clara:cvv",
      "@type": "xsd:string"
    },
    "expirationDate": {
      "@id": "clara:expirationDate",
      "@type": "xsd:string"
    },
    "id": {
      "@id": "clara:id",
      "@type": "xsd:string"
    },
    "PutApiV1VcnCardIdRequest": "clara:PutApiV1VcnCardIdRequest",
    "PutApiV1VcnCardIdResponse": "clara:PutApiV1VcnCardIdResponse",
    "PostApiV1VcnCardIdCancelResponse": "clara:PostApiV1VcnCardIdCancelResponse",
    "PostApiV2CardsUuidConfigurationsRequest": "clara:PostApiV2CardsUuidConfigurationsRequest",
    "period": {
      "@id": "clara:period"
    },
    "atmCashLimit": {
      "@id": "clara:atmCashLimit",
      "@type": "xsd:decimal"
    },
    "weekdays": {
      "@id": "clara:weekdays"
    },
    "merchants": {
      "@id": "clara:merchants"
    },
    "PostApiV2CardsUuidConfigurationsResponse": "clara:PostApiV2CardsUuidConfigurationsResponse",
    "configurationId": {
      "@id": "clara:configurationId",
      "@type": "xsd:string"
    },
    "PostApiV2PaymentsRequest": "clara:PostApiV2PaymentsRequest",
    "barcodeDigitableLine": {
      "@id": "clara:barcodeDigitableLine",
      "@type": "xsd:string"
    },
    "PostApiV2PaymentsResponse": "clara:PostApiV2PaymentsResponse",
    "paymentId": {
      "@id": "clara:paymentId",
      "@type": "xsd:string"
    },
    "GetApiV3AccountsPayableResponse": "clara:GetApiV3AccountsPayableResponse",
    "content": {
      "@id": "clara:content",
      "@container": "@list"
    },
    "totalElements": {
      "@id": "clara:totalElements",
      "@type": "xsd:integer"
    },
    "totalPages": {
      "@id": "clara:totalPages",
      "@type": "xsd:integer"
    },
    "size": {
      "@id": "clara:size",
      "@type": "xsd:integer"
    },
    "number": {
      "@id": "clara:number",
      "@type": "xsd:integer"
    },
    "PostApiV3AccountsPayablePixRequest": "clara:PostApiV3AccountsPayablePixRequest",
    "paymentMethod.dictKey": {
      "@id": "clara:paymentMethod.dictKey",
      "@type": "xsd:string"
    },
    "paymentMethod.dictKeyType": {
      "@id": "clara:paymentMethod.dictKeyType",
      "@type": "xsd:string"
    },
    "paymentMethod.qrCode": {
      "@id": "clara:paymentMethod.qrCode",
      "@type": "xsd:string"
    },
    "beneficiary": {
      "@id": "clara:beneficiary"
    },
    "externalId": {
      "@id": "clara:externalId",
      "@type": "xsd:string"
    },
    "PostApiV3AccountsPayablePixResponse": "clara:PostApiV3AccountsPayablePixResponse",
    "DeleteApiV3AccountsPayablePixExternalidResponse": "clara:DeleteApiV3AccountsPayablePixExternalidResponse",
    "GetApiV3AccountsPayableExternalidResponse": "clara:GetApiV3AccountsPayableExternalidResponse",
    "GetApiV3BillingStatementsResponse": "clara:GetApiV3BillingStatementsResponse",
    "uuid": {
      "@id": "clara:uuid",
      "@type": "xsd:string"
    },
    "statementStartDate": {
      "@id": "clara:statementStartDate",
      "@type": "xsd:string"
    },
    "statementEndDate": {
      "@id": "clara:statementEndDate",
      "@type": "xsd:string"
    },
    "currency": {
      "@id": "clara:currency",
      "@type": "xsd:string"
    },
    "totalAmount": {
      "@id": "clara:totalAmount",
      "@type": "xsd:decimal"
    },
    "generatedAt": {
      "@id": "clara:generatedAt",
      "@type": "xsd:string"
    },
    "GetApiV3BillingStatementsUuidTransactionsResponse": "clara:GetApiV3BillingStatementsUuidTransactionsResponse",
    "GetApiV3CardsResponse": "clara:GetApiV3CardsResponse",
    "PostApiV3CardsRequest": "clara:PostApiV3CardsRequest",
    "alias": {
      "@id": "clara:alias",
      "@type": "xsd:string"
    },
    "userUuid": {
      "@id": "clara:userUuid",
      "@type": "xsd:string"
    },
    "threshold": {
      "@id": "clara:threshold",
      "@type": "xsd:decimal"
    },
    "periodicity": {
      "@id": "clara:periodicity",
      "@type": "xsd:string"
    },
    "businessType": {
      "@id": "clara:businessType",
      "@type": "xsd:string"
    },
    "PostApiV3CardsResponse": "clara:PostApiV3CardsResponse",
    "maskedPan": {
      "@id": "clara:maskedPan",
      "@type": "xsd:string"
    },
    "user": {
      "@id": "clara:user"
    },
    "PatchApiV3CardsUuidLockRequest": "clara:PatchApiV3CardsUuidLockRequest",
    "lockCode": {
      "@id": "clara:lockCode",
      "@type": "xsd:integer"
    },
    "GetApiV3DigitalAccountsResponse": "clara:GetApiV3DigitalAccountsResponse",
    "meta": {
      "@id": "clara:meta"
    },
    "GetApiV3DigitalAccountsBalanceResponse": "clara:GetApiV3DigitalAccountsBalanceResponse",
    "checkingAccount.available": {
      "@id": "clara:checkingAccount.available",
      "@type": "xsd:decimal"
    },
    "collateralAccount.available": {
      "@id": "clara:collateralAccount.available",
      "@type": "xsd:decimal"
    },
    "GetApiV3TransactionsUuidDocumentsResponse": "clara:GetApiV3TransactionsUuidDocumentsResponse",
    "documents": {
      "@id": "clara:documents",
      "@container": "@list"
    },
    "GetApiV3TransactionsUuidExtractedDocumentsResponse": "clara:GetApiV3TransactionsUuidExtractedDocumentsResponse",
    "extractedDocuments": {
      "@id": "clara:extractedDocuments",
      "@container": "@list"
    },
    "GetApiV3UsersResponse": "clara:GetApiV3UsersResponse",
    "PostApiV3WebhooksSubscriptionsRequest": "clara:PostApiV3WebhooksSubscriptionsRequest",
    "entity": {
      "@id": "clara:entity",
      "@type": "xsd:string"
    },
    "statuses": {
      "@id": "clara:statuses",
      "@container": "@list"
    },
    "PostApiV3WebhooksEntityResendRequest": "clara:PostApiV3WebhooksEntityResendRequest",
    "eventIds": {
      "@id": "clara:eventIds",
      "@container": "@list"
    },
    "PostApiV3WebhooksEntityResendResponse": "clara:PostApiV3WebhooksEntityResendResponse",
    "resendId": {
      "@id": "clara:resendId",
      "@type": "xsd:string"
    },
    "PostOauthTokenResponse": "clara:PostOauthTokenResponse",
    "access_token": {
      "@id": "clara:access_token",
      "@type": "xsd:string"
    },
    "expires_in": {
      "@id": "clara:expires_in",
      "@type": "xsd:integer"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Clara API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Clara's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-22) from openapi/_ae-authored/clara-cc-openapi-generated.yml.",
  "dcterms:created": "2026-10-22",
  "dcterms:source": [
    "openapi/_ae-authored/clara-cc-openapi-generated.yml"
  ]
}