CloseProjectRequest

Request body for closing a project as sold or withdrawn.

  • buyerContactId
    Type: null | string

    ID of the buyer contact (optional, for external buyers not on the prospect list).

  • buyerProspectId
    Type: null | string

    ID of the buyer prospect (required if buyerType is 'prospect').

  • buyerType
    Type: string Pattern: ^(prospect|external|none)$

    Buyer type: 'prospect' (from prospect list), 'external' (outside buyer), or 'none' (no-sale closure — deal closed without a buyer). Defaults to 'external'.

  • closeDateUtc
    Type: null | stringFormat: date-time

    Close date (defaults to now if omitted).

  • price
    Type: object · PriceOrRange nullable

    Closing price as a single value, a min/max range, or both. Currency is required; scale defaults to none when omitted. Examples: { "value": 1320, "currency": "SEK", "scale": "millions" }, { "min": 50, "max": 60, "currency": "SEK", "scale": "millions" }

    • currency
      Type: string
      min length:  
      3
      max length:  
      3
      required

      ISO 4217 currency code (e.g., "EUR", "SEK", "USD").

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum price. Multiply by scale factor to get actual amount.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum price. Multiply by scale factor to get actual amount. Example: min=100 with scale="millions" = 100 million.

    • scale
      Type: string

      Scale factor for the values: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.

    • value
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Single-point price (the headline number, or the midpoint of a range). Multiply by scale factor for actual amount.

  • yield
    Type: object · PercentOrRange nullable

    Closing yield as a single value, a min/max range, or both. Values are in percentage form (e.g., 5.0 = 5%). Examples: { "value": 4.7 }, { "min": 4.0, "max": 5.5 }

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Maximum percentage (e.g., 8.0 = 8%).

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Minimum percentage (e.g., 5.0 = 5%).

    • value
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Single-point percentage (the headline number, or the midpoint of a range).

Propstreet API Documentation