Heru · JSON-LD Context

Heru Context

JSON-LD context defining the semantic vocabulary for Heru from Heru.

44 Classes 116 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/
heru: https://heru.app/schema#

Classes

PostOauthTokenRequest PostV1BatchesRequest PostV1BatchesResponse GetV1BatchesBat01M4Ra8Wpbev7Sf851M6Pn6Gm7Response GetV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzRequest PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse PostV1ChargesRequest PostV1ChargesResponse GetV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsResponse PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidRequest PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidResponse GetV1InvoicesResponse PostV1InvoicesRequest PostV1InvoicesResponse GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1Response GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1DownloadResponse GetV1MeResponse PostV1MerchantsRequest PostV1MerchantsResponse GetV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JResponse PutV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JCsdResponse GetV1ReportsRetentionsResponse GetV1ReportsUsageResponse GetV1SignaturesResponse PostV1SignaturesRequest PostV1SignaturesResponse GetV1SignaturesSig01M4Rcp7Xvfrct34Z0Q3S0R2YbResponse GetV1WebhooksResponse PostV1WebhooksRequest PostV1WebhooksResponse GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmRequest PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmDeliveriesResponse PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretRequest PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretResponse PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmTestResponse GetV1WorkersResponse PostV1WorkersRequest PostV1WorkersResponse GetV1WorkersReportResponse GetV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvResponse PostV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvEnrollmentResponse

Properties

Property Type Container
client_id string
client_secret string
scope string
type string
id string
status string
upload_url string
total_rows integer
valid_rows integer
succeeded integer
failed integer
errors list
report_url string
merchant_id string
display_name string
logo
primary_color string
support_email string
footer_text string
sources
external_id string
occurred_at dateTime
amount string
payment_form string
location string
items list
invoice_token string
invoice_url string
qr
expires_at dateTime
invoice string
created_at dateTime
updated_at dateTime
reason string
data list
next_cursor string
receiver
uuid string
verification_url string
stamp
issuer
third_party string
place_of_issue string
related_invoices list
payment_method string
cfdi_use string
currency string
subtotal string
vat string
withholdings string
total string
cancellation string
metadata
stamped_at dateTime
url string
content_type string
filename string
organization_id string
company_id string
scopes list
rfc string
legal_name string
tax_regime string
postal_code string
trade_name string
slug string
email string
locations list
default_item
csd
onboarding
message string
period string
rows list
totals
active_merchants integer
by_service list
worker_id string
purpose string
signing
signed_document
certificate
document
event_types list
merchant_ids list
description string
headers list
disabled_reason string
disabled_at string
secret string
secret_last4 string
secret_rotating_until string
consecutive_failures integer
failing_since string
environment string
deliveries
expires_previous_in string
delivery_id string
event_id string
status_code integer
latency_ms integer
response_snippet string
error_class string
error string
curp string
phone string
services list
name string
regimes list
efirma
open_actions list
enrollment
consent_at string
compliant_at string
removed_at string
completed_at string

JSON-LD Document

