Skynamo Public API

https://apidocs.skynamo.com
Admin
The Skynamo Public API provides the specification for accessing various entities like Customers,...
Tokens:57,014
Snippets:310
Trust Score:8.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get a file

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a file using its unique GUID.

```APIDOC
## GET /files/{guid}

### Description
Fetch information about a file using a Guid.

### Method
GET

### Endpoint
/files/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique GUID of the file.

#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
- **Flags** (string) - Optional - Flags to modify the response.

### Responses
#### Success Response (200)
- **File** (object) - Successfully returned a file.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
```

--------------------------------

### Get all configuration information

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches all information about the instance configurations. This endpoint requires authentication and can optionally accept flags.

```APIDOC
## GET /configurations

### Description
Fetches all information about the instance configurations.

### Method
GET

### Endpoint
/configurations

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
- **Flags** (string) - Optional - Flags to modify the response.

### Responses
#### Success Response (200)
- **Configuration** (object) - Schema defining the structure of the configuration.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
```

--------------------------------

### Get a product

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific Product from their id. Requires API client, product ID, and optional flags.

```APIDOC
## GET /products/{id}

### Description
Fetch information about a specific Product from their id.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the product.

#### Query Parameters
- **Flags** (string) - Optional - Flags to modify the response.

### Responses
#### Success Response (200)
- **Product** (object) - Successfully returned a Product.

#### Error Response (400)
- $ref: "#/responses/400Error"

#### Error Response (404)
- $ref: "#/responses/404Error"
```

--------------------------------

### GET /prices

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Retrieves a list of products' order unit prices. Supports pagination and filtering via flags.

```APIDOC
## GET /prices

### Description
Returns a list of products order units prices. Supports pagination and filtering via flags.

### Method
GET

### Endpoint
/prices

### Parameters
#### Query Parameters
- **Page_Number** (integer) - Optional - The page number to retrieve.
- **Page_Size** (integer) - Optional - The number of items per page.
- **Flags** (string) - Optional - Flags for filtering the results.

### Response
#### Success Response (200)
- **data** (array) - An array of order unit prices, each conforming to the OrderUnitPrice schema.
- **page** (object) - Pagination information, conforming to the PagingResponse schema.

#### Response Example
```json
{
  "data": [
    {
      "example": "OrderUnitPrice object"
    }
  ],
  "page": {
    "example": "PagingResponse object"
  }
}
```
```

--------------------------------

### GET /dealgroups

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Returns a list of deal groups. Supports pagination and filtering.

```APIDOC
## GET /dealgroups

### Description
Returns a list of deal groups.

### Method
GET

### Endpoint
/dealgroups

### Parameters
#### Query Parameters
- **page_number** (integer) - Optional - The page number to retrieve.
- **page_size** (integer) - Optional - The number of items per page.
- **flags** (string) - Optional - Flags to filter deal groups.
- **filters** (string) - Optional - Filters to apply to the deal groups list.

### Responses
#### Success Response (200)
- **data** (array of DealGroup) - Successfully returned a list of deal groups.
- **page** (PagingResponse) - Pagination information.

#### Error Responses
- **400** - Bad Request
```

--------------------------------

### Get a price list

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific price list using its ID.

```APIDOC
## GET /pricelists/{id}

### Description
Fetch information about a specific price list using an id.

### Method
GET

### Endpoint
/pricelists/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the price list.

#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
- **Flags** (string) - Optional - Flags to modify the request.

### Response
#### Success Response (200)
- **schema** (object) - Contains the price list details.
  - **data** (object) - Details of the price list.

#### Response Example
{
  "example": "{\"data\": {}}"
}
```

--------------------------------

### Get a Task

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific task using its unique identifier.

```APIDOC
## GET /tasks/{id}

### Description
Fetch information about a specific task from the unique identifier.

### Method
GET

### Endpoint
/tasks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the task

#### Query Parameters
- **flags** (string) - Optional - Flags to modify the returned data
```

--------------------------------

### Get Price Lists

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Retrieves a list of all price lists available in Skynamo, including their details and status.

