Skimmer.PublicApi.Host | v1

Invoices

Endpoint:https://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

idstring · required

Retrieves detailed information for a specified invoice. › Headers

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

paymentsobject[]
The list of payments associated with this invoice.
serviceLocationsobject[]
Service locations associated with this invoice.
customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

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

datestring · date-time

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

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Searches all invoices.

GET

https://publicapi.getskimmer.com

/Invoices/search

Searches all invoices. › query Parameters

Sortsstring
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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate, BillingAddress, BillingCity, BillingState, BillingZip
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all invoices. › Headers

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

ProductCategories DosageTypes

Retrieves detailed information for a specified invoice.

GET

https://publicapi.getskimmer.com

/Invoices/{id}

Retrieves detailed information for a specified invoice. › path Parameters

idstring · required

Retrieves detailed information for a specified invoice. › Headers

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

paymentsobject[]
The list of payments associated with this invoice.
serviceLocationsobject[]
Service locations associated with this invoice.
customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

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

datestring · date-time

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

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Searches all invoices.

GET

https://publicapi.getskimmer.com

/Invoices/search

Searches all invoices. › query Parameters

Sortsstring
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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, CustomerFirstName, CustomerLastName, InvoiceDate, DueDate, BillingAddress, BillingCity, BillingState, BillingZip
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all invoices. › Headers

skimmer-api-keystring · 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

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.