Prime Contract Details API
The Prime Contract Details API allows you to retrieve detailed information about a specific prime contract for a project. This endpoint provides comprehensive data about the contract terms, values, and related information.
Get Prime Contract Details
GET
/api/external/prime-contract-detailscurl -X GET "https://api.kurrent.com/api/external/prime-contract-details?project_id=123&prime_contract_id=456" \
-H "x-api-key: your-api-key" \
-H "x-organization-id: your-organization-id" \
-H "x-company-id: your-company-id"
Query Parameters
- Name
project_id
- Type
- integer
- Required
- Description
The ID of the project that the prime contract belongs to.
- Name
prime_contract_id
- Type
- integer
- Required
- Description
The ID of the specific prime contract to retrieve details for.
Required Headers
- Name
x-api-key
- Type
- string
- Required
- Description
Your API key for authentication.
- Name
x-organization-id
- Type
- string
- Required
- Description
The ID of your organization.
- Name
x-company-id
- Type
- string
- Required
- Description
The ID of the company you're accessing.
Response
dataarray
An array containing the prime contract details object.
Example Response
{
"data": [
{
"id": 456,
"title": "Main Building Construction",
"description": "Construction of the main building for the new headquarters",
"contract_number": "PC-2025-001",
"status": "Active",
"contract_date": "2025-01-15T00:00:00Z",
"start_date": "2025-02-01T00:00:00Z",
"estimated_completion_date": "2026-06-30T00:00:00Z",
"original_contract_value": 5000000.00,
"current_contract_value": 5250000.00,
"executed_change_orders_value": 250000.00,
"pending_change_orders_value": 75000.00,
"project_id": 123,
"customer": {
"id": 789,
"name": "Acme Corporation",
"contact_name": "Jane Smith",
"contact_email": "jane.smith@acme.com",
"contact_phone": "555-123-4567"
},
"payment_terms": {
"type": "Fixed Price",
"payment_schedule": "Monthly",
"retention_percentage": 5.0,
"days_until_due": 30
}
}
]
}
Error Responses
errorstring
A description of the error that occurred.
Example Error Response
{
"error": "prime_contract_id is required in query parameters"
}
Status Codes
- Name
200
- Description
The request was successful.
- Name
400
- Description
Bad request - check the error message for details.
- Name
401
- Description
Unauthorized - invalid or missing API key.
- Name
404
- Description
Not found - the organization, project, or prime contract was not found.
- Name
500
- Description
Internal server error.