heru-context.jsonld Raw ↑
{
  "@context": {
    "@vocab": "https://heru.app/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "heru": "https://heru.app/schema#",
    "PostOauthTokenRequest": "heru:PostOauthTokenRequest",
    "client_id": {
      "@id": "heru:client_id",
      "@type": "xsd:string"
    },
    "client_secret": {
      "@id": "heru:client_secret",
      "@type": "xsd:string"
    },
    "scope": {
      "@id": "heru:scope",
      "@type": "xsd:string"
    },
    "PostV1BatchesRequest": "heru:PostV1BatchesRequest",
    "type": {
      "@id": "heru:type",
      "@type": "xsd:string"
    },
    "PostV1BatchesResponse": "heru:PostV1BatchesResponse",
    "id": {
      "@id": "heru:id",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "heru:status",
      "@type": "xsd:string"
    },
    "upload_url": {
      "@id": "heru:upload_url",
      "@type": "xsd:string"
    },
    "total_rows": {
      "@id": "heru:total_rows",
      "@type": "xsd:integer"
    },
    "valid_rows": {
      "@id": "heru:valid_rows",
      "@type": "xsd:integer"
    },
    "succeeded": {
      "@id": "heru:succeeded",
      "@type": "xsd:integer"
    },
    "failed": {
      "@id": "heru:failed",
      "@type": "xsd:integer"
    },
    "errors": {
      "@id": "heru:errors",
      "@container": "@list"
    },
    "report_url": {
      "@id": "heru:report_url",
      "@type": "xsd:string"
    },
    "GetV1BatchesBat01M4Ra8Wpbev7Sf851M6Pn6Gm7Response": "heru:GetV1BatchesBat01M4Ra8Wpbev7Sf851M6Pn6Gm7Response",
    "GetV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse": "heru:GetV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse",
    "merchant_id": {
      "@id": "heru:merchant_id",
      "@type": "xsd:string"
    },
    "display_name": {
      "@id": "heru:display_name",
      "@type": "xsd:string"
    },
    "logo": {
      "@id": "heru:logo"
    },
    "primary_color": {
      "@id": "heru:primary_color",
      "@type": "xsd:string"
    },
    "support_email": {
      "@id": "heru:support_email",
      "@type": "xsd:string"
    },
    "footer_text": {
      "@id": "heru:footer_text",
      "@type": "xsd:string"
    },
    "sources": {
      "@id": "heru:sources"
    },
    "PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzRequest": "heru:PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzRequest",
    "PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse": "heru:PutV1BrandingMerchantsMer01M4Xnvf23Ecb963N48H2J9VxzResponse",
    "PostV1ChargesRequest": "heru:PostV1ChargesRequest",
    "external_id": {
      "@id": "heru:external_id",
      "@type": "xsd:string"
    },
    "occurred_at": {
      "@id": "heru:occurred_at",
      "@type": "xsd:dateTime"
    },
    "amount": {
      "@id": "heru:amount",
      "@type": "xsd:string"
    },
    "payment_form": {
      "@id": "heru:payment_form",
      "@type": "xsd:string"
    },
    "location": {
      "@id": "heru:location",
      "@type": "xsd:string"
    },
    "items": {
      "@id": "heru:items",
      "@container": "@list"
    },
    "PostV1ChargesResponse": "heru:PostV1ChargesResponse",
    "invoice_token": {
      "@id": "heru:invoice_token",
      "@type": "xsd:string"
    },
    "invoice_url": {
      "@id": "heru:invoice_url",
      "@type": "xsd:string"
    },
    "qr": {
      "@id": "heru:qr"
    },
    "expires_at": {
      "@id": "heru:expires_at",
      "@type": "xsd:dateTime"
    },
    "invoice": {
      "@id": "heru:invoice",
      "@type": "xsd:string"
    },
    "created_at": {
      "@id": "heru:created_at",
      "@type": "xsd:dateTime"
    },
    "updated_at": {
      "@id": "heru:updated_at",
      "@type": "xsd:dateTime"
    },
    "GetV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsResponse": "heru:GetV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsResponse",
    "PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidRequest": "heru:PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidRequest",
    "reason": {
      "@id": "heru:reason",
      "@type": "xsd:string"
    },
    "PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidResponse": "heru:PostV1ChargesChg01M4P7Sbvpev1S5086Cty36RvsVoidResponse",
    "GetV1InvoicesResponse": "heru:GetV1InvoicesResponse",
    "data": {
      "@id": "heru:data",
      "@container": "@list"
    },
    "next_cursor": {
      "@id": "heru:next_cursor",
      "@type": "xsd:string"
    },
    "PostV1InvoicesRequest": "heru:PostV1InvoicesRequest",
    "receiver": {
      "@id": "heru:receiver"
    },
    "PostV1InvoicesResponse": "heru:PostV1InvoicesResponse",
    "uuid": {
      "@id": "heru:uuid",
      "@type": "xsd:string"
    },
    "verification_url": {
      "@id": "heru:verification_url",
      "@type": "xsd:string"
    },
    "stamp": {
      "@id": "heru:stamp"
    },
    "issuer": {
      "@id": "heru:issuer"
    },
    "third_party": {
      "@id": "heru:third_party",
      "@type": "xsd:string"
    },
    "place_of_issue": {
      "@id": "heru:place_of_issue",
      "@type": "xsd:string"
    },
    "related_invoices": {
      "@id": "heru:related_invoices",
      "@container": "@list"
    },
    "payment_method": {
      "@id": "heru:payment_method",
      "@type": "xsd:string"
    },
    "cfdi_use": {
      "@id": "heru:cfdi_use",
      "@type": "xsd:string"
    },
    "currency": {
      "@id": "heru:currency",
      "@type": "xsd:string"
    },
    "subtotal": {
      "@id": "heru:subtotal",
      "@type": "xsd:string"
    },
    "vat": {
      "@id": "heru:vat",
      "@type": "xsd:string"
    },
    "withholdings": {
      "@id": "heru:withholdings",
      "@type": "xsd:string"
    },
    "total": {
      "@id": "heru:total",
      "@type": "xsd:string"
    },
    "cancellation": {
      "@id": "heru:cancellation",
      "@type": "xsd:string"
    },
    "metadata": {
      "@id": "heru:metadata"
    },
    "stamped_at": {
      "@id": "heru:stamped_at",
      "@type": "xsd:dateTime"
    },
    "GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1Response": "heru:GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1Response",
    "GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1DownloadResponse": "heru:GetV1InvoicesInv01M4Ra8W8Mfa8Svf5396B2P5E1DownloadResponse",
    "url": {
      "@id": "heru:url",
      "@type": "xsd:string"
    },
    "content_type": {
      "@id": "heru:content_type",
      "@type": "xsd:string"
    },
    "filename": {
      "@id": "heru:filename",
      "@type": "xsd:string"
    },
    "GetV1MeResponse": "heru:GetV1MeResponse",
    "organization_id": {
      "@id": "heru:organization_id",
      "@type": "xsd:string"
    },
    "company_id": {
      "@id": "heru:company_id",
      "@type": "xsd:string"
    },
    "scopes": {
      "@id": "heru:scopes",
      "@container": "@list"
    },
    "PostV1MerchantsRequest": "heru:PostV1MerchantsRequest",
    "rfc": {
      "@id": "heru:rfc",
      "@type": "xsd:string"
    },
    "legal_name": {
      "@id": "heru:legal_name",
      "@type": "xsd:string"
    },
    "tax_regime": {
      "@id": "heru:tax_regime",
      "@type": "xsd:string"
    },
    "postal_code": {
      "@id": "heru:postal_code",
      "@type": "xsd:string"
    },
    "trade_name": {
      "@id": "heru:trade_name",
      "@type": "xsd:string"
    },
    "slug": {
      "@id": "heru:slug",
      "@type": "xsd:string"
    },
    "email": {
      "@id": "heru:email",
      "@type": "xsd:string"
    },
    "locations": {
      "@id": "heru:locations",
      "@container": "@list"
    },
    "default_item": {
      "@id": "heru:default_item"
    },
    "PostV1MerchantsResponse": "heru:PostV1MerchantsResponse",
    "csd": {
      "@id": "heru:csd"
    },
    "onboarding": {
      "@id": "heru:onboarding"
    },
    "GetV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JResponse": "heru:GetV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JResponse",
    "PutV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JCsdResponse": "heru:PutV1MerchantsMer01M4Ra8Wsyfh3S0Tr4Nrq3Y96JCsdResponse",
    "message": {
      "@id": "heru:message",
      "@type": "xsd:string"
    },
    "GetV1ReportsRetentionsResponse": "heru:GetV1ReportsRetentionsResponse",
    "period": {
      "@id": "heru:period",
      "@type": "xsd:string"
    },
    "rows": {
      "@id": "heru:rows",
      "@container": "@list"
    },
    "totals": {
      "@id": "heru:totals"
    },
    "GetV1ReportsUsageResponse": "heru:GetV1ReportsUsageResponse",
    "active_merchants": {
      "@id": "heru:active_merchants",
      "@type": "xsd:integer"
    },
    "by_service": {
      "@id": "heru:by_service",
      "@container": "@list"
    },
    "GetV1SignaturesResponse": "heru:GetV1SignaturesResponse",
    "worker_id": {
      "@id": "heru:worker_id",
      "@type": "xsd:string"
    },
    "purpose": {
      "@id": "heru:purpose",
      "@type": "xsd:string"
    },
    "signing": {
      "@id": "heru:signing"
    },
    "signed_document": {
      "@id": "heru:signed_document"
    },
    "certificate": {
      "@id": "heru:certificate"
    },
    "PostV1SignaturesRequest": "heru:PostV1SignaturesRequest",
    "document": {
      "@id": "heru:document"
    },
    "PostV1SignaturesResponse": "heru:PostV1SignaturesResponse",
    "GetV1SignaturesSig01M4Rcp7Xvfrct34Z0Q3S0R2YbResponse": "heru:GetV1SignaturesSig01M4Rcp7Xvfrct34Z0Q3S0R2YbResponse",
    "GetV1WebhooksResponse": "heru:GetV1WebhooksResponse",
    "PostV1WebhooksRequest": "heru:PostV1WebhooksRequest",
    "event_types": {
      "@id": "heru:event_types",
      "@container": "@list"
    },
    "merchant_ids": {
      "@id": "heru:merchant_ids",
      "@container": "@list"
    },
    "description": {
      "@id": "heru:description",
      "@type": "xsd:string"
    },
    "headers": {
      "@id": "heru:headers",
      "@container": "@list"
    },
    "PostV1WebhooksResponse": "heru:PostV1WebhooksResponse",
    "disabled_reason": {
      "@id": "heru:disabled_reason",
      "@type": "xsd:string"
    },
    "disabled_at": {
      "@id": "heru:disabled_at",
      "@type": "xsd:string"
    },
    "secret": {
      "@id": "heru:secret",
      "@type": "xsd:string"
    },
    "secret_last4": {
      "@id": "heru:secret_last4",
      "@type": "xsd:string"
    },
    "secret_rotating_until": {
      "@id": "heru:secret_rotating_until",
      "@type": "xsd:string"
    },
    "consecutive_failures": {
      "@id": "heru:consecutive_failures",
      "@type": "xsd:integer"
    },
    "failing_since": {
      "@id": "heru:failing_since",
      "@type": "xsd:string"
    },
    "environment": {
      "@id": "heru:environment",
      "@type": "xsd:string"
    },
    "deliveries": {
      "@id": "heru:deliveries"
    },
    "GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse": "heru:GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse",
    "PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmRequest": "heru:PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmRequest",
    "PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse": "heru:PatchV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmResponse",
    "GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmDeliveriesResponse": "heru:GetV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmDeliveriesResponse",
    "PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretRequest": "heru:PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretRequest",
    "expires_previous_in": {
      "@id": "heru:expires_previous_in",
      "@type": "xsd:string"
    },
    "PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretResponse": "heru:PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmSecretResponse",
    "PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmTestResponse": "heru:PostV1WebhooksWhk01M53G5Zw414Zt6Vg08FqbacgmTestResponse",
    "delivery_id": {
      "@id": "heru:delivery_id",
      "@type": "xsd:string"
    },
    "event_id": {
      "@id": "heru:event_id",
      "@type": "xsd:string"
    },
    "status_code": {
      "@id": "heru:status_code",
      "@type": "xsd:integer"
    },
    "latency_ms": {
      "@id": "heru:latency_ms",
      "@type": "xsd:integer"
    },
    "response_snippet": {
      "@id": "heru:response_snippet",
      "@type": "xsd:string"
    },
    "error_class": {
      "@id": "heru:error_class",
      "@type": "xsd:string"
    },
    "error": {
      "@id": "heru:error",
      "@type": "xsd:string"
    },
    "GetV1WorkersResponse": "heru:GetV1WorkersResponse",
    "PostV1WorkersRequest": "heru:PostV1WorkersRequest",
    "curp": {
      "@id": "heru:curp",
      "@type": "xsd:string"
    },
    "phone": {
      "@id": "heru:phone",
      "@type": "xsd:string"
    },
    "services": {
      "@id": "heru:services",
      "@container": "@list"
    },
    "PostV1WorkersResponse": "heru:PostV1WorkersResponse",
    "name": {
      "@id": "heru:name",
      "@type": "xsd:string"
    },
    "regimes": {
      "@id": "heru:regimes",
      "@container": "@list"
    },
    "efirma": {
      "@id": "heru:efirma"
    },
    "open_actions": {
      "@id": "heru:open_actions",
      "@container": "@list"
    },
    "enrollment": {
      "@id": "heru:enrollment"
    },
    "consent_at": {
      "@id": "heru:consent_at",
      "@type": "xsd:string"
    },
    "compliant_at": {
      "@id": "heru:compliant_at",
      "@type": "xsd:string"
    },
    "removed_at": {
      "@id": "heru:removed_at",
      "@type": "xsd:string"
    },
    "GetV1WorkersReportResponse": "heru:GetV1WorkersReportResponse",
    "GetV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvResponse": "heru:GetV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvResponse",
    "PostV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvEnrollmentResponse": "heru:PostV1WorkersWrk01M4Ra8W0He5Esnnsew0V9FfkvEnrollmentResponse",
    "completed_at": {
      "@id": "heru:completed_at",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Heru API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Heru'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-29) from openapi/_ae-authored/heru-openapi-generated.yml.",
  "dcterms:created": "2026-10-29",
  "dcterms:source": [
    "openapi/_ae-authored/heru-openapi-generated.yml"
  ]
}