Clarafintech · JSON-LD Context
Clarafintech Context
JSON-LD context defining the semantic vocabulary for Clarafintech from Clarafintech.
50 Classes
114 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
clarafintech:
https://clara.com/schema#
Classes
OAuthTokenResponse
ErrorResponse
Money
Periodicity
CardListType
CreateCardType
BusinessType
CardV3
CardUser
CardPageV3
CreateCardRequestV3
SetCardLockRequestV3
UpdateCardThresholdRequestV3
StatusObject
TransactionStatus
TransactionType
TransactionV3
TransactionPageV3
TransactionDocumentsResponseV3
UserRole
UserStatus
UserV3
UserPageV3
CreateUserRequestV3
CreateUserResponseV3
UpdateUserRequestV3
BulkTransactionLabelsRequestV3
InvoiceV3
TransactionInvoiceResponseV3
InvoicePageV3
ExtractedDocumentType
DocumentValidationStatus
ExtractedDocumentV3
ExtractedDocumentPageV3
ReimbursementStatus
LinkedResource
ReimbursementV3
ReimbursementPageV3
BillingStatementV3
DigitalAccountTransactionPageV3
AccountingStatus
PixPaymentMethodV3
PixBeneficiaryRequestV3
PixBeneficiaryV3
CreatePixPaymentRequestV3
PixPaymentAcceptedV3
PixPaymentErrorV3
PixPaymentV3
PixPaymentPageV3
DigitalAccountBalanceV3
Properties
| Property | Type | Container |
|---|---|---|
| access_token | string | |
| token_type | string | |
| expires_in | integer | |
| code | string | |
| message | string | |
| timestamp | dateTime | |
| details | list | |
| value | decimal | |
| amount | decimal | |
| currency | string | |
| uuid | string | |
| alias | string | |
| status | ||
| claraStatus | string | |
| lockCode | string | |
| maskedPan | string | |
| threshold | decimal | |
| periodicity | ||
| type | ||
| user | reference | |
| name | string | |
| fullName | string | |
| username | string | |
| string | ||
| content | list | |
| totalElements | integer | |
| totalPages | integer | |
| size | integer | |
| number | integer | |
| userUuid | string | |
| businessType | reference | |
| description | string | |
| transactionLabel | string | |
| amountValue | reference | |
| originalAmount | reference | |
| merchant | ||
| card | ||
| labels | list | |
| billingStatement | reference | |
| hasInvoice | boolean | |
| hasAttachments | boolean | |
| hasExtractedDocuments | boolean | |
| accountingFields | list | |
| accountingStatus | reference | |
| attachments | list | |
| lastName | string | |
| mobilePhone | string | |
| taxIdentifier | string | |
| role | reference | |
| erpId | string | |
| createdAt | dateTime | |
| groups | list | |
| cards | list | |
| manager | reference | |
| location | reference | |
| lada | string | |
| managerUuid | string | |
| locationUuid | string | |
| foreign | boolean | |
| groupsToAdd | list | |
| groupsToRemove | list | |
| cleanGroups | boolean | |
| transactions | list | |
| invoiceId | string | |
| invoiceNumber | string | |
| taxRegime | string | |
| issuer | ||
| taxReceipts | ||
| tax | ||
| documentDate | date | |
| xmlStatus | string | |
| xmlCode | string | |
| transactionUuid | string | |
| invoices | list | |
| first | boolean | |
| last | boolean | |
| numberOfElements | integer | |
| empty | boolean | |
| data | ||
| fileValidation | ||
| links | list | |
| _links | ||
| audit | ||
| requester | reference | |
| locations | list | |
| validationStatus | ||
| paymentDetail | ||
| statementStartDate | date | |
| statementEndDate | date | |
| totalAmount | decimal | |
| generatedAt | dateTime | |
| meta | ||
| dictKey | string | |
| dictKeyType | string | |
| qrCode | string | |
| desiredPaymentDate | date | |
| documentNumber | string | |
| bank | string | |
| bankName | string | |
| accountType | string | |
| accountNumber | string | |
| branch | string | |
| externalId | string | |
| paymentMethod | reference | |
| beneficiary | reference | |
| currencyCode | string | |
| pixEndToEndId | string | |
| error | reference | |
| creationDate | dateTime | |
| paymentDate | date | |
| items | list | |
| page | integer | |
| checkingAccount | ||
| collateralAccount |
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/",
"clarafintech": "https://clara.com/schema#",
"OAuthTokenResponse": "clarafintech:OAuthTokenResponse",
"access_token": {
"@id": "clarafintech:access_token",
"@type": "xsd:string"
},
"token_type": {
"@id": "clarafintech:token_type",
"@type": "xsd:string"
},
"expires_in": {
"@id": "clarafintech:expires_in",
"@type": "xsd:integer"
},
"ErrorResponse": "clarafintech:ErrorResponse",
"code": {
"@id": "clarafintech:code",
"@type": "xsd:string"
},
"message": {
"@id": "clarafintech:message",
"@type": "xsd:string"
},
"timestamp": {
"@id": "clarafintech:timestamp",
"@type": "xsd:dateTime"
},
"details": {
"@id": "clarafintech:details",
"@container": "@list"
},
"Money": "clarafintech:Money",
"value": {
"@id": "clarafintech:value",
"@type": "xsd:decimal"
},
"amount": {
"@id": "clarafintech:amount",
"@type": "xsd:decimal"
},
"currency": {
"@id": "clarafintech:currency",
"@type": "xsd:string"
},
"Periodicity": "clarafintech:Periodicity",
"CardListType": "clarafintech:CardListType",
"CreateCardType": "clarafintech:CreateCardType",
"BusinessType": "clarafintech:BusinessType",
"CardV3": "clarafintech:CardV3",
"uuid": {
"@id": "clarafintech:uuid",
"@type": "xsd:string"
},
"alias": {
"@id": "clarafintech:alias",
"@type": "xsd:string"
},
"status": {
"@id": "clarafintech:status"
},
"claraStatus": {
"@id": "clarafintech:claraStatus",
"@type": "xsd:string"
},
"lockCode": {
"@id": "clarafintech:lockCode",
"@type": "xsd:string"
},
"maskedPan": {
"@id": "clarafintech:maskedPan",
"@type": "xsd:string"
},
"threshold": {
"@id": "clarafintech:threshold",
"@type": "xsd:decimal"
},
"periodicity": {
"@id": "clarafintech:periodicity"
},
"type": {
"@id": "clarafintech:type"
},
"user": {
"@id": "clarafintech:user",
"@type": "@id"
},
"CardUser": "clarafintech:CardUser",
"name": {
"@id": "clarafintech:name",
"@type": "xsd:string"
},
"fullName": {
"@id": "clarafintech:fullName",
"@type": "xsd:string"
},
"username": {
"@id": "clarafintech:username",
"@type": "xsd:string"
},
"email": {
"@id": "clarafintech:email",
"@type": "xsd:string"
},
"CardPageV3": "clarafintech:CardPageV3",
"content": {
"@id": "clarafintech:content",
"@container": "@list"
},
"totalElements": {
"@id": "clarafintech:totalElements",
"@type": "xsd:integer"
},
"totalPages": {
"@id": "clarafintech:totalPages",
"@type": "xsd:integer"
},
"size": {
"@id": "clarafintech:size",
"@type": "xsd:integer"
},
"number": {
"@id": "clarafintech:number",
"@type": "xsd:integer"
},
"CreateCardRequestV3": "clarafintech:CreateCardRequestV3",
"userUuid": {
"@id": "clarafintech:userUuid",
"@type": "xsd:string"
},
"businessType": {
"@id": "clarafintech:businessType",
"@type": "@id"
},
"SetCardLockRequestV3": "clarafintech:SetCardLockRequestV3",
"UpdateCardThresholdRequestV3": "clarafintech:UpdateCardThresholdRequestV3",
"StatusObject": "clarafintech:StatusObject",
"description": {
"@id": "clarafintech:description",
"@type": "xsd:string"
},
"TransactionStatus": "clarafintech:TransactionStatus",
"TransactionType": "clarafintech:TransactionType",
"TransactionV3": "clarafintech:TransactionV3",
"transactionLabel": {
"@id": "clarafintech:transactionLabel",
"@type": "xsd:string"
},
"amountValue": {
"@id": "clarafintech:amountValue",
"@type": "@id"
},
"originalAmount": {
"@id": "clarafintech:originalAmount",
"@type": "@id"
},
"merchant": {
"@id": "clarafintech:merchant"
},
"card": {
"@id": "clarafintech:card"
},
"labels": {
"@id": "clarafintech:labels",
"@container": "@list"
},
"billingStatement": {
"@id": "clarafintech:billingStatement",
"@type": "@id"
},
"hasInvoice": {
"@id": "clarafintech:hasInvoice",
"@type": "xsd:boolean"
},
"hasAttachments": {
"@id": "clarafintech:hasAttachments",
"@type": "xsd:boolean"
},
"hasExtractedDocuments": {
"@id": "clarafintech:hasExtractedDocuments",
"@type": "xsd:boolean"
},
"accountingFields": {
"@id": "clarafintech:accountingFields",
"@container": "@list"
},
"accountingStatus": {
"@id": "clarafintech:accountingStatus",
"@type": "@id"
},
"TransactionPageV3": "clarafintech:TransactionPageV3",
"TransactionDocumentsResponseV3": "clarafintech:TransactionDocumentsResponseV3",
"attachments": {
"@id": "clarafintech:attachments",
"@container": "@list"
},
"UserRole": "clarafintech:UserRole",
"UserStatus": "clarafintech:UserStatus",
"UserV3": "clarafintech:UserV3",
"lastName": {
"@id": "clarafintech:lastName",
"@type": "xsd:string"
},
"mobilePhone": {
"@id": "clarafintech:mobilePhone",
"@type": "xsd:string"
},
"taxIdentifier": {
"@id": "clarafintech:taxIdentifier",
"@type": "xsd:string"
},
"role": {
"@id": "clarafintech:role",
"@type": "@id"
},
"erpId": {
"@id": "clarafintech:erpId",
"@type": "xsd:string"
},
"createdAt": {
"@id": "clarafintech:createdAt",
"@type": "xsd:dateTime"
},
"groups": {
"@id": "clarafintech:groups",
"@container": "@list"
},
"cards": {
"@id": "clarafintech:cards",
"@container": "@list"
},
"manager": {
"@id": "clarafintech:manager",
"@type": "@id"
},
"location": {
"@id": "clarafintech:location",
"@type": "@id"
},
"UserPageV3": "clarafintech:UserPageV3",
"CreateUserRequestV3": "clarafintech:CreateUserRequestV3",
"lada": {
"@id": "clarafintech:lada",
"@type": "xsd:string"
},
"managerUuid": {
"@id": "clarafintech:managerUuid",
"@type": "xsd:string"
},
"locationUuid": {
"@id": "clarafintech:locationUuid",
"@type": "xsd:string"
},
"foreign": {
"@id": "clarafintech:foreign",
"@type": "xsd:boolean"
},
"CreateUserResponseV3": "clarafintech:CreateUserResponseV3",
"UpdateUserRequestV3": "clarafintech:UpdateUserRequestV3",
"groupsToAdd": {
"@id": "clarafintech:groupsToAdd",
"@container": "@list"
},
"groupsToRemove": {
"@id": "clarafintech:groupsToRemove",
"@container": "@list"
},
"cleanGroups": {
"@id": "clarafintech:cleanGroups",
"@type": "xsd:boolean"
},
"BulkTransactionLabelsRequestV3": "clarafintech:BulkTransactionLabelsRequestV3",
"transactions": {
"@id": "clarafintech:transactions",
"@container": "@list"
},
"InvoiceV3": "clarafintech:InvoiceV3",
"invoiceId": {
"@id": "clarafintech:invoiceId",
"@type": "xsd:string"
},
"invoiceNumber": {
"@id": "clarafintech:invoiceNumber",
"@type": "xsd:string"
},
"taxRegime": {
"@id": "clarafintech:taxRegime",
"@type": "xsd:string"
},
"issuer": {
"@id": "clarafintech:issuer"
},
"taxReceipts": {
"@id": "clarafintech:taxReceipts"
},
"tax": {
"@id": "clarafintech:tax"
},
"documentDate": {
"@id": "clarafintech:documentDate",
"@type": "xsd:date"
},
"xmlStatus": {
"@id": "clarafintech:xmlStatus",
"@type": "xsd:string"
},
"xmlCode": {
"@id": "clarafintech:xmlCode",
"@type": "xsd:string"
},
"TransactionInvoiceResponseV3": "clarafintech:TransactionInvoiceResponseV3",
"transactionUuid": {
"@id": "clarafintech:transactionUuid",
"@type": "xsd:string"
},
"invoices": {
"@id": "clarafintech:invoices",
"@container": "@list"
},
"InvoicePageV3": "clarafintech:InvoicePageV3",
"first": {
"@id": "clarafintech:first",
"@type": "xsd:boolean"
},
"last": {
"@id": "clarafintech:last",
"@type": "xsd:boolean"
},
"numberOfElements": {
"@id": "clarafintech:numberOfElements",
"@type": "xsd:integer"
},
"empty": {
"@id": "clarafintech:empty",
"@type": "xsd:boolean"
},
"ExtractedDocumentType": "clarafintech:ExtractedDocumentType",
"DocumentValidationStatus": "clarafintech:DocumentValidationStatus",
"ExtractedDocumentV3": "clarafintech:ExtractedDocumentV3",
"data": {
"@id": "clarafintech:data"
},
"fileValidation": {
"@id": "clarafintech:fileValidation"
},
"ExtractedDocumentPageV3": "clarafintech:ExtractedDocumentPageV3",
"ReimbursementStatus": "clarafintech:ReimbursementStatus",
"LinkedResource": "clarafintech:LinkedResource",
"links": {
"@id": "clarafintech:links",
"@container": "@list"
},
"_links": {
"@id": "clarafintech:_links"
},
"ReimbursementV3": "clarafintech:ReimbursementV3",
"audit": {
"@id": "clarafintech:audit"
},
"requester": {
"@id": "clarafintech:requester",
"@type": "@id"
},
"locations": {
"@id": "clarafintech:locations",
"@container": "@list"
},
"validationStatus": {
"@id": "clarafintech:validationStatus"
},
"paymentDetail": {
"@id": "clarafintech:paymentDetail"
},
"ReimbursementPageV3": "clarafintech:ReimbursementPageV3",
"BillingStatementV3": "clarafintech:BillingStatementV3",
"statementStartDate": {
"@id": "clarafintech:statementStartDate",
"@type": "xsd:date"
},
"statementEndDate": {
"@id": "clarafintech:statementEndDate",
"@type": "xsd:date"
},
"totalAmount": {
"@id": "clarafintech:totalAmount",
"@type": "xsd:decimal"
},
"generatedAt": {
"@id": "clarafintech:generatedAt",
"@type": "xsd:dateTime"
},
"DigitalAccountTransactionPageV3": "clarafintech:DigitalAccountTransactionPageV3",
"meta": {
"@id": "clarafintech:meta"
},
"AccountingStatus": "clarafintech:AccountingStatus",
"PixPaymentMethodV3": "clarafintech:PixPaymentMethodV3",
"dictKey": {
"@id": "clarafintech:dictKey",
"@type": "xsd:string"
},
"dictKeyType": {
"@id": "clarafintech:dictKeyType",
"@type": "xsd:string"
},
"qrCode": {
"@id": "clarafintech:qrCode",
"@type": "xsd:string"
},
"desiredPaymentDate": {
"@id": "clarafintech:desiredPaymentDate",
"@type": "xsd:date"
},
"PixBeneficiaryRequestV3": "clarafintech:PixBeneficiaryRequestV3",
"documentNumber": {
"@id": "clarafintech:documentNumber",
"@type": "xsd:string"
},
"bank": {
"@id": "clarafintech:bank",
"@type": "xsd:string"
},
"bankName": {
"@id": "clarafintech:bankName",
"@type": "xsd:string"
},
"accountType": {
"@id": "clarafintech:accountType",
"@type": "xsd:string"
},
"accountNumber": {
"@id": "clarafintech:accountNumber",
"@type": "xsd:string"
},
"branch": {
"@id": "clarafintech:branch",
"@type": "xsd:string"
},
"PixBeneficiaryV3": "clarafintech:PixBeneficiaryV3",
"CreatePixPaymentRequestV3": "clarafintech:CreatePixPaymentRequestV3",
"externalId": {
"@id": "clarafintech:externalId",
"@type": "xsd:string"
},
"paymentMethod": {
"@id": "clarafintech:paymentMethod",
"@type": "@id"
},
"beneficiary": {
"@id": "clarafintech:beneficiary",
"@type": "@id"
},
"PixPaymentAcceptedV3": "clarafintech:PixPaymentAcceptedV3",
"PixPaymentErrorV3": "clarafintech:PixPaymentErrorV3",
"PixPaymentV3": "clarafintech:PixPaymentV3",
"currencyCode": {
"@id": "clarafintech:currencyCode",
"@type": "xsd:string"
},
"pixEndToEndId": {
"@id": "clarafintech:pixEndToEndId",
"@type": "xsd:string"
},
"error": {
"@id": "clarafintech:error",
"@type": "@id"
},
"creationDate": {
"@id": "clarafintech:creationDate",
"@type": "xsd:dateTime"
},
"paymentDate": {
"@id": "clarafintech:paymentDate",
"@type": "xsd:date"
},
"PixPaymentPageV3": "clarafintech:PixPaymentPageV3",
"items": {
"@id": "clarafintech:items",
"@container": "@list"
},
"page": {
"@id": "clarafintech:page",
"@type": "xsd:integer"
},
"DigitalAccountBalanceV3": "clarafintech:DigitalAccountBalanceV3",
"checkingAccount": {
"@id": "clarafintech:checkingAccount"
},
"collateralAccount": {
"@id": "clarafintech:collateralAccount"
}
},
"@type": "schema:Dataset",
"schema:name": "Clarafintech API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects Clarafintech'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-08) from openapi/clarafintech-openapi.json.",
"dcterms:created": "2026-10-08",
"dcterms:source": [
"openapi/clarafintech-openapi.json"
]
}