Skip to content

Field Glossary ​

All fields across middag-account domains as returned by the REST API. Fields map to entity properties via toArray() serialization. Amounts are stored in cents (integer) unless noted.

Organization ​

FieldTypeDescription
idintPost ID
namestringDisplay name
legal_namestring?Legal entity name
cnpjstring?Brazilian CNPJ
state_registrationstring?State tax registration
emailstring?Primary contact email
phonestring?Phone number
addressstring?Street address
citystring?City
statestring?State/province
countrystring?ISO country code
zipcodestring?Postal code
typestring?company or individual
statusstringpublish, draft
verification_statusstring?pending, verified
owner_idintWordPress user ID of owner
requires_invoice_for_paymentboolRequires NFSe before payment
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Collaborator ​

FieldTypeDescription
idintCollaborator record ID
organization_idintParent organization
user_idint?WordPress user ID (null if pending)
emailstringCollaborator email
rolestringowner, admin, member, guest, pending
statusstringactive
can_manage_orgboolOrganization scope
can_manage_financesboolFinances scope
can_manage_ordersboolOrders scope
can_manage_licensesboolLicenses scope
can_manage_ticketsboolTickets scope
can_manage_quotesboolQuotes scope
can_manage_contractsboolContracts scope
can_manage_documentsboolDocuments scope
can_manage_downloadsboolDownloads scope
invite_statusstring?pending, accepted, rejected, expired
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Entitlement ​

FieldTypeDescription
idintPost ID
codestringUnique code (e.g., PLG-2026040001)
classstringPLG, ENV, SVC, ORD, AFL, EDU
product_namestringLinked product name
product_descriptionstring?Product description
statusstringactive, suspended, expired, cancelled
organization_idintOwning organization
companystringmiddag_br or middag_global
expires_atstring?Expiration date (ISO 8601)
quote_idint?Originating quote
auto_createdboolAuto-provisioned from quote
metadatastring?JSON metadata blob
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Quote ​

FieldTypeDescription
idintPost ID
quote_numberstringUnique quote number
statusstringSee Status Labels
organization_idintOwning organization
companystringLegal entity
line_itemsstring?JSON array of line items
subtotalint?Amount in cents
discountint?Discount in cents
totalint?Total in cents
currencystring?ISO currency code
valid_untilstring?Expiry date (ISO 8601)
contact_namestring?Client contact name
contact_emailstring?Client contact email
order_idint?Linked WooCommerce order
entitlement_idint?Provisioned entitlement
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Invoice ​

FieldTypeDescription
idintPost ID
numberstringInvoice number
statusstringSee Status Labels
totalintAmount in cents
currencystringISO currency code
issue_datestringIssue date (YYYY-MM-DD)
due_datestringDue date (YYYY-MM-DD)
payment_methodstring?Payment method used
payment_datestring?Date paid (YYYY-MM-DD)
linkstring?External invoice URL
order_idint?Linked WooCommerce order
organization_idint?Owning organization
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Environment ​

FieldTypeDescription
idintPost ID
environment_namestringDisplay name
environment_typestringproduction, staging, development, sandbox
platformstringmoodle, wordpress, custom
statusstringSee Status Labels
entitlement_idintLinked entitlement
organization_idintOwning organization
url_primarystring?Primary URL
url_adminstring?Admin panel URL
server_providerstring?Hosting provider
server_regionstring?Server region
backup_schedulestring?Backup schedule description
backup_retention_daysint?Days to retain backups
ssl_expires_atstring?SSL expiry (ISO 8601)
contract_idint?Linked contract
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Service ​

FieldTypeDescription
idintPost ID
service_typestringType (e.g., consulting, development)
titlestringService title
statusstringSee Status Labels
prioritystringlow, normal, high, urgent
entitlement_idintLinked entitlement
organization_idintOwning organization
start_datestring?Start date (ISO 8601)
estimated_end_datestring?Estimated completion
actual_end_datestring?Actual completion
contract_idint?Linked contract
assigned_teamstring?Assigned team name
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Ticket ​

FieldTypeDescription
idintPost ID
ticket_numberstringSR-{YEAR}{SEQ:4d}
titlestringRequest title
statusstringSee Status Labels
prioritystringlow, normal, high, urgent
entitlement_idintLinked entitlement
organization_idintOwning organization
requested_byint?WordPress user ID
assigned_tostring?Assigned staff
estimated_hoursstring?Estimated effort
actual_hoursstring?Actual effort
due_datestring?Due date (ISO 8601)
completed_atstring?Completion timestamp
service_idint?Parent service (if any)
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

License ​

FieldTypeDescription
idintLicense ID
license_keystring?License key string
statusstring?active, expired, revoked
product_idint?WooCommerce product ID
product_namestring?Product display name
order_idint?Linked order
activations_limitint?Max activations allowed
activations_currentint?Current activation count
activated_domainsstring[]Domains where activated
expiration_datestring?Expiry date (ISO 8601)
organization_idint?Owning organization

Contract ​

FieldTypeDescription
idintPost ID
numberstringContract number
yearstringContract year
statusstringSee Status Labels
organization_idint?Owning organization
order_idint?Linked order
objectstring?Contract object/scope
durationstring?Duration description
amount_monthlyint?Monthly amount (cents)
amount_totalint?Total amount (cents)
currencystring?ISO currency code
issue_datestring?Issue date
acceptance_datestring?Signature date
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp