Skip to content

Endpoints de Contract

Contratos são acordos legais vinculados a organizações e entitlements. Eles acompanham o ciclo de vida desde rascunho, passando por vigência ativa, até expiração ou renovação.

Caminho base: /wp-json/middag-account/v1/contracts

Endpoints

MétodoEndpointAuthEscopoDescrição
GET/contractsJWT + OrgcontractsListar contratos
GET/contracts/{id}JWT + OrgcontractsDetalhes do contrato
GET/contracts/{id}/pdfJWT + OrgcontractsBaixar PDF do contrato

GET /contracts

Listar contratos da organização atual.

Headers: X-Middag-Organization: {org_id}

Filtros de query:

ParâmetroTipoValores
statusstringdraft, active, suspended, expired, cancelled, renewed

Resposta (200):

json
{
    "success": true,
    "data": [
        {
            "id": 401,
            "title": "Annual Service Agreement",
            "status": "active",
            "start_date": "2026-04-01",
            "end_date": "2027-03-31",
            "organization_id": 42,
            "entitlement_id": 101,
            "created_at": "2026-04-01T10:00:00Z"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 20,
        "total": 1,
        "pages": 1
    }
}

GET /contracts/:id

Detalhes completos do contrato incluindo entitlement vinculado e referencias de documentos.

Campos de resposta: id, title, status, start_date, end_date, organization_id, entitlement_id, entitlement_code, terms, notes, created_at, updated_at.

GET /contracts/:id/pdf

Retorna o PDF do contrato como download binario com Content-Type: application/pdf.

Status de Contract

StatusDescrição
draftContrato criado, ainda não ativo
activeAtualmente em vigor
suspendedTemporariamente pausado
expiredApós data final
cancelledCancelado permanentemente (terminal)
renewedSubstituido por um novo periodo contratual

Relacionados