```APIDOC
## GET /pricelists

### Description
Retrieves a list of price lists.

### Method
GET

### Endpoint
/pricelists

### Query Parameters
- **page_number** (integer) - Optional - The page number to retrieve.
- **page_size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the price list.
- **name** (string) - The name of the price list.
- **active** (boolean) - Indicates whether the price list is active or not.
- **prices_include_vat** (boolean) - Indicates whether the price list is VAT inclusive or not.
- **last_modified_time** (string) - The last time the price list was modified.
- **currency_code** (string) - The unique code associated with this currency.
- **currency_rate_to_base** (number) - The currency rate to the base rate currency.
- **page_number** (integer) - The current page number.
- **page_size** (integer) - The number of items per page.
- **total_item_count** (integer) - The total number of items available.
- **filtered_item_count** (integer) - The number of items matching the filter.

#### Response Example
```json
{
  "id": 1,
  "name": "Standard Price List",
  "active": true,
  "prices_include_vat": false,
  "last_modified_time": "2023-10-27T10:00:00Z",
  "currency_code": "USD",
  "currency_rate_to_base": 1.0,
  "page_number": 1,
  "page_size": 20,
  "total_item_count": 5,
  "filtered_item_count": 5
}
```
```

--------------------------------

### POST /products

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates a new product in Skynamo.

```APIDOC
## POST /products

### Description
Creates a new product in Skynamo.

### Method
POST

### Endpoint
/products

### Request Body
- **products** (array) - Required - The list of products to create
  - **product** (object) - Required - The product object
    - **code** (string) - The Code of the created entity

### Response
#### Success Response (200)
- **message** (string) - Indicates successful creation.

#### Response Example
```json
{
  "message": "Products created successfully"
}
```
```

--------------------------------

### Get Warehouse by ID

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Retrieves a specific warehouse by its unique identifier.

```APIDOC
## GET /warehouses/{id}

### Description
Retrieves a specific warehouse by its unique identifier.

### Method
GET

### Endpoint
/warehouses/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the warehouse.

### Responses
#### Success Response (200)
- **schema** (object) - The warehouse object.

#### Error Response (400)
- **description** - Bad Request

#### Error Response (404)
- **description** - Not Found
```

--------------------------------

### Create products

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new products in Skynamo. Requires a list of products to add.

```APIDOC
## POST /products

### Description
Creates new products in Skynamo.

### Method
POST

### Endpoint
/products

### Parameters
#### Request Body
- **products** (array) - Required - The list of products to add.
  - **items** (object) - Represents a product to be added.
    - $ref: "#/definitions/ProductPost"

### Responses
#### Success Response (200)
- **message** (string) - A confirmation message.
- **data** (array) - An array of created product objects, each with an 'id'.
  - **id** (integer) - The unique identifier of the created entity.
```

--------------------------------

### Get Warehouse

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific warehouse using an id.

```APIDOC
## GET /warehouses/{id}

### Description
Fetch information about a specific warehouse using an id.

### Method
GET

### Endpoint
/warehouses/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the warehouse.

#### Query Parameters
- **flags** (string) - Optional - Flags to include additional data.

### Response
#### Success Response (200)
- **description** (string) - Successfully returned a warehouse.
```

--------------------------------

### GET /api/public/users

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Retrieves a list of users. Supports pagination and filtering.

```APIDOC
## GET /api/public/users

### Description
Retrieves a list of users. Supports pagination and filtering.

### Method
GET

### Endpoint
/api/public/users

### Parameters
#### Query Parameters
- **Page_Number** (integer) - Optional - The page number to retrieve.
- **Page_Size** (integer) - Optional - The number of items per page.
- **Flags** (string) - Optional - Flags to filter the results.

### Response
#### Success Response (200)
- **data** (array) - An array of User objects.
- **page** (object) - Paging information.

### Response Example
{
  "data": [
    {
      "example": "User object details"
    }
  ],
  "page": {
    "example": "Paging response details"
  }
}
```

--------------------------------

### Create file

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates a new file.

```APIDOC
## POST /files

### Description
Creates a new file.

### Method
POST

### Endpoint
/files

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
```

--------------------------------

### Create Tasks

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Create new tasks.

```APIDOC
## POST /tasks

### Description
Create new tasks.

### Method
POST

### Endpoint
/tasks
```

--------------------------------

### Get Interaction

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific interaction from its unique identifier.

