Skip to content

Glossário de Campos

Todos os campos dos domínios do middag-account conforme retornados pela REST API. Os campos mapeiam para propriedades de entidade via serialização toArray(). Valores monetários são armazenados em centavos (inteiro), salvo indicação contrária.

Organization

CampoTipoDescrição
idintPost ID
namestringNome de exibição
legal_namestring?Razão social
cnpjstring?CNPJ brasileiro
state_registrationstring?Inscrição estadual
emailstring?E-mail de contato principal
phonestring?Telefone
addressstring?Endereço
citystring?Cidade
statestring?Estado/província
countrystring?Código de país ISO
zipcodestring?CEP
typestring?company ou individual
statusstringpublish, draft
verification_statusstring?pending, verified
owner_idintID de usuário WordPress do proprietário
requires_invoice_for_paymentboolRequer NFSe antes do pagamento
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Collaborator

CampoTipoDescrição
idintID do registro de colaborador
organization_idintOrganização pai
user_idint?ID de usuário WordPress (null se pendente)
emailstringE-mail do colaborador
rolestringowner, admin, member, guest, pending
statusstringactive
can_manage_orgboolEscopo de organização
can_manage_financesboolEscopo de finanças
can_manage_ordersboolEscopo de pedidos
can_manage_licensesboolEscopo de licenças
can_manage_ticketsboolEscopo de tickets
can_manage_quotesboolEscopo de quotes
can_manage_contractsboolEscopo de contratos
can_manage_documentsboolEscopo de documentos
can_manage_downloadsboolEscopo de downloads
invite_statusstring?pending, accepted, rejected, expired
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Entitlement

CampoTipoDescrição
idintPost ID
codestringCódigo único (ex.: PLG-2026040001)
classstringPLG, ENV, SVC, ORD, AFL, EDU
product_namestringNome do produto vinculado
product_descriptionstring?Descrição do produto
statusstringactive, suspended, expired, cancelled
organization_idintOrganização proprietária
companystringmiddag_br ou middag_global
expires_atstring?Data de expiração (ISO 8601)
quote_idint?Quote de origem
auto_createdboolProvisionado automaticamente a partir de quote
metadatastring?Blob JSON de metadados
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Quote

CampoTipoDescrição
idintPost ID
quote_numberstringNúmero único do quote
statusstringVer Labels de Status
organization_idintOrganização proprietária
companystringEntidade legal
line_itemsstring?Array JSON de itens
subtotalint?Valor em centavos
discountint?Desconto em centavos
totalint?Total em centavos
currencystring?Código de moeda ISO
valid_untilstring?Data de expiração (ISO 8601)
contact_namestring?Nome do contato do cliente
contact_emailstring?E-mail do contato do cliente
order_idint?Pedido WooCommerce vinculado
entitlement_idint?Entitlement provisionado
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Invoice

CampoTipoDescrição
idintPost ID
numberstringNúmero da fatura
statusstringVer Labels de Status
totalintValor em centavos
currencystringCódigo de moeda ISO
issue_datestringData de emissão (YYYY-MM-DD)
due_datestringData de vencimento (YYYY-MM-DD)
payment_methodstring?Método de pagamento usado
payment_datestring?Data do pagamento (YYYY-MM-DD)
linkstring?URL externa da fatura
order_idint?Pedido WooCommerce vinculado
organization_idint?Organização proprietária
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Environment

CampoTipoDescrição
idintPost ID
environment_namestringNome de exibição
environment_typestringproduction, staging, development, sandbox
platformstringmoodle, wordpress, custom
statusstringVer Labels de Status
entitlement_idintEntitlement vinculado
organization_idintOrganização proprietária
url_primarystring?URL primária
url_adminstring?URL do painel administrativo
server_providerstring?Provedor de hospedagem
server_regionstring?Região do servidor
backup_schedulestring?Descrição do agendamento de backup
backup_retention_daysint?Dias de retenção de backups
ssl_expires_atstring?Expiração do SSL (ISO 8601)
contract_idint?Contrato vinculado
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Service

CampoTipoDescrição
idintPost ID
service_typestringTipo (ex.: consulting, development)
titlestringTítulo do serviço
statusstringVer Labels de Status
prioritystringlow, normal, high, urgent
entitlement_idintEntitlement vinculado
organization_idintOrganização proprietária
start_datestring?Data de início (ISO 8601)
estimated_end_datestring?Previsão de conclusão
actual_end_datestring?Conclusão real
contract_idint?Contrato vinculado
assigned_teamstring?Nome da equipe atribuída
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Ticket

CampoTipoDescrição
idintPost ID
ticket_numberstringSR-{YEAR}{SEQ:4d}
titlestringTítulo da solicitação
statusstringVer Labels de Status
prioritystringlow, normal, high, urgent
entitlement_idintEntitlement vinculado
organization_idintOrganização proprietária
requested_byint?ID de usuário WordPress
assigned_tostring?Responsável atribuído
estimated_hoursstring?Esforço estimado
actual_hoursstring?Esforço real
due_datestring?Data limite (ISO 8601)
completed_atstring?Timestamp de conclusão
service_idint?Serviço pai (se houver)
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

License

CampoTipoDescrição
idintID da licença
license_keystring?Chave de licença
statusstring?active, expired, revoked
product_idint?ID de produto WooCommerce
product_namestring?Nome de exibição do produto
order_idint?Pedido vinculado
activations_limitint?Máximo de ativações permitidas
activations_currentint?Contagem atual de ativações
activated_domainsstring[]Domínios onde está ativada
expiration_datestring?Data de expiração (ISO 8601)
organization_idint?Organização proprietária

Contract

CampoTipoDescrição
idintPost ID
numberstringNúmero do contrato
yearstringAno do contrato
statusstringVer Labels de Status
organization_idint?Organização proprietária
order_idint?Pedido vinculado
objectstring?Objeto/escopo do contrato
durationstring?Descrição da duração
amount_monthlyint?Valor mensal (centavos)
amount_totalint?Valor total (centavos)
currencystring?Código de moeda ISO
issue_datestring?Data de emissão
acceptance_datestring?Data de assinatura
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601

Relacionados