Skimmer.PublicApi.Host | v1

Quotes

Endpointhttps://publicapi.getskimmer.com

Retrieves a list of quotes.

GET

https://publicapi.getskimmer.com

/Quotes

Retrieves a list of quotes. › query Parameters

customerId

string

Default: null

Retrieves a list of quotes. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves a list of quotes. › Responses

object[]

Represents a quote summary.

id

string · required

The quote identifier.

quoteNumber

integer · int32 · required

The quote number.

quoteDate

string · date-time · required

The date the quote was created.

status

string · enum · required

The current status of the quote.

Enum values:

Draft

Sent

Approved

Rejected

Expired

PendingDeposit

NeedsReview

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes on this quote.

total

number · double · required

Total amount with taxes.

customerId

string | null

The customer identifier.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

customerDisplayName

string | null

The customer's display name.

expirationDate

string | null · date-time

The expiration date of the quote.

depositTotal

number · double

The deposit amount required.

object

Represents a job associated with a quote.

object[]

The service locations for this quote.

GET/Quotes

curl --request GET \
  --url https://publicapi.getskimmer.com/Quotes \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "customerId": {},
    "customerFirstName": {},
    "customerLastName": {},
    "customerDisplayName": {},
    "quoteNumber": 0,
    "quoteDate": "2024-08-25T15:00:00Z",
    "expirationDate": "2024-08-25T15:00:00Z",
    "status": "Draft",
    "subtotal": 0,
    "taxAmount": 0,
    "total": 0,
    "depositTotal": 0,
    "job": {
      "id": "id",
      "jobNumber": 0,
      "status": "NotStarted",
      "cost": 0,
      "taxTotal": 0,
      "discountTotal": 0,
      "feeTotal": 0,
      "subTotal": 0,
      "total": 0,
      "margin": 0,
      "depositTotal": 0,
      "invoiceTotal": 0,
      "invoicePaidAmount": 0
    },
    "quoteLocations": [
      {
        "serviceLocationId": "serviceLocationId",
        "serviceLocationAddress": {},
        "serviceLocationCity": {},
        "serviceLocationState": {},
        "serviceLocationZip": {},
        "lineItems": [
          {
            "itemName": {},
            "description": {},
            "quantity": 0,
            "cost": {},
            "rate": 0
          }
        ]
      }
    ]
  }
]

plain

Retrieves detailed information for a specified quote.

GET

https://publicapi.getskimmer.com

/Quotes/{id}

Retrieves detailed information for a specified quote. › path Parameters

id

string · required

Retrieves detailed information for a specified quote. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves detailed information for a specified quote. › Responses

Represents detailed quote information including service locations and line items.

id

string · required

The quote identifier.

quoteNumber

integer · int32 · required

The quote number.

quoteDate

string · date-time · required

The date the quote was created.

status

string · enum · required

The current status of the quote.

Enum values:

Draft

Sent

Approved

Rejected

Expired

PendingDeposit

NeedsReview

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes on this quote.

total

number · double · required

Total amount with taxes.

object[]

Service locations associated with this quote.

customerId

string | null

The customer identifier.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

customerDisplayName

string | null

The customer's display name.

expirationDate

string | null · date-time

The expiration date of the quote.

depositTotal

number · double

The deposit amount required.

object

Represents a job associated with a quote.

array

The service locations for this quote.

GET/Quotes/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Quotes/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "serviceLocations": [
    {
      "serviceLocationId": "serviceLocationId",
      "serviceLocationAddress": {},
      "serviceLocationCity": {},
      "serviceLocationState": {},
      "serviceLocationZip": {},
      "lineItems": [
        {
          "itemName": {},
          "description": {},
          "quantity": 0,
          "cost": {},
          "rate": 0
        }
      ]
    }
  ],
  "id": "id",
  "customerId": {},
  "customerFirstName": {},
  "customerLastName": {},
  "customerDisplayName": {},
  "quoteNumber": 0,
  "quoteDate": "2024-08-25T15:00:00Z",
  "expirationDate": "2024-08-25T15:00:00Z",
  "status": "Draft",
  "subtotal": 0,
  "taxAmount": 0,
  "total": 0,
  "depositTotal": 0,
  "job": {
    "id": "id",
    "jobNumber": 0,
    "status": "NotStarted",
    "cost": 0,
    "taxTotal": 0,
    "discountTotal": 0,
    "feeTotal": 0,
    "subTotal": 0,
    "total": 0,
    "margin": 0,
    "depositTotal": 0,
    "invoiceTotal": 0,
    "invoicePaidAmount": 0
  },
  "quoteLocations": [
    {}
  ]
}

plain

Routes Products