```APIDOC
## GET /interactions/{id}

### Description
Fetch information about a specific interaction from the unique identifier.

### Method
GET

### Endpoint
/interactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the interaction.

#### Query Parameters
- **Flags** (string) - Optional - Flags to include additional data.

### Response
#### Success Response (200)
- [Refer to #/definitions/Interaction]

#### Error Response (400)
- [Refer to #/responses/400Error]

#### Error Response (404)
- [Refer to #/responses/404Error]
```

--------------------------------

### Get a contact

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific contact using their ID.

```APIDOC
## GET /contacts/{id}

### Description
Fetch information about a specific contact using an id.

### Method
GET

### Endpoint
/contacts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the contact.

#### Query Parameters
- **flags** (string) - Optional - Flags to include in the response.

### Responses
#### Success Response (200)
- **Contact** (object) - Successfully returned a contact.

#### Error Response (400)
- **Error** (object) - Bad request.

#### Error Response (404)
- **Error** (object) - Not found.
```

--------------------------------

### ProductPost

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This is a product in Skynamo, used for adding a product. All values not specified will assume their default values.

```APIDOC
## POST /products

### Description
Adds a new product to Skynamo. If certain fields like 'code' are not provided, they will be automatically generated or set to default values.

### Method
POST

### Endpoint
/products

### Request Body
- **code** (string) - Optional - The unique code associated with this product (automatically generated if not supplied)
- **name** (string) - Required - The name of the product
- **active** (boolean) - Optional - Whether or not the product is active (defaults to true)
- **order_units** (array) - Optional - List of all the order units associated with a product
- **custom_fields** (array) - Optional - Certain custom fields may be required depending on the custom fields that have been set up

### Response
#### Success Response (201 Created)
Details of the newly created product.

#### Response Example
```json
{
  "id": 123,
  "code": "PROD-001",
  "name": "Example Product",
  "active": true,
  "order_units": [],
  "custom_fields": []
}
```
```

--------------------------------

### Get User by ID

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific user using their ID.

```APIDOC
## GET /users/{id}

### Description
Fetch information about a specific user using an id.

### Method
GET

### Endpoint
/users/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.

#### Query Parameters
- **Flags** (string) - Optional - Flags to specify additional data to retrieve for the user.

### Response
#### Success Response (200)
- The response will contain a User object.

#### Response Example
(Example response structure depends on the User schema, not provided in source)

#### Error Response (400)
- Refer to the 400Error definition.

#### Error Response (404)
- Refer to the 404Error definition.
```

--------------------------------

### List products

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Returns a list of products. Supports pagination, flags, and filtering.

```APIDOC
## GET /products

### Description
Returns a list of products. Supports pagination, flags, and filtering.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **Page_Number** (integer) - Optional - The page number to retrieve.
- **Page_Size** (integer) - Optional - The number of items per page.
- **Flags** (string) - Optional - Flags to modify the response.
- **FiltersProducts** (object) - Optional - Filters to apply to the product list.

### Responses
#### Success Response (200)
- **data** (array) - An array of Product objects.
- **page** (object) - Pagination information.

#### Error Response (400)
- $ref: "#/responses/400Error"
```

--------------------------------

### GET /quotes/{id}

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific quote from the unique identifier.

```APIDOC
## GET /quotes/{id}

### Description
Fetch information about a specific quote from the unique identifier.

### Method
GET

### Endpoint
/quotes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the quote.

#### Query Parameters
- **Flags** (string) - Optional - Flags to include additional information.

### Response
#### Success Response (200)
- **quote** (object) - The quote object.

#### Response Example
```json
{
  "quote": {
    "id": "string",
    "customer": {
      "id": "string",
      "name": "string"
    },
    "date": "string",
    "totalAmount": 0,
    "currency": "string",
    "status": "string"
  }
}
```
```

--------------------------------

### Product

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This is a product in Skynamo, used for fetching information about products.

```APIDOC
## Product

### Description
This is a product in Skynamo, used for fetching information about products.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique id of the product
```

--------------------------------

### Create Currencies

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new currency entries in the system. Expects an array of currency objects.

