Create a new contract

POST

/api/contract

Creates a contract.

Requisição

Authorization

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200OK

application/json

Contract data

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/contract' \
--header 'Content-Type: application/json' \
--data-raw '{
    "number": "CTR001",
    "customer_id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
    "billing_customer_id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
    "signature_date": "2024-12-25T00:00:00+00:00",
    "agent_id": "18bfca62-e884-4274-8358-3810708751df",
    "approval_date": "2024-12-25T00:00:00+00:00",
    "start_date": "2024-12-26T00:00:00+00:00",
    "end_date": null,
    "suspension_date": null,
    "cancellation_date": null,
    "total_value": 500,
    "contract_status": "ACTIVE",
    "contract_stage": "INSTALLED",
    "active": true,
    "json_original": null,
    "json_billing": null,
    "json_payment_method": null,
    "json_items": null
}'

Response Example

{
    "id": "404276b7-a682-4736-b7ae-123d82c8dd0d",
    "customer": {
        "id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
        "name": "James Aklos Packard",
        "display_name": "James",
        "tp_doc_identity": "RG",
        "doc_identity": "20250318/SSP/RS",
        "corporate": false,
        "address": {
            "line1": "2025 Rua da Liberdade",
            "line2": "Bloco 5A, Sala 18",
            "district": "Centro",
            "postal_code": "96010-150",
            "city": {
                "id": "dde44383-0875-4e30-85d5-c715e35d7a3a",
                "name": "Pelotas",
                "state": "Rio Grande do Sul",
                "country": "Brasil"
            },
            "latitude": -31.719189,
            "longitude": -71.719189,
            "detail": "Near the subway station"
        }
    },
    "billing_customer": {
        "id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
        "name": "James Aklos Packard",
        "display_name": "James",
        "tp_doc_identity": "RG",
        "doc_identity": "20250318/SSP/RS",
        "corporate": false,
        "address": {
            "line1": "2025 Rua da Liberdade",
            "line2": "Bloco 5A, Sala 18",
            "district": "Centro",
            "postal_code": "96010-150",
            "city": {
                "id": "dde44383-0875-4e30-85d5-c715e35d7a3a",
                "name": "Pelotas",
                "state": "Rio Grande do Sul",
                "country": "Brasil"
            },
            "latitude": -31.719189,
            "longitude": -71.719189,
            "detail": "Near the subway station"
        }
    },
    "agent": {
        "id": "18bfca62-e884-4274-8358-3810708751df",
        "name": "Virtual Agent",
        "display_name": "VAgent",
        "tp_doc_identity": "CI",
        "doc_identity": "0001",
        "corporate": false,
        "address": null
    },
    "number": "CTR001",
    "signature_date": "2024-12-25T00:00:00+00:00",
    "approval_date": "2024-12-25T00:00:00+00:00",
    "start_date": "2024-12-26T00:00:00+00:00",
    "end_date": null,
    "cancellation_date": null,
    "suspension_date": null,
    "address": null,
    "total_value": 500,
    "contract_status": "ACTIVE",
    "contract_stage": "INSTALLED",
    "original": null,
    "billing": null,
    "payment_method": null,
    "items": null,
    "config": {
        "username": "james",
        "password": "jamespass",
        "min_upload": null,
        "max_upload": "50M",
        "min_download": null,
        "max_download": "500M",
        "pool_name_ipv4": null,
        "ipv4": null,
        "poll_name_ipv6": null,
        "ipv6": null
    }
}

Modificado em 2025-12-12 13:31:22

Página anterior

List all contracts

Próxima página

Creates/updates a contract based on data provided by an External App