Upload quote

curl --request POST \
  --url https://app.msportal.ai/api/public/v1/financial/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Firewall refresh",
  "number": "A-77",
  "stage": "<string>",
  "ownerName": "<string>",
  "contactName": "<string>",
  "oneTimeTotal": 0,
  "monthlyTotal": 0,
  "annualTotal": 0,
  "currency": "EUR",
  "quoteDate": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "wonAt": "2023-11-07T05:31:56Z",
  "url": "<string>"
}
'

import requests

url = "https://app.msportal.ai/api/public/v1/financial/quotes"

payload = {
    "externalId": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Firewall refresh",
    "number": "A-77",
    "stage": "<string>",
    "ownerName": "<string>",
    "contactName": "<string>",
    "oneTimeTotal": 0,
    "monthlyTotal": 0,
    "annualTotal": 0,
    "currency": "EUR",
    "quoteDate": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "wonAt": "2023-11-07T05:31:56Z",
    "url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: '<string>',
    companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: 'Firewall refresh',
    number: 'A-77',
    stage: '<string>',
    ownerName: '<string>',
    contactName: '<string>',
    oneTimeTotal: 0,
    monthlyTotal: 0,
    annualTotal: 0,
    currency: 'EUR',
    quoteDate: '2023-11-07T05:31:56Z',
    expiresAt: '2023-11-07T05:31:56Z',
    wonAt: '2023-11-07T05:31:56Z',
    url: '<string>'
  })
};

fetch('https://app.msportal.ai/api/public/v1/financial/quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.msportal.ai/api/public/v1/financial/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => '<string>',
    'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => 'Firewall refresh',
    'number' => 'A-77',
    'stage' => '<string>',
    'ownerName' => '<string>',
    'contactName' => '<string>',
    'oneTimeTotal' => 0,
    'monthlyTotal' => 0,
    'annualTotal' => 0,
    'currency' => 'EUR',
    'quoteDate' => '2023-11-07T05:31:56Z',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'wonAt' => '2023-11-07T05:31:56Z',
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.msportal.ai/api/public/v1/financial/quotes"

	payload := strings.NewReader("{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.msportal.ai/api/public/v1/financial/quotes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.msportal.ai/api/public/v1/financial/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "created": true
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "created": true
  }
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

Financial

Upload quote

Create or update one quote with its PDF from your own quoting system. It lists in the Quotes table with the synced ones, and the company’s portal users can open the PDF there. Send the PDF inline as base64. The record is keyed by externalId: push it again to update it, for example when its stage changes; omit pdf to keep the stored one. Requires financial.write and the linked user’s write_settings_integrations permission; staff API keys only. No PSA or quoting integration is needed.

POST

api

public

financial

quotes

Upload quote

curl --request POST \
  --url https://app.msportal.ai/api/public/v1/financial/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Firewall refresh",
  "number": "A-77",
  "stage": "<string>",
  "ownerName": "<string>",
  "contactName": "<string>",
  "oneTimeTotal": 0,
  "monthlyTotal": 0,
  "annualTotal": 0,
  "currency": "EUR",
  "quoteDate": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "wonAt": "2023-11-07T05:31:56Z",
  "url": "<string>"
}
'

import requests

url = "https://app.msportal.ai/api/public/v1/financial/quotes"

payload = {
    "externalId": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Firewall refresh",
    "number": "A-77",
    "stage": "<string>",
    "ownerName": "<string>",
    "contactName": "<string>",
    "oneTimeTotal": 0,
    "monthlyTotal": 0,
    "annualTotal": 0,
    "currency": "EUR",
    "quoteDate": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "wonAt": "2023-11-07T05:31:56Z",
    "url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: '<string>',
    companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: 'Firewall refresh',
    number: 'A-77',
    stage: '<string>',
    ownerName: '<string>',
    contactName: '<string>',
    oneTimeTotal: 0,
    monthlyTotal: 0,
    annualTotal: 0,
    currency: 'EUR',
    quoteDate: '2023-11-07T05:31:56Z',
    expiresAt: '2023-11-07T05:31:56Z',
    wonAt: '2023-11-07T05:31:56Z',
    url: '<string>'
  })
};

fetch('https://app.msportal.ai/api/public/v1/financial/quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.msportal.ai/api/public/v1/financial/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => '<string>',
    'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => 'Firewall refresh',
    'number' => 'A-77',
    'stage' => '<string>',
    'ownerName' => '<string>',
    'contactName' => '<string>',
    'oneTimeTotal' => 0,
    'monthlyTotal' => 0,
    'annualTotal' => 0,
    'currency' => 'EUR',
    'quoteDate' => '2023-11-07T05:31:56Z',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'wonAt' => '2023-11-07T05:31:56Z',
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.msportal.ai/api/public/v1/financial/quotes"

	payload := strings.NewReader("{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.msportal.ai/api/public/v1/financial/quotes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.msportal.ai/api/public/v1/financial/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"<string>\",\n  \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"Firewall refresh\",\n  \"number\": \"A-77\",\n  \"stage\": \"<string>\",\n  \"ownerName\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"oneTimeTotal\": 0,\n  \"monthlyTotal\": 0,\n  \"annualTotal\": 0,\n  \"currency\": \"EUR\",\n  \"quoteDate\": \"2023-11-07T05:31:56Z\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"wonAt\": \"2023-11-07T05:31:56Z\",\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "created": true
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "created": true
  }
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "details": "<unknown>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json

externalId

string

required

Your system's id for the record. Pushing the same externalId again updates the record instead of creating a second one.

Required string length: 1 - 255

companyId

string<uuid>

required

MSPortal company (client) id, from GET /api/public/v1/companies. Its portal users see the record.

name

string

required

Required string length: 1 - 255

Example:

"Firewall refresh"

number

string

Maximum string length: 100

Example:

"A-77"

stage

string

Stage shown in the table, e.g. Draft, Sent, Won, Lost. Roles that limit quotes to some stages hide quotes without one.

Maximum string length: 100

ownerName

string

MSP staff member who owns the quote

Maximum string length: 200

contactName

string

Client contact the quote is for. Roles limited to their own quotes match it against the portal user's full name.

Maximum string length: 200

oneTimeTotal

number

Required range: -1000000000000 <= x <= 1000000000000

monthlyTotal

number

Required range: -1000000000000 <= x <= 1000000000000

annualTotal

number

Required range: -1000000000000 <= x <= 1000000000000

currency

string

ISO 4217 currency code

Pattern: ^[A-Za-z]{3}$

Example:

"EUR"

quoteDate

string<date-time>

When the quote was created (ISO 8601); defaults to now

expiresAt

string<date-time>

wonAt

string<date-time>

url

string

Optional https link to the quote in your system

Maximum string length: 2000

Pattern: ^https:\/\/

pdf

object

The document the client opens in the portal. Required the first time an externalId is pushed; omit it on a later push to keep the stored PDF.

Show child attributes

Response

quote updated

data

object

required

Show child attributes

Budgets

Calendar

Companies

Company Users

Compliance

Dashboards

Devices

Goals

Surveys

NPS Surveys

Tickets

Planner

Reports

Automation Rules

Training

Users

Analytics

Client Onboarding

Projects

Backup

Microsoft 365

Security

Financial

Integrations

Documentation

Broadcasts

Notifications

Standards

Customer Success

Tasks

Tenant Setup

Roles

Ticket Templates

Readiness

Upload quote

Authorizations

Body

Response