```APIDOC
## POST /currencies

### Description
Creates new currencies. Accepts a list of currency objects to be added to Skynamo.

### Method
POST

### Endpoint
/currencies

### Parameters
#### Request Body
- **currencies** (array) - Required - The list of currencies to add. Each item should conform to the CurrencyPost schema.
  - **code** (string) - Required - The currency code (e.g., 'USD').
  - **rate_to_base** (number) - Required - The exchange rate to the base currency.

### Request Example
{
  "currencies": [
    {
      "code": "EUR",
      "rate_to_base": 0.92
    },
    {
      "code": "GBP",
      "rate_to_base": 0.80
    }
  ]
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (array) - An array of created currency objects, including their IDs.
  - **id** (integer) - The unique identifier of the created entity.
  - **code** (string) - The code of the created entity.
  - **rate_to_base** (number) - The rate to base currency rate.

#### Response Example
{
  "message": "Currencies created successfully.",
  "data": [
    {
      "id": 2,
      "code": "EUR",
      "rate_to_base": 0.92
    },
    {
      "id": 3,
      "code": "GBP",
      "rate_to_base": 0.80
    }
  ]
}
```

--------------------------------

### GET /dealgroups/{id}

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Retrieves a specific deal group by its unique identifier.

```APIDOC
## GET /dealgroups/{id}

### Description
Retrieves a specific deal group by its unique identifier.

### Method
GET

### Endpoint
/dealgroups/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deal group.

#### Query Parameters
- **flags** (string) - Optional - Flags to filter deal groups.

### Responses
#### Success Response (200)
- **schema** (DealGroup) - Successfully returned a deal group.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
```

--------------------------------

### PUT /products

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Replaces a set of products with the provided list of products.

```APIDOC
## PUT /products

### Description
Replaces a set of products with the provided list of products.

### Method
PUT

### Endpoint
/products

### Request Body
- **products** (array) - Required - Replace the provided products in Skynamo
  - **product** (object) - The list of products to replace
    - **product** (object) - The product object to replace

### Response
#### Success Response (200)
- **message** (string) - Indicates successful replacement.

#### Response Example
```json
{
  "message": "Products replaced successfully"
}
```
```

--------------------------------

### GET /visitfrequencies

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Returns a list of visit frequencies. Supports pagination, filtering, and sorting.

```APIDOC
## GET /visitfrequencies

### Description
Returns a list of visit frequencies. Supports pagination, filtering, and sorting.

### Method
GET

### Endpoint
/visitfrequencies

### Parameters
#### Query Parameters
- **Page_Number** (integer) - Optional - The page number to retrieve.
- **Page_Size** (integer) - Optional - The number of items per page.
- **Flags** (string) - Optional - Flags to filter the results.
- **FiltersVisitFrequencies** (object) - Optional - Filters for visit frequencies.

### Response
#### Success Response (200)
- **data** (array) - An array of VisitFrequency objects.
- **page** (object) - Paging information.

### Response Example
{
  "data": [
    {
      "example": "VisitFrequency object details"
    }
  ],
  "page": {
    "example": "Paging response details"
  }
}
```

--------------------------------

### WarehousePost Object

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Used for creating a new warehouse in Skynamo. Requires essential details for the new warehouse.

```APIDOC
## WarehousePost Object

### Description
This object is used for creating a new warehouse in Skynamo. It defines the properties required to set up a new warehouse entry.

### Properties
- **id** (integer) - The unique id of the warehouse.
- **name** (string) - The name of the warehouse.
- **order_email** (string) - The email recipients when warehouse selected.
- **credit_request_email** (string) - The email recipients when warehouse selected.
- **quote_email** (string) - The email recipients when warehouse selected.
- **active** (boolean) - Indicates whether the warehouse is active or not.
```

--------------------------------

### GET /visitfrequencies/{id}

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific visit frequency using its ID.

```APIDOC
## GET /visitfrequencies/{id}

### Description
Fetch information about a specific visit frequency using an id.

### Method
GET

### Endpoint
/visitfrequencies/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the visit frequency.
#### Query Parameters
- **Flags** (string) - Optional - Flags to filter the results.

### Response
#### Success Response (200)
- **VisitFrequency** (object) - The visit frequency object.

### Response Example
{
  "example": "VisitFrequency object details"
}
```

--------------------------------

### Create Customer

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Allows for the creation of a new customer in Skynamo. If a code is not provided, it will be automatically generated. All unspecified values will assume their default values.

