Skimmer.PublicApi.Host | v1

Billing

Endpointhttps://publicapi.getskimmer.com

Retrieves billable service activity meeting the filter criteria.

GET

https://publicapi.getskimmer.com

/Billing

Retrieves billable service activity meeting the filter criteria. › query Parameters

From

string · date

The inclusive starting service date.

To

string · date

The inclusive ending service date.

Retrieves billable service activity meeting the filter criteria. › 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 billable service activity meeting the filter criteria. › Responses

A billable activity response.

object[]

Customers' billable service activity.

object[]

Tax groups referenced by included activity.

object[]

Work order types referenced by included activity.

object[]

Dosage types referenced by the included activity.

object[]

Products referenced by the included activity.

GET/Billing

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

shell

Example Responses

{
  "serviceActivity": [
    {
      "id": "id",
      "firstName": {},
      "lastName": {},
      "companyName": {},
      "mobilePhone": {},
      "homePhone": {},
      "workPhone": {},
      "primaryEmail": {},
      "secondaryEmail": {},
      "billingAddress": {},
      "billingCity": {},
      "billingState": {},
      "billingZip": {},
      "serviceLocations": [
        {
          "id": "id",
          "address": {},
          "city": {},
          "state": {},
          "zip": {},
          "rate": 0,
          "rateType": "None",
          "taxGroupId": {},
          "workOrders": [
            {
              "id": "id",
              "workOrderTypeId": "workOrderTypeId",
              "serviceDate": "2024-08-25",
              "completeTime": "2024-08-25T15:00:00Z",
              "price": 0,
              "workPerformed": {},
              "bodiesOfWater": [
                {
                  "id": "id",
                  "name": {},
                  "dosages": [
                    {
                      "id": "id",
                      "dosageTypeId": "dosageTypeId",
                      "quantity": 0
                    }
                  ]
                }
              ],
              "installedItems": [
                {
                  "id": "id",
                  "itemType": "Part",
                  "description": {},
                  "quantity": 0,
                  "price": 0,
                  "part": {
                    "category": "category",
                    "make": "make",
                    "model": "model"
                  },
                  "chemical": {
                    "id": "id",
                    "description": "description"
                  },
                  "productId": {}
                }
              ]
            }
          ],
          "routeStops": [
            {
              "id": "id",
              "serviceDate": "2024-08-25",
              "completeTime": "2024-08-25T15:00:00Z",
              "bodiesOfWater": [
                {
                  "id": "id",
                  "name": {},
                  "dosages": [
                    {}
                  ],
                  "installedItems": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "taxGroups": [
    {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    }
  ],
  "workOrderTypes": [
    {
      "id": "id",
      "description": {},
      "defaultPrice": 0,
      "priceIsTaxable": true,
      "deleted": true,
      "colorCode": {}
    }
  ],
  "dosageTypes": [
    {
      "id": "id",
      "deleted": true,
      "description": {},
      "unitOfMeasure": {},
      "cost": 0,
      "price": 0
    }
  ],
  "products": [
    {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "cost": 0,
      "defaultPrice": 0,
      "isTaxable": true,
      "category": {
        "id": "id",
        "deleted": true,
        "createdAt": "2024-08-25T15:00:00Z",
        "updatedAt": "2024-08-25T15:00:00Z",
        "description": "description"
      },
      "name": "name",
      "defaultDescription": {},
      "productCategoryId": {}
    }
  ]
}

plain

BodiesOfWater

Skimmer.PublicApi.Host | v1

Billing

Endpointhttps://publicapi.getskimmer.com

Retrieves billable service activity meeting the filter criteria.

GET

https://publicapi.getskimmer.com

/Billing

Retrieves billable service activity meeting the filter criteria. › query Parameters

From

string · date

The inclusive starting service date.

To

string · date

The inclusive ending service date.

Retrieves billable service activity meeting the filter criteria. › 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 billable service activity meeting the filter criteria. › Responses

A billable activity response.

object[]

Customers' billable service activity.

object[]

Tax groups referenced by included activity.

object[]

Work order types referenced by included activity.

object[]

Dosage types referenced by the included activity.

object[]

Products referenced by the included activity.

GET/Billing

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

shell

Example Responses

{
  "serviceActivity": [
    {
      "id": "id",
      "firstName": {},
      "lastName": {},
      "companyName": {},
      "mobilePhone": {},
      "homePhone": {},
      "workPhone": {},
      "primaryEmail": {},
      "secondaryEmail": {},
      "billingAddress": {},
      "billingCity": {},
      "billingState": {},
      "billingZip": {},
      "serviceLocations": [
        {
          "id": "id",
          "address": {},
          "city": {},
          "state": {},
          "zip": {},
          "rate": 0,
          "rateType": "None",
          "taxGroupId": {},
          "workOrders": [
            {
              "id": "id",
              "workOrderTypeId": "workOrderTypeId",
              "serviceDate": "2024-08-25",
              "completeTime": "2024-08-25T15:00:00Z",
              "price": 0,
              "workPerformed": {},
              "bodiesOfWater": [
                {
                  "id": "id",
                  "name": {},
                  "dosages": [
                    {
                      "id": "id",
                      "dosageTypeId": "dosageTypeId",
                      "quantity": 0
                    }
                  ]
                }
              ],
              "installedItems": [
                {
                  "id": "id",
                  "itemType": "Part",
                  "description": {},
                  "quantity": 0,
                  "price": 0,
                  "part": {
                    "category": "category",
                    "make": "make",
                    "model": "model"
                  },
                  "chemical": {
                    "id": "id",
                    "description": "description"
                  },
                  "productId": {}
                }
              ]
            }
          ],
          "routeStops": [
            {
              "id": "id",
              "serviceDate": "2024-08-25",
              "completeTime": "2024-08-25T15:00:00Z",
              "bodiesOfWater": [
                {
                  "id": "id",
                  "name": {},
                  "dosages": [
                    {}
                  ],
                  "installedItems": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "taxGroups": [
    {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    }
  ],
  "workOrderTypes": [
    {
      "id": "id",
      "description": {},
      "defaultPrice": 0,
      "priceIsTaxable": true,
      "deleted": true,
      "colorCode": {}
    }
  ],
  "dosageTypes": [
    {
      "id": "id",
      "deleted": true,
      "description": {},
      "unitOfMeasure": {},
      "cost": 0,
      "price": 0
    }
  ],
  "products": [
    {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "cost": 0,
      "defaultPrice": 0,
      "isTaxable": true,
      "category": {
        "id": "id",
        "deleted": true,
        "createdAt": "2024-08-25T15:00:00Z",
        "updatedAt": "2024-08-25T15:00:00Z",
        "description": "description"
      },
      "name": "name",
      "defaultDescription": {},
      "productCategoryId": {}
    }
  ]
}

plain

BodiesOfWater