Create Entity

​

Create a new entity with the provided data.

This endpoint creates a new entity using the data provided in the request body. The entity will be validated according to the defined schema and business rules.

Args: entity_info: Complete entity data for creation including: - All required fields as defined in the entity schema - Optional fields with default values - Custom field values if applicable match_existing: Whether to match the payload against an existing entity on its natural key before creating (see the query parameter description). Entity types with no natural key ignore this and always create. user: Authenticated user information (used for audit trails) response: HTTP response object for status code modification

Returns: EntityResponseModel containing: - id: Unique identifier of the newly created entity, or of the existing entity the payload matched - matched: True when the payload matched an existing entity and updated it rather than creating a new one

Note: - Returns HTTP 201 (Created) on successful creation - Returns HTTP 200 (OK) when the payload matched an existing entity - Returns HTTP 206 (Partial Content) if entity is created but some custom fields failed to save - Automatically sets creation timestamp and user information

Raises: HTTPException: - 400: Invalid input data or validation errors - 401: Authentication required - 403: Insufficient permissions to create entities - 409: Entity already exists (if applicable) - 422: Validation error in request data - 500: Internal server error during creation

Query Parameters

  • match_existing
    Type: boolean

    Match the record against an existing one on its natural key (contacts on email, companies on website domain and name) when the payload carries no id, and update that record instead of creating a duplicate. Set false to always create.

Body·

required
application/json
  • contractId
    Type: string
    required

    Contract ID

  • autoRenewal
    Type: boolean

    Auto renewal flag

  • billingEndDate
    Type: stringFormat: date-timenullable

    Billing end date

  • billingStartDate
    Type: stringFormat: date-timenullable

    Billing start date

  • customBillingFrequency
    Type: integernullable

    Custom billing frequency

  • customDuration
    Type: integernullable

    Custom duration

  • customOptOutDate
    Type: stringFormat: date-timenullable

    Custom opt out date

  • customServiceDuration
    Type: integernullable

    Custom service duration

  • dealId
    Type: stringnullable

    Deal ID — auto-populated from the parent contract on create; any client-supplied value is ignored

  • discountAmount
    Type: numbernullable

    Discount amount

  • eqPaymentsBillingFrequency
    Type: integernullable

    Equal payments billing frequency

  • eqPaymentsNumOfPayments
    Type: integernullable

    Equal payments number of payments

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/revenue_items/
curl 'https://crm.dreamhub.ai/api/v1/contracts/revenue_items/?match_existing=true' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "contractId": "",
  "dealId": "",
  "serviceItemId": "",
  "serviceItemName": "",
  "serviceItemPricingId": "",
  "serviceStartDate": "",
  "serviceEndDate": "",
  "autoRenewal": false,
  "quantity": 1,
  "isDiscountPercentage": true,
  "discountAmount": 1,
  "total": 1,
  "totalLocal": 1,
  "billingStartDate": "",
  "billingEndDate": "",
  "customBillingFrequency": 1,
  "customServiceDuration": 1,
  "customOptOutDate": "",
  "customDuration": 1,
  "eqPaymentsNumOfPayments": 1,
  "eqPaymentsBillingFrequency": 1,
  "itemOrder": 1,
  "scheduledPayments": [
    {
      "paymentNumber": 1,
      "billingDate": "",
      "amount": 1,
      "percentage": 1
    }
  ],
  "pricePerUnit": 1,
  "additionalProperty": "anything"
}'

{
  "id": "string",
  "matched": false
}

The payload matched an existing revenue_item and updated it.