```APIDOC
## POST /customers

### Description
Creates a new customer in Skynamo. If a `code` is not provided, it will be automatically generated. Unspecified fields will use their default values.

### Method
POST

### Endpoint
/customers

### Parameters
#### Request Body
- **code** (string) - Optional - The unique code associated with this customer (automatically generated if not supplied)
- **name** (string) - Required - The name of the customer
- **active** (boolean) - Optional - Whether or not the customer is active (default: true)
- **location** (object) - Optional - Location details of the customer
- **default_discount** (number) - Optional - The default discount applied for this customer when creating orders (default: 0)
- **price_list_id** (integer) - Optional - The unique identifier of the price list associated with this customer (Alternative to priceListName)
- **price_list_name** (string) - Optional - The name of the price list associated with this customer (Alternative to priceListID - ignored if priceListID is specified)
- **assigned_users** (object) - Optional - Assigned users for the customer
- **default_warehouse_id** (integer) - Optional - The unique identifier of the warehouse associated with this customer
- **custom_fields** (object) - Optional - Custom fields for the customer
```

--------------------------------

### Get Tax Rate

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific tax rate using its ID.

```APIDOC
## GET /taxrates/{id}

### Description
Fetches information about a specific tax rate using its ID.

### Method
GET

### Endpoint
/taxrates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tax rate to retrieve.

#### Query Parameters
- **Flags** (string) - Optional - Flags to modify the request.

### Response
#### Success Response (200)
- **TaxRate** (object) - The retrieved tax rate object.

#### Response Example
```json
{
  "id": "string",
  "name": "string",
  "rate": 0.0,
  "is_active": true
}
```
```

--------------------------------

### Create Orders

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new orders by accepting a list of order objects.

```APIDOC
## POST /orders

### Description
Creates new orders.

### Method
POST

### Endpoint
/orders

### Parameters
#### Request Body
- **orders** (array) - Required - The list of orders to add.
  - Each item in the array should be an object conforming to the OrderPost definition.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.
- **data** (array) - An array of objects, each containing the ID of the created order.

#### Response Example
{
  "message": "Successfully created the new orders",
  "data": [
    {
      "id": 1001
    },
    {
      "id": 1002
    }
  ]
}
```

--------------------------------

### Get Order by ID

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific order using its unique identifier.

```APIDOC
## GET /orders/{id}

### Description
Fetch information about a specific order from the unique identifier.

### Method
GET

### Endpoint
/orders/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the order.

#### Query Parameters
- **flags** (string) - Optional - Flags to include additional information in the response.

### Response
#### Success Response (200)
- **Order** (object) - Contains the details of the order.

#### Response Example
{
  "data": {
    "id": 123,
    "customer_id": 456,
    "order_date": "2023-10-27T10:00:00Z",
    "status": "completed",
    "total_amount": 150.75
  }
}
```

--------------------------------

### Create price lists

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new price lists based on the provided data.

```APIDOC
## POST /pricelists

### Description
Creates price lists.

### Method
POST

### Endpoint
/pricelists

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.

#### Request Body
- **pricelists** (array) - Required - A list of price lists request data.
  - **items** (object) - Represents a single price list.

### Request Example
{
  "example": "{\"pricelists\": [ { } ]}"
}

### Response
#### Success Response (200)
- **schema** (object) - Contains a confirmation message.
  - **message** (string) - Confirmation message.

#### Response Example
{
  "example": "{\"message\": \"Price lists created successfully\"}"
}
```

--------------------------------

### Get Currency Rate Info

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific currency rate by its ID.

```APIDOC
## GET /currencies/{id}

### Description
Fetch information about a specific currency rate from their id.

### Method
GET

### Endpoint
/currencies/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the currency.

### Response
#### Success Response (200)
- **schema** - The schema definition for a Currency object.
  - **$ref** (string) - Reference to the Currency definition.

#### Response Example
{
  "$ref": "#/definitions/Currency"
}
```

--------------------------------

### Create Task

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This endpoint allows for the creation of a new task. All required fields must be provided.

