Skimmer.PublicApi.Host | v1

Invoices

Endpointhttps://publicapi.getskimmer.com

Retrieves detailed information for a specified invoice.

GET

https://publicapi.getskimmer.com

/Invoices/{id}

Retrieves detailed information for a specified invoice. › path Parameters

id

string · required

Retrieves detailed information for a specified invoice. › 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 invoice. › Responses

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

object[]

The list of payments associated with this invoice.

object[]

Service locations associated with this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.

GET/Invoices/{id}

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

shell

Example Responses

{
  "payments": [
    {
      "paymentDate": "2024-08-25T15:00:00Z",
      "amount": 0,
      "paymentMethod": "paymentMethod",
      "statusMessage": {}
    }
  ],
  "serviceLocations": [
    {
      "serviceLocationAddress": "serviceLocationAddress",
      "serviceLocationCity": {},
      "serviceLocationState": {},
      "serviceLocationZip": {},
      "invoiceItems": [
        {
          "item": "item",
          "description": {},
          "quantity": 0,
          "cost": {},
          "rate": 0,
          "isTaxable": true,
          "amount": 0
        }
      ]
    }
  ],
  "id": "id",
  "customerId": "customerId",
  "customerFirstName": {},
  "customerLastName": {},
  "billingAddress": {},
  "billingCity": {},
  "billingState": {},
  "billingZip": {},
  "status": "status",
  "paymentStatus": "paymentStatus",
  "subtotal": 0,
  "taxAmount": 0,
  "total": 0,
  "amountDue": 0,
  "invoiceDate": "2024-08-25T15:00:00Z",
  "dueDate": "2024-08-25T15:00:00Z"
}

plain

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD).

GET

https://publicapi.getskimmer.com

/Invoices

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD). › query Parameters

date

string · date-time

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD). › 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 invoices for a specified invoice date (required as YYYY-MM-DD). › Responses

object[]

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.

GET/Invoices

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

shell

Example Responses

[
  {
    "id": "id",
    "customerId": "customerId",
    "customerFirstName": {},
    "customerLastName": {},
    "billingAddress": {},
    "billingCity": {},
    "billingState": {},
    "billingZip": {},
    "status": "status",
    "paymentStatus": "paymentStatus",
    "subtotal": 0,
    "taxAmount": 0,
    "total": 0,
    "amountDue": 0,
    "invoiceDate": "2024-08-25T15:00:00Z",
    "dueDate": "2024-08-25T15:00:00Z"
  }
]

plain

Searches all invoices.

GET

https://publicapi.getskimmer.com

/Invoices/search

Searches all invoices. › query Parameters

Sorts

string

Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate, BillingAddress, BillingCity, BillingState, BillingZip

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all invoices. › 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.

Searches all invoices. › Responses

object[]

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.

GET/Invoices/search

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

shell

Example Responses

[
  {
    "id": "id",
    "customerId": "customerId",
    "customerFirstName": {},
    "customerLastName": {},
    "billingAddress": {},
    "billingCity": {},
    "billingState": {},
    "billingZip": {},
    "status": "status",
    "paymentStatus": "paymentStatus",
    "subtotal": 0,
    "taxAmount": 0,
    "total": 0,
    "amountDue": 0,
    "invoiceDate": "2024-08-25T15:00:00Z",
    "dueDate": "2024-08-25T15:00:00Z"
  }
]

plain

LeadSources InstalledItems

Retrieves detailed information for a specified invoice.

GET

https://publicapi.getskimmer.com

/Invoices/{id}

Retrieves detailed information for a specified invoice. › path Parameters

id

string · required

Retrieves detailed information for a specified invoice. › 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 invoice. › Responses

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

object[]

The list of payments associated with this invoice.

object[]

Service locations associated with this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.

{ "payments": [ { "paymentDate": "2024-08-25T15:00:00Z", "amount": 0, "paymentMethod": "paymentMethod", "statusMessage": {} } ], "serviceLocations": [ { "serviceLocationAddress": "serviceLocationAddress", "serviceLocationCity": {}, "serviceLocationState": {}, "serviceLocationZip": {}, "invoiceItems": [ { "item": "item", "description": {}, "quantity": 0, "cost": {}, "rate": 0, "isTaxable": true, "amount": 0 } ] } ], "id": "id", "customerId": "customerId", "customerFirstName": {}, "customerLastName": {}, "billingAddress": {}, "billingCity": {}, "billingState": {}, "billingZip": {}, "status": "status", "paymentStatus": "paymentStatus", "subtotal": 0, "taxAmount": 0, "total": 0, "amountDue": 0, "invoiceDate": "2024-08-25T15:00:00Z", "dueDate": "2024-08-25T15:00:00Z" }

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD).

GET

https://publicapi.getskimmer.com

/Invoices

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD). › query Parameters

date

string · date-time

Retrieves a list of invoices for a specified invoice date (required as YYYY-MM-DD). › 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 invoices for a specified invoice date (required as YYYY-MM-DD). › Responses

object[]

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.

Searches all invoices.

GET

https://publicapi.getskimmer.com

/Invoices/search

Searches all invoices. › query Parameters

Sorts

string

Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate, BillingAddress, BillingCity, BillingState, BillingZip

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all invoices. › 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.

Searches all invoices. › Responses

object[]

id

string · required

The invoice identifier.

customerId

string · required

The customer identifier.

status

string · required

The current status of this invoice.

paymentStatus

string · required

The status related to invoice payment.

subtotal

number · double · required

The total before taxes.

taxAmount

number · double · required

Sales taxes owed on this invoice.

total

number · double · required

Total amount with taxes.

amountDue

number · double · required

Amount due from the customer.

invoiceDate

string · date-time · required

The date this invoice was created.

dueDate

string · date-time · required

The due date for this invoice.

customerFirstName

string | null

The customer's first name.

customerLastName

string | null

The customer's last name.

billingAddress

string | null

The customer's address.

billingCity

string | null

The city for the customer's address.

billingState

string | null

The state for the customer's address.

billingZip

string | null

The zip code for the customer's address.