Skimmer.PublicApi.Host | v1

Quotes

Endpointhttps://publicapi.getskimmer.com

Retrieves a list of quotes.

GET

https://publicapi.getskimmer.com

/Quotes

Retrieves a list of quotes. › query Parameters

customerId

string

Default: null

Retrieves a list of quotes. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves a list of quotes. › Responses

object[]

Represents a quote summary.

id

string · required

The quote identifier.

quoteNumber

integer · int32 · required

The quote number.

quoteDate

string · date-time · required

The date the quote was created.

status

string · enum · required

The current status of the quote.

Enum values:

Draft

Sent

Approved

Rejected

Expired

PendingDeposit

NeedsReview

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes on this quote.

total

number · double · required

Total amount with taxes.

customerId

string | null

The customer identifier.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

customerDisplayName

string | null

The customer's display name.

expirationDate

string | null · date-time

The expiration date of the quote.

depositTotal

number · double

The deposit amount required.

object

Represents a job associated with a quote.

object[]

The service locations for this quote.

GET/Quotes

curl --request GET \
  --url https://publicapi.getskimmer.com/Quotes \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "customerId": {},
    "customerFirstName": {},
    "customerLastName": {},
    "customerDisplayName": {},
    "quoteNumber": 0,
    "quoteDate": "2024-08-25T15:00:00Z",
    "expirationDate": "2024-08-25T15:00:00Z",
    "status": "Draft",
    "subtotal": 0,
    "taxAmount": 0,
    "total": 0,
    "depositTotal": 0,
    "job": {
      "id": "id",
      "jobNumber": 0,
      "status": "NotStarted",
      "cost": 0,
      "taxTotal": 0,
      "discountTotal": 0,
      "feeTotal": 0,
      "subTotal": 0,
      "total": 0,
      "margin": 0,
      "depositTotal": 0,
      "invoiceTotal": 0,
      "invoicePaidAmount": 0
    },
    "quoteLocations": [
      {
        "serviceLocationId": "serviceLocationId",
        "serviceLocationAddress": {},
        "serviceLocationCity": {},
        "serviceLocationState": {},
        "serviceLocationZip": {},
        "lineItems": [
          {
            "itemName": {},
            "description": {},
            "quantity": 0,
            "cost": {},
            "rate": 0
          }
        ]
      }
    ]
  }
]

plain

Retrieves detailed information for a specified quote.

GET

https://publicapi.getskimmer.com

/Quotes/{id}

Retrieves detailed information for a specified quote. › path Parameters

id

string · required

Retrieves detailed information for a specified quote. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves detailed information for a specified quote. › Responses

Represents detailed quote information including service locations and line items.

id

string · required

The quote identifier.

quoteNumber

integer · int32 · required

The quote number.

quoteDate

string · date-time · required

The date the quote was created.

status

string · enum · required

The current status of the quote.

Enum values:

Draft

Sent

Approved

Rejected

Expired

PendingDeposit

NeedsReview

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes on this quote.

total

number · double · required

Total amount with taxes.

object[]

Service locations associated with this quote.

customerId

string | null

The customer identifier.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

customerDisplayName

string | null

The customer's display name.

expirationDate

string | null · date-time

The expiration date of the quote.

depositTotal

number · double

The deposit amount required.

object

Represents a job associated with a quote.

array

The service locations for this quote.

GET/Quotes/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Quotes/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "serviceLocations": [
    {
      "serviceLocationId": "serviceLocationId",
      "serviceLocationAddress": {},
      "serviceLocationCity": {},
      "serviceLocationState": {},
      "serviceLocationZip": {},
      "lineItems": [
        {
          "itemName": {},
          "description": {},
          "quantity": 0,
          "cost": {},
          "rate": 0
        }
      ]
    }
  ],
  "id": "id",
  "customerId": {},
  "customerFirstName": {},
  "customerLastName": {},
  "customerDisplayName": {},
  "quoteNumber": 0,
  "quoteDate": "2024-08-25T15:00:00Z",
  "expirationDate": "2024-08-25T15:00:00Z",
  "status": "Draft",
  "subtotal": 0,
  "taxAmount": 0,
  "total": 0,
  "depositTotal": 0,
  "job": {
    "id": "id",
    "jobNumber": 0,
    "status": "NotStarted",
    "cost": 0,
    "taxTotal": 0,
    "discountTotal": 0,
    "feeTotal": 0,
    "subTotal": 0,
    "total": 0,
    "margin": 0,
    "depositTotal": 0,
    "invoiceTotal": 0,
    "invoicePaidAmount": 0
  },
  "quoteLocations": [
    {}
  ]
}

plain

Routes Products