```APIDOC
## POST /tasks

### Description
Creates a new task in Skynamo.

### Method
POST

### Endpoint
/tasks

### Parameters
#### Request Body
- **description** (string) - Required - The description of what the task entails.
- **due_date** (string) - Required - The date when the task is due (the time will be ignored if anytime is set to true).
- **customer_id** (integer) - Optional - The unique identifier of the customer where the task should be completed (if applicable).
- **customer_code** (string) - Optional - The unique code of the customer where the task should be completed (if applicable).
- **reminder_offset** (string) - Optional - A timespan indicating when the reminder for this task will be sent out.
- **completed_date** (string) - Optional - The date the task was completed (the task is not completed if this field is empty).
- **assigned_user_id** (integer) - Required - The unique identifier of the user that must complete this task (required if assigned_user_name is not provided).
- **assigned_user_name** (string) - Required - The user name of the user that must complete this task (required if assigned_user_id is not provided).
- **anytime** (boolean) - Required - True if the task can be completed at any time on the due_date.

### Response
#### Success Response (201)
- **id** (integer) - The unique identifier of the newly created task.
- **description** (string) - The description of what the task entails.
- **due_date** (string) - The date when the task is due.
- **customer_id** (integer) - The unique identifier of the customer.
- **customer_code** (string) - The unique code of the customer.
- **reminder_offset** (string) - A timespan indicating when the reminder for this task will be sent out.
- **completed_date** (string) - The date the task was completed.
- **assigned_user_id** (integer) - The unique identifier of the user that must complete this task.
- **assigned_user_name** (string) - The user name of the user that must complete this task.
- **anytime** (boolean) - True if the task can be completed at any time on the due_date.

### Request Example
```json
{
  "description": "Call customer to confirm appointment.",
  "due_date": "2023-11-15T14:30:00Z",
  "assigned_user_name": "Jane Smith",
  "anytime": false
}
```

### Response Example
```json
{
  "id": 789,
  "description": "Call customer to confirm appointment.",
  "due_date": "2023-11-15T14:30:00Z",
  "customer_id": null,
  "customer_code": null,
  "reminder_offset": "PT1H",
  "completed_date": null,
  "assigned_user_id": 456,
  "assigned_user_name": "Jane Smith",
  "anytime": false
}
```
```

--------------------------------

### Get Scheduled Visit

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific scheduled visit using its unique identifier.

```APIDOC
## GET /scheduledvisits/{id}

### Description
Fetch information about a specific scheduled visit from the unique identifier.

### Method
GET

### Endpoint
/scheduledvisits/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the scheduled visit.

#### Query Parameters
- **API_Client** (string) - Required - Description for API_Client
- **Flags** (string) - Optional - Flags for filtering or modifying the response.

### Responses
#### Success Response (200)
- $ref: "#/definitions/ScheduledVisit"

#### Error Response (400)
- $ref: "#/responses/400Error"

#### Error Response (404)
- $ref: "#/responses/404Error"
```

--------------------------------

### Get Email Interaction

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific email interaction using its unique identifier.

```APIDOC
## GET /emailinteractions/{id}

### Description
Fetch information about a specific email interaction from the unique identifier.

### Method
GET

### Endpoint
/emailinteractions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the email interaction.

#### Query Parameters
- **flags** (string) - Optional - Flags to modify the response.

### Responses
#### Success Response (200)
- **EmailInteraction** (object) - Successfully returned an email interaction.

#### Error Response (400)
- **Error** (object) - Invalid request.

#### Error Response (404)
- **Error** (object) - Resource not found.
```

--------------------------------

### List Users

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Returns a list of users.

```APIDOC
## GET /users

### Description
Returns a list of users.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.

### Response
#### Success Response (200)
- The response will contain a list of User objects.

#### Response Example
(Example response structure depends on the User schema, not provided in source)
```

--------------------------------

### PriceListPost

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This is a price list in Skynamo, used for creating a price list.

```APIDOC
## PriceListPost

### Description
This is a price list in Skynamo, used for creating a price list.

### Method
POST

### Endpoint
/pricelists

### Parameters
#### Request Body
- **name** (string) - Required - The name of the price list
- **active** (boolean) - Optional - Indicates whether the price list is active or not
- **prices_include_vat** (boolean) - Optional - Indicates whether the price list is vat inclusive or not
- **currency_code** (string) - Required - The unique code associated with this currency
```

--------------------------------

### Get a form definition

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific form definition using its unique identifier.

```APIDOC
## GET /formdefinitions/{id}

### Description
Fetch information about a form definition from the unique identifier.

### Method
GET

### Endpoint
/formdefinitions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the form definition.

#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
- **Flags** (string) - Optional - Flags to modify the response.

### Responses
#### Success Response (200)
- **FormDefinition** (object) - Successfully returned a form definition.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
```

--------------------------------

### Create Invoices

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Successfully created the new invoices.

```APIDOC
## POST /invoices

### Description
Creates new invoices in Skynamo.

### Method
POST

### Endpoint
/invoices

### Request Body
- **invoices** (array) - Required - The list of invoices to create.
  - **id** (integer) - The unique identifier of the created invoice

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.
- **data** (array) - A list of created invoice objects.
  - **id** (integer) - The unique identifier of the created invoice

#### Response Example
{
  "message": "Successfully created the new invoices",
  "data": [
    {
      "id": 123
    }
  ]
}
```

--------------------------------

### Get Customer Comment

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific customer comment using its unique identifier.

```APIDOC
## GET /customercomments/{id}

### Description
Fetch information about a specific customer comment from the unique identifier.

### Method
GET

### Endpoint
/customercomments/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the customer comment.

#### Query Parameters
- **API_Client** (string) - Required - Description for API_Client
- **Flags** (string) - Optional - Flags for filtering the results.

### Responses
#### Success Response (200)
- $ref: "#/definitions/CustomerComment"

#### Response Example
{
  "id": 1,
  "customer_id": 123,
  "comment": "Customer expressed satisfaction with the recent service.",
  "created_at": "2023-10-27T10:00:00Z"
}

#### Error Response (400)
- $ref: "#/responses/400Error"

#### Error Response (404)
- $ref: "#/responses/404Error"
```

--------------------------------

### ProductPut

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This is a product in Skynamo, used for updating information about a product. All values not specified will assume their default values.

```APIDOC
## PUT /products/{id}

### Description
Updates information about an existing product in Skynamo. All values not specified will assume their default values.

### Method
PUT

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique id of the product

### Request Body
- **code** (string) - Optional - The unique code associated with this product
- **name** (string) - Optional - The name of the product
- **active** (boolean) - Optional - Whether or not the product is active (defaults to true)
- **order_units** (array) - Optional - List of all the order units associated with a product
- **custom_fields** (array) - Optional - Certain custom fields may be required depending on the custom fields that have been set up
- **transaction_id** (integer) - Optional - The transaction id associated with files in order to link files to a product
- **files** (array) - Optional - List of file Guids

### Response
#### Success Response (200 OK)
Details of the updated product.

#### Response Example
```json
{
  "id": 123,
  "code": "PROD-001",
  "name": "Updated Product Name",
  "active": false,
  "order_units": [],
  "custom_fields": [],
  "transaction_id": 456,
  "files": []
}
```
```

--------------------------------

### Get Credit Request

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetches information about a specific credit request using its unique identifier.

```APIDOC
## GET /creditrequests/{id}

### Description
Fetch information about a specific credit request from the unique identifier.

### Method
GET

### Endpoint
/creditrequests/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the credit request.

#### Query Parameters
- **API_Client** (string) - Required - The API client identifier.
- **Flags** (string) - Optional - Flags to filter the results.

### Response
#### Success Response (200)
- **(object)** - A CreditRequest object.

#### Response Example
{
  "id": 123,
  "status": "Approved",
  "amount": 5000.00,
  "requested_at": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Create Credit Requests

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new credit requests by submitting a list of credit request objects.

```APIDOC
## POST /creditrequests

### Description
Creates new credit requests. Accepts an array of credit request objects to be added to Skynamo.

### Method
POST

### Endpoint
/creditrequests

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Description for API_Client

#### Request Body
- **credit requests** (array) - Required - The list of credit requests to add.
  - **items** (object) - Represents a single credit request.
    - **customer_id** (integer) - Required - The ID of the customer.
    - **amount** (number) - Required - The requested credit amount.
    - **reason** (string) - Optional - The reason for the credit request.

### Request Example
{
  "credit requests": [
    {
      "customer_id": 123,
      "amount": 500.00,
      "reason": "New customer onboarding"
    },
    {
      "customer_id": 456,
      "amount": 750.00,
      "reason": "Increased order volume"
    }
  ]
}

### Responses
#### Success Response (200)
- **message** (string) - A confirmation message.
- **data** (array) - An array of created entities, each with an `id` and `interaction_id`.

#### Response Example
{
  "message": "Successfully created 2 credit requests.",
  "data": [
    {
      "id": 101,
      "interaction_id": 501
    },
    {
      "id": 102,
      "interaction_id": 502
    }
  ]
}

#### Error Response (400)
- $ref: "#/responses/400Error"
```

--------------------------------

### Get Deal Group

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Fetch information about a specific deal group using its unique identifier.

```APIDOC
## GET /dealgroups/{id}

### Description
Get a deal group.

### Method
GET

### Endpoint
/dealgroups/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the deal group.
```

--------------------------------

### CustomFields

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Represents an array of custom fields. Some custom fields might be required based on setup.

```APIDOC
## CustomFields

### Description
List of custom fields. Certain custom fields may be required depending on the custom fields that have been set up.

### Items
- **$ref**: "#/definitions/CustomField"
```

--------------------------------

### List price lists

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Returns a list of all available price lists, with options for pagination.

```APIDOC
## GET /pricelists

### Description
Returns a list of price lists.

### Method
GET

### Endpoint
/pricelists

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Identifier for the API client.
- **Page_Number** (integer) - Optional - The page number to retrieve.
- **Page_Size** (integer) - Optional - The number of items per page.
- **Flags** (string) - Optional - Flags to modify the request.

### Response
#### Success Response (200)
- **schema** (object) - Contains a list of price lists and pagination information.
  - **data** (array) - An array of price list objects.
  - **page** (object) - Pagination details.

#### Response Example
{
  "example": "{\"data\": [{}], \"page\": {}}"
}
```

--------------------------------

### FilePost Object

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Used for uploading a file to Skynamo. It requires the filename, content (as a base64 string), content hash, and the associated transaction ID.

```APIDOC
## FilePost Object

### Description
This is a file in Skynamo.

### Properties
- **filename** (string) - The name of the file
- **content** (string) - The content of the file (base64string)
- **content_hash** (string) - The content hash of the file (base64string)
- **transaction_id** (integer) - The transition id of the file used for orders
```

--------------------------------

### Create Tasks

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

This endpoint allows for the creation of new tasks. It accepts a list of task objects in the request body and returns the details of the created tasks upon success.

```APIDOC
## POST /tasks

### Description
Allows for the creation of new tasks. It accepts a list of task objects in the request body and returns the details of the created tasks upon success.

### Method
POST

### Endpoint
/tasks

### Parameters
#### Request Body
- **tasks** (array) - Required - A list of tasks to be created. Each item in the array should conform to the TaskPost schema.

### Request Example
```json
{
  "tasks": [
    {
      "description": "Task 1 description",
      "dueDate": "2023-12-31T10:00:00Z"
    },
    {
      "description": "Task 2 description",
      "dueDate": "2024-01-15T14:30:00Z"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.
- **data** (array) - An array of objects, each representing a created task with its id, description, and row_version.
  - **id** (integer) - The unique identifier of the created entity.
  - **description** (string) - The description of the created entity.
  - **row_version** (string) - The table row version-stamp number of the entity.

#### Response Example
```json
{
  "message": "Successfully created tasks",
  "data": [
    {
      "id": 101,
      "description": "Task 1 description",
      "row_version": "AAAAAAAAAAA="
    },
    {
      "id": 102,
      "description": "Task 2 description",
      "row_version": "AAAAAAAAAAAAA="
    }
  ]
}
```
```

--------------------------------

### Create Customers

Source: https://apidocs.skynamo.com/swagger_2.0.993_1.0.27.json

Creates new customers in Skynamo. This endpoint allows for the bulk creation of customer records.

```APIDOC
## POST /customers

### Description
Creates new customers.

### Method
POST

### Endpoint
/customers

### Parameters
#### Query Parameters
- **API_Client** (string) - Required - Description for API_Client

#### Request Body
- **customers** (array) - Required - The list of customers to add
  - **items** (object) - Description of customer object
    - **id** (integer) - The unique identifier of the created entity
    - **code** (string) - The code of the created entity
    - **row_version** (integer) - The table row version-stamp number of the entity

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (array) - Array of created customer data
  - **id** (integer) - The unique identifier of the created entity
  - **code** (string) - The code of the created entity
  - **row_version** (integer) - The table row version-stamp number of the entity

#### Error Response (400)
- $ref: "#/responses/400Error"
```
Tokens:
Raw