Overview

  ____        _                    _       
 |  _ \  __ _| |_ __ _  __ _  __ _| |_ ___ 
 | | | |/ _` | __/ _` |/ _` |/ _` | __/ _ \
 | |_| | (_| | || (_| | (_| | (_| | ||  __/
 |____/ \__,_|\__\__,_|\__, |\__,_|\__\___|
                       |___/

Datagate API enables you to manage your Datagate data. The Datagate API exposes management functions of the main Datagate application and can be used for a variety of purposes such as managing customer, products and service items.

Datagate API is organized around REST and uses HTTP verbs and response codes that most clients are familiar with.

All requests must be formatted as Content-Type: application/json (except where noted).
All responses are also formatted JSON, encoded in the UTF-8 character encoding (Content-Type: application/json; charset=utf-8).
The Accept header will be ignored for most of the requests.

Base URLs

There are two base URLs for interacting with the Datagate, depending on the environment required:

Environment	URL
Sandbox (Test)	https://sandboxapi.dgportal.net/
Production (Live)	https://api.dgportal.net

Security

Authentication with the Datagate API is via Bearer Token. When your account is setup you are provided with two sets of credentials - one for the test environment (also known as the Sandbox), and one for the live system.

An authorization header containing a valid access token must be included in every Datagate API request like follows:

Authorization: Bearer 422D3FC5-2652-44E3-B2F2-63A15124FBB4

The bearer token is your key to accessing all of your resources via Datagate API. Keep it safe.

SSL must be used in all Datagate API interactions.

Please contact our customer service team to sign up for a developer key and begin using our API today.

ClientID

What is a clientId?

A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Asked for a clientId?

You should never share your clientId, doing so may result in issues relating to integrations in your environments. A clientId is unique to your company and is used to say that API traffic comes from your source. It should be treated as a sort of password and identifier for your company. We may disable any clientId that looks to have been compromised if we suspect any abuse. If anyone asks you to provide a clientId value, do not do so. The only exception to this rule would be integrations where you yourself are creating it. If a tool requires that you enter the API full path, the body, and request, map it to different things, or otherwise is a custom tool that the vendor is not actually developing the calls, you may have to enter your clientId. Do not provide clientId values to integrations that are designed "out-of-the-box" and apply to all users.

Implementation

The clientId is implemented through an HTTP header in the API request. If you are working with a tool that lets you set your own headers, such as postman, you would simply add the header key of ClientID and a value of the unique GUID that is provided.

ClientID: 2FF4CEDF-EBDD-4770-A5C5-E876F59BBC19

Obtain ClientID

Please contact our customer service team to sign up for a clientid and developer key and begin using our API today.

Errors

When an error is encountered you will receive an HTTP status code along with a message and error code in the body of the response. The message is intended to give a user-friendly explanation of the error while the error codes are designed to be machine readable codes that applications can use to better understand the context of the error and react appropriately.

We use the following status codes for errors:

Code	Title	Description
200	OK	The request was successful.
400	Bad request	A validation error occurred.
429	Too Many Requests	The rate limit was exceeded.
500	Internal Server Error	An error occurred with our API.

Rate Limiting

To reduce overuse and protect our platform, we have a rate limiting system in place that will provide details about the number of requests you have made in a specific time period. Clients will receive a HTTP 429 Too Many Requests error if they are in excess of the policy.

The default rate limit policy is 60 calls per minute and 5000 call per day.

Exceeding a rate limit will result in an HTTP 429 (too many requests) response. It will include an X-Rate-Limit-Problem header telling you which limit you have reached.

If you have exceed the minute or daily limit you will also receive a Retry-After http header that tells you how many seconds to wait before making another request. It is important to use the Retry-After header to know when you can start making calls again.

Agreements

Retrieves a list of agreements

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/agreements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/agreements',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/agreements', headers = headers)

print(r.json())

GET /agreements

Parameters

Name	In	Type	Required	Description
customerId	query	string(uuid)	false	Customer ID
page	query	integer	false	Page
pageSize	query	integer	false	PageSize
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "name": "string",
      "billingContactEmail": "string",
      "billingContactFirstName": "string",
      "billingContactLastName": "string",
      "billingFrequencyType": "string",
      "billingStartDate": "2019-08-24T14:15:22Z",
      "billingStartDateLocked": true,
      "ccBillingContactEmail": "string",
      "currency": {
        "id": 0,
        "name": "string"
      },
      "dateStart": "2019-08-24T14:15:22Z",
      "dateEnd": "2019-08-24T14:15:22Z",
      "invoiceLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isDefault": true,
      "notes": "string",
      "paymentTerm": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "poNumber": "string",
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "organizationId": 0
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of agreements	AgreementPaging
default	Default	Error details	Error

Creates a new agreement

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/agreements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/agreements',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/agreements', headers = headers)

print(r.json())

POST /agreements

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "name": "string",
  "billingContactEmail": "string",
  "billingContactFirstName": "string",
  "billingContactLastName": "string",
  "billingFrequencyType": "string",
  "billingStartDate": "2019-08-24T14:15:22Z",
  "billingStartDateLocked": true,
  "ccBillingContactEmail": "string",
  "currency": {
    "id": 0,
    "name": "string"
  },
  "dateStart": "2019-08-24T14:15:22Z",
  "dateEnd": "2019-08-24T14:15:22Z",
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isDefault": true,
  "notes": "string",
  "paymentTerm": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "organizationId": 0
}

Parameters

Name	In	Type	Required	Description
body	body	Agreement	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created Agreement	string

Retrieves an agreement

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/agreements/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/agreements/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/agreements/{id}', headers = headers)

print(r.json())

GET /agreements/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Agreement ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "name": "string",
  "billingContactEmail": "string",
  "billingContactFirstName": "string",
  "billingContactLastName": "string",
  "billingFrequencyType": "string",
  "billingStartDate": "2019-08-24T14:15:22Z",
  "billingStartDateLocked": true,
  "ccBillingContactEmail": "string",
  "currency": {
    "id": 0,
    "name": "string"
  },
  "dateStart": "2019-08-24T14:15:22Z",
  "dateEnd": "2019-08-24T14:15:22Z",
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isDefault": true,
  "notes": "string",
  "paymentTerm": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "organizationId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Agreement details	Agreement
default	Default	Error details	Error

Updates an agreement

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/agreements/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/agreements/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/agreements/{id}', headers = headers)

print(r.json())

PUT /agreements/{id}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "name": "string",
  "billingContactEmail": "string",
  "billingContactFirstName": "string",
  "billingContactLastName": "string",
  "billingFrequencyType": "string",
  "billingStartDate": "2019-08-24T14:15:22Z",
  "billingStartDateLocked": true,
  "ccBillingContactEmail": "string",
  "currency": {
    "id": 0,
    "name": "string"
  },
  "dateStart": "2019-08-24T14:15:22Z",
  "dateEnd": "2019-08-24T14:15:22Z",
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isDefault": true,
  "notes": "string",
  "paymentTerm": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "organizationId": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Agreement ID
body	body	Agreement	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes an agreement

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/agreements/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/agreements/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/agreements/{id}', headers = headers)

print(r.json())

DELETE /agreements/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Agreement ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Customers

Retrieves a list of customers

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/customers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/customers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/customers', headers = headers)

print(r.json())

GET /customers

Parameters

Name	In	Type	Required	Description
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalAccountingReference": "string",
      "accountManager": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isAllowResellerCharge": true,
      "address": {
        "postalAddress1": "string",
        "postalAddress2": "string",
        "city": "string",
        "postalCode": "string",
        "country": "string",
        "state": "string"
      },
      "bankAccount": "string",
      "emailInvoiceTo": "string",
      "invoiceAttentionOfLastName": "string",
      "invoiceAttentionOfName": "string",
      "contactPhone": "string",
      "businessUnit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "creditNoteLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "ccInvoiceTo": "string",
      "creditLimit": 0,
      "customerCode": "string",
      "deliveryMethod": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "doNotGenerateInvoices": true,
      "group": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "integrations": {
        "connectWise": {
          "identifier": "string"
        }
      },
      "invoiceLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "poNumber": "string",
      "isActive": true,
      "companyName": "string",
      "doNotGenerateTaxes": true,
      "paymentMethod": "string",
      "taxNumber": "string",
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxesCalculationBasedOnSiteZipCode": true,
      "customFields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "caption": "string",
          "type": "string",
          "entryMethod": "string",
          "numberOfDecimals": 0,
          "value": "string"
        }
      ],
      "taxDetails": {
        "avalara": {
          "taxExemptions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string"
            }
          ]
        }
      },
      "canCharge": true,
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of customers	CustomersPaging
default	Default	Error details	Error

Creates a new customer

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/customers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/customers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/customers', headers = headers)

print(r.json())

POST /customers

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAccountingReference": "string",
  "accountManager": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isAllowResellerCharge": true,
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string"
  },
  "bankAccount": "string",
  "emailInvoiceTo": "string",
  "invoiceAttentionOfLastName": "string",
  "invoiceAttentionOfName": "string",
  "contactPhone": "string",
  "businessUnit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ccInvoiceTo": "string",
  "creditLimit": 0,
  "customerCode": "string",
  "deliveryMethod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "doNotGenerateInvoices": true,
  "group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "integrations": {
    "connectWise": {
      "identifier": "string"
    }
  },
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "isActive": true,
  "companyName": "string",
  "doNotGenerateTaxes": true,
  "paymentMethod": "string",
  "taxNumber": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxesCalculationBasedOnSiteZipCode": true,
  "customFields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "caption": "string",
      "type": "string",
      "entryMethod": "string",
      "numberOfDecimals": 0,
      "value": "string"
    }
  ],
  "taxDetails": {
    "avalara": {
      "taxExemptions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    }
  },
  "canCharge": true,
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Customer	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAccountingReference": "string",
  "accountManager": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isAllowResellerCharge": true,
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string"
  },
  "bankAccount": "string",
  "emailInvoiceTo": "string",
  "invoiceAttentionOfLastName": "string",
  "invoiceAttentionOfName": "string",
  "contactPhone": "string",
  "businessUnit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ccInvoiceTo": "string",
  "creditLimit": 0,
  "customerCode": "string",
  "deliveryMethod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "doNotGenerateInvoices": true,
  "group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "integrations": {
    "connectWise": {
      "identifier": "string"
    }
  },
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "isActive": true,
  "companyName": "string",
  "doNotGenerateTaxes": true,
  "paymentMethod": "string",
  "taxNumber": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxesCalculationBasedOnSiteZipCode": true,
  "customFields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "caption": "string",
      "type": "string",
      "entryMethod": "string",
      "numberOfDecimals": 0,
      "value": "string"
    }
  ],
  "taxDetails": {
    "avalara": {
      "taxExemptions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    }
  },
  "canCharge": true,
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	created Customer	Customer
default	Default	Error details	Error

Retrieves a customer

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/customers/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/customers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/customers/{id}', headers = headers)

print(r.json())

GET /customers/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAccountingReference": "string",
  "accountManager": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isAllowResellerCharge": true,
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string"
  },
  "bankAccount": "string",
  "emailInvoiceTo": "string",
  "invoiceAttentionOfLastName": "string",
  "invoiceAttentionOfName": "string",
  "contactPhone": "string",
  "businessUnit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ccInvoiceTo": "string",
  "creditLimit": 0,
  "customerCode": "string",
  "deliveryMethod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "doNotGenerateInvoices": true,
  "group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "integrations": {
    "connectWise": {
      "identifier": "string"
    }
  },
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "isActive": true,
  "companyName": "string",
  "doNotGenerateTaxes": true,
  "paymentMethod": "string",
  "taxNumber": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxesCalculationBasedOnSiteZipCode": true,
  "customFields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "caption": "string",
      "type": "string",
      "entryMethod": "string",
      "numberOfDecimals": 0,
      "value": "string"
    }
  ],
  "taxDetails": {
    "avalara": {
      "taxExemptions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    }
  },
  "canCharge": true,
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Customer details	Customer
default	Default	Error details	Error

Updates a customer

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/customers/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/customers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/customers/{id}', headers = headers)

print(r.json())

PUT /customers/{id}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAccountingReference": "string",
  "accountManager": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isAllowResellerCharge": true,
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string"
  },
  "bankAccount": "string",
  "emailInvoiceTo": "string",
  "invoiceAttentionOfLastName": "string",
  "invoiceAttentionOfName": "string",
  "contactPhone": "string",
  "businessUnit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ccInvoiceTo": "string",
  "creditLimit": 0,
  "customerCode": "string",
  "deliveryMethod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "doNotGenerateInvoices": true,
  "group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "integrations": {
    "connectWise": {
      "identifier": "string"
    }
  },
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "isActive": true,
  "companyName": "string",
  "doNotGenerateTaxes": true,
  "paymentMethod": "string",
  "taxNumber": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxesCalculationBasedOnSiteZipCode": true,
  "customFields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "caption": "string",
      "type": "string",
      "entryMethod": "string",
      "numberOfDecimals": 0,
      "value": "string"
    }
  ],
  "taxDetails": {
    "avalara": {
      "taxExemptions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    }
  },
  "canCharge": true,
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer ID
body	body	Customer	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a customer

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/customers/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/customers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/customers/{id}', headers = headers)

print(r.json())

DELETE /customers/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

CustomerUsers

Retrieves a list of customer users

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/customer-users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/customer-users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/customer-users', headers = headers)

print(r.json())

GET /customer-users

Parameters

Name	In	Type	Required	Description
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customers": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "displayName": "string",
      "username": "string",
      "dateCreated": "2019-08-24T14:15:22Z",
      "active": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of customer users	CustomerUsersPaging
default	Default	Error details	Error

Creates a new customer user

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/customer-users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/customer-users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/customer-users', headers = headers)

print(r.json())

POST /customer-users

Body parameter

{
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "password": "string",
  "sendRegistrationLink": true,
  "ccRegistrationLinkTo": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CustomerUserCreate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created customer user	string
default	Default	Error details	Error

Retrieves a customer user

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/customer-users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/customer-users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/customer-users/{id}', headers = headers)

print(r.json())

GET /customer-users/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer user ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "dateCreated": "2019-08-24T14:15:22Z",
  "active": true
}

Responses

Status	Meaning	Description	Schema
200	OK	ServiceItem details	CustomerUserGet
default	Default	Error details	Error

Updates a customer user

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/customer-users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/customer-users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/customer-users/{id}', headers = headers)

print(r.json())

PUT /customer-users/{id}

Body parameter

{
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "active": true,
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer user ID
body	body	CustomerUserUpdate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a customer user

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/customer-users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/customer-users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/customer-users/{id}', headers = headers)

print(r.json())

DELETE /customer-users/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Customer user ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

ServiceItems

Retrieves a list of ServiceItems

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/service-items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/service-items',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/service-items', headers = headers)

print(r.json())

GET /service-items

Parameters

Name	In	Type	Required	Description
service	query	integer	false	service
customerId	query	string	false	customer
site	query	string	false	site
type	query	string	false	type
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "dateStart": "string",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "aliases": [
        "string"
      ],
      "serviceItem": "string",
      "costCentre": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateEnd": "string",
      "description": "string",
      "id": "string",
      "internalNotes": "string",
      "isActive": true,
      "serviceItemType": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      },
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of ServiceItems	ServiceItemPaging
default	Default	Error details	Error

Creates a new ServiceItem

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/service-items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/service-items',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/service-items', headers = headers)

print(r.json())

POST /service-items

Body parameter

{
  "dateStart": "string",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "aliases": [
    "string"
  ],
  "serviceItem": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "string",
  "description": "string",
  "id": "string",
  "internalNotes": "string",
  "isActive": true,
  "serviceItemType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	ServiceItem	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created ServiceItem	string
default	Default	Error details	Error

Retrieves a ServiceItem

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/service-items/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/service-items/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/service-items/{id}', headers = headers)

print(r.json())

GET /service-items/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	ServiceItemID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "dateStart": "string",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "aliases": [
    "string"
  ],
  "serviceItem": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "string",
  "description": "string",
  "id": "string",
  "internalNotes": "string",
  "isActive": true,
  "serviceItemType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	ServiceItem details	ServiceItem
default	Default	Error details	Error

Updates a ServiceItem

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/service-items/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/service-items/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/service-items/{id}', headers = headers)

print(r.json())

PUT /service-items/{id}

Body parameter

{
  "dateStart": "string",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "aliases": [
    "string"
  ],
  "serviceItem": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "string",
  "description": "string",
  "id": "string",
  "internalNotes": "string",
  "isActive": true,
  "serviceItemType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	ServiceItemID
body	body	ServiceItem	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a ServiceItem

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/service-items/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/service-items/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/service-items/{id}', headers = headers)

print(r.json())

DELETE /service-items/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	ServiceItemID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Assignments

Retrieves a list of assignments

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/assignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/assignments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/assignments', headers = headers)

print(r.json())

GET /rating/assignments

Parameters

Name	In	Type	Required	Description
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isDefault": true,
      "startDate": "2019-08-24T14:15:22Z",
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "serviceItem": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of assignments	RatingAssignmentsPaging
default	Default	Error details	Error

Creates a new assignment

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/rating/assignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/rating/assignments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/rating/assignments', headers = headers)

print(r.json())

POST /rating/assignments

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "startDate": "2019-08-24T14:15:22Z",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RatingAssignments	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created assignment	string
default	Default	Error details	Error

Retrieves assignment

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/assignments/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/assignments/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/assignments/{id}', headers = headers)

print(r.json())

GET /rating/assignments/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	assignmentID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "startDate": "2019-08-24T14:15:22Z",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	assignment details	RatingAssignments
default	Default	Error details	Error

Updates assignment

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/rating/assignments/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/rating/assignments/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/rating/assignments/{id}', headers = headers)

print(r.json())

PUT /rating/assignments/{id}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "startDate": "2019-08-24T14:15:22Z",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	AssignmentID
body	body	RatingAssignments	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes assignment

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/rating/assignments/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/rating/assignments/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/rating/assignments/{id}', headers = headers)

print(r.json())

DELETE /rating/assignments/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	AssignmentID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

RateCards

Retrieves a list of rate cards

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards', headers = headers)

print(r.json())

GET /rating/ratecards

Parameters

Name	In	Type	Required	Description
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "description": "string",
      "id": "string",
      "isDefault": true,
      "name": "string",
      "service": {
        "id": 0,
        "name": "string"
      },
      "type": {
        "id": 0,
        "name": "string"
      },
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of rate cards	RateCardPaging
default	Default	Error details	Error

Creates a new rate card

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/rating/ratecards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/rating/ratecards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/rating/ratecards', headers = headers)

print(r.json())

POST /rating/ratecards

Body parameter

{
  "description": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "service": {
    "id": 0,
    "name": "string"
  },
  "type": {
    "id": 0,
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RateCard	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created rate card	string
default	Default	Error details	Error

Retrieves rate card

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards/{id}', headers = headers)

print(r.json())

GET /rating/ratecards/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	RateCardID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "description": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "service": {
    "id": 0,
    "name": "string"
  },
  "type": {
    "id": 0,
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	rate card details	RateCard
default	Default	Error details	Error

Updates rate card

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/rating/ratecards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/rating/ratecards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/rating/ratecards/{id}', headers = headers)

print(r.json())

PUT /rating/ratecards/{id}

Body parameter

{
  "description": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "service": {
    "id": 0,
    "name": "string"
  },
  "type": {
    "id": 0,
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	RateCardID
body	body	RateCard	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes rate card

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/rating/ratecards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/rating/ratecards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/rating/ratecards/{id}', headers = headers)

print(r.json())

DELETE /rating/ratecards/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	RateCardID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Retrieves a list of rate card rates

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards/{rateId}/rates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards/{rateId}/rates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards/{rateId}/rates', headers = headers)

print(r.json())

GET /rating/ratecards/{rateId}/rates

Parameters

Name	In	Type	Required	Description
rateId	path	string(uuid)	true	RateCardID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "destinationDescription": "string",
      "durationRounding": "string",
      "flagFall": 0,
      "freeUnits": 0,
      "id": "string",
      "isDefault": true,
      "prefix": "string",
      "ratingAmount": 0,
      "ratingAmountCost": 0,
      "rating": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "recordType": {
        "id": 0,
        "name": "string"
      },
      "supplierCallTypeCode": "string",
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of rate card rates	RatePaging
default	Default	Error details	Error

Creates a new rate card rates

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/rating/ratecards/{rateId}/rates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/rating/ratecards/{rateId}/rates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/rating/ratecards/{rateId}/rates', headers = headers)

print(r.json())

POST /rating/ratecards/{rateId}/rates

Body parameter

{
  "destinationDescription": "string",
  "durationRounding": "string",
  "flagFall": 0,
  "freeUnits": 0,
  "id": "string",
  "isDefault": true,
  "prefix": "string",
  "ratingAmount": 0,
  "ratingAmountCost": 0,
  "rating": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "recordType": {
    "id": 0,
    "name": "string"
  },
  "supplierCallTypeCode": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
rateId	path	string(uuid)	true	RateCardID
body	body	Rate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created rate card rate	string
default	Default	Error details	Error

Retrieves rate card rates

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}', headers = headers)

print(r.json())

GET /rating/ratecards/{rateId}/rates/{id}

Parameters

Name	In	Type	Required	Description
rateId	path	string(uuid)	true	RateCardID
id	path	string(uuid)	true	RateCardRateID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "destinationDescription": "string",
  "durationRounding": "string",
  "flagFall": 0,
  "freeUnits": 0,
  "id": "string",
  "isDefault": true,
  "prefix": "string",
  "ratingAmount": 0,
  "ratingAmountCost": 0,
  "rating": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "recordType": {
    "id": 0,
    "name": "string"
  },
  "supplierCallTypeCode": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	rate card rate details	Rate
default	Default	Error details	Error

Updates rate card rate

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}', headers = headers)

print(r.json())

PUT /rating/ratecards/{rateId}/rates/{id}

Body parameter

{
  "destinationDescription": "string",
  "durationRounding": "string",
  "flagFall": 0,
  "freeUnits": 0,
  "id": "string",
  "isDefault": true,
  "prefix": "string",
  "ratingAmount": 0,
  "ratingAmountCost": 0,
  "rating": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "recordType": {
    "id": 0,
    "name": "string"
  },
  "supplierCallTypeCode": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Parameters

Name	In	Type	Required	Description
rateId	path	string(uuid)	true	RateCardID
id	path	string(uuid)	true	RateCardRateID
body	body	Rate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes rate card rate

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/rating/ratecards/{rateId}/rates/{id}', headers = headers)

print(r.json())

DELETE /rating/ratecards/{rateId}/rates/{id}

Parameters

Name	In	Type	Required	Description
rateId	path	string(uuid)	true	RateCardID
id	path	string(uuid)	true	RateCardIDRate
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Retrieves a list of price book products

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards/{pbId}/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards/{pbId}/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards/{pbId}/products', headers = headers)

print(r.json())

GET /rating/ratecards/{pbId}/products

Parameters

Name	In	Type	Required	Description
pbId	path	string(uuid)	true	PriceBookID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "label": "string",
      "costAmount": 0,
      "ratingType": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "ratingAmount": 0,
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "allowProRata": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "templateProduct": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isHidden": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of price book products	PriceBookProductPaging
default	Default	Error details	Error

Creates a new price book product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/rating/ratecards/{pbId}/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/rating/ratecards/{pbId}/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/rating/ratecards/{pbId}/products', headers = headers)

print(r.json())

POST /rating/ratecards/{pbId}/products

Body parameter

{
  "id": "string",
  "name": "string",
  "label": "string",
  "costAmount": 0,
  "ratingType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ratingAmount": 0,
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "allowProRata": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "templateProduct": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isHidden": true
}

Parameters

Name	In	Type	Required	Description
pbId	path	string(uuid)	true	PriceBookID
body	body	PriceBookProduct	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created price book product	string
default	Default	Error details	Error

Retrieves price book product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}', headers = headers)

print(r.json())

GET /rating/ratecards/{pbId}/products/{id}

Parameters

Name	In	Type	Required	Description
pbId	path	string(uuid)	true	PriceBookID
id	path	string(uuid)	true	PriceBookIDProductID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "label": "string",
  "costAmount": 0,
  "ratingType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ratingAmount": 0,
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "allowProRata": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "templateProduct": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isHidden": true
}

Responses

Status	Meaning	Description	Schema
200	OK	price book product details	PriceBookProduct
default	Default	Error details	Error

Updates price book products

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}', headers = headers)

print(r.json())

PUT /rating/ratecards/{pbId}/products/{id}

Body parameter

{
  "id": "string",
  "name": "string",
  "label": "string",
  "costAmount": 0,
  "ratingType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ratingAmount": 0,
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "allowProRata": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "templateProduct": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isHidden": true
}

Parameters

Name	In	Type	Required	Description
pbId	path	string(uuid)	true	PriceBookID
id	path	string(uuid)	true	PriceBookIDProductID
body	body	PriceBookProduct	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes price book product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/rating/ratecards/{pbId}/products/{id}', headers = headers)

print(r.json())

DELETE /rating/ratecards/{pbId}/products/{id}

Parameters

Name	In	Type	Required	Description
pbId	path	string(uuid)	true	PriceBookID
id	path	string(uuid)	true	PriceBookIDProductID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Sites

Retrieves a list of sites

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/sites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/sites',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/sites', headers = headers)

print(r.json())

GET /sites

Parameters

Name	In	Type	Required	Description
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "address": {
        "postalAddress1": "string",
        "postalAddress2": "string",
        "city": "string",
        "postalCode": "string",
        "country": "string",
        "state": "string",
        "contactPhone": "string"
      },
      "referenceCode": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "externalReference": "string",
      "isHidingTaxes": true,
      "code": "string",
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of sites	SitePaging
default	Default	Error details	Error

Creates a new site

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/sites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/sites',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/sites', headers = headers)

print(r.json())

POST /sites

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string",
    "contactPhone": "string"
  },
  "referenceCode": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "externalReference": "string",
  "isHidingTaxes": true,
  "code": "string",
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Site	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created Site	string

Retrieves a site

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/sites/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/sites/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/sites/{id}', headers = headers)

print(r.json())

GET /sites/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Site ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string",
    "contactPhone": "string"
  },
  "referenceCode": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "externalReference": "string",
  "isHidingTaxes": true,
  "code": "string",
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Site details	Site
default	Default	Error details	Error

Updates a site

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/sites/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/sites/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/sites/{id}', headers = headers)

print(r.json())

PUT /sites/{id}

Body parameter

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string",
    "contactPhone": "string"
  },
  "referenceCode": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "externalReference": "string",
  "isHidingTaxes": true,
  "code": "string",
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Site ID
body	body	Site	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a site

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/sites/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/sites/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/sites/{id}', headers = headers)

print(r.json())

DELETE /sites/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Site ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

ProductTemplates

Retrieves a list of product templates

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/products-templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/products-templates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/products-templates', headers = headers)

print(r.json())

GET /products-templates

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page
pageSize	query	integer	false	PageSize
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "bundle": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "code": "string",
      "costCentre": "string",
      "description": "string",
      "isExcludingSurcharges": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "isAllowingProRata": true,
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "supplier": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxInclusive": true,
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "productKit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "charges": [
        {
          "amount": 0,
          "amountPercentage": 0,
          "chargeType": {
            "id": 0,
            "name": "string"
          },
          "cost": 0,
          "dateEnd": "2019-08-24T14:15:22Z",
          "dateStart": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "quantity": 0,
          "scopeType": {
            "id": 0,
            "name": "string"
          },
          "sell": 0
        }
      ]
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of product templates	ProductTemplatePaging
default	Default	Error details	Error

Creates a new product template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/products-templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/products-templates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/products-templates', headers = headers)

print(r.json())

POST /products-templates

Body parameter

{
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "code": "string",
  "costCentre": "string",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "isAllowingProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productKit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ProductTemplate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created product template	string

Updates a product template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/products-templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/products-templates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/products-templates/{id}', headers = headers)

print(r.json())

PUT /products-templates/{id}

Body parameter

{
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "code": "string",
  "costCentre": "string",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "isAllowingProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productKit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product Template ID
body	body	ProductTemplate	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a product template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/products-templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/products-templates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/products-templates/{id}', headers = headers)

print(r.json())

DELETE /products-templates/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product Template ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Creates a charge for the product template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/products-templates/{id}/charges", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/products-templates/{id}/charges',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/products-templates/{id}/charges', headers = headers)

print(r.json())

POST /products-templates/{id}/charges

Body parameter

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeType": {
    "id": 0,
    "name": "string"
  },
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "quantity": 0,
  "scopeType": {
    "id": 0,
    "name": "string"
  },
  "sell": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product Template ID
body	body	Charge	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created charge	string
default	Default	Error details	Error

Updates a charge for the product template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/products-templates/{id}/charges/{chargeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/products-templates/{id}/charges/{chargeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/products-templates/{id}/charges/{chargeId}', headers = headers)

print(r.json())

PUT /products-templates/{id}/charges/{chargeId}

Body parameter

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeType": {
    "id": 0,
    "name": "string"
  },
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "quantity": 0,
  "scopeType": {
    "id": 0,
    "name": "string"
  },
  "sell": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product Template ID
chargeId	path	string(uuid)	true	Charge ID
body	body	Charge	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a charge

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/products-templates/{id}/charges/{chargeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/products-templates/{id}/charges/{chargeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/products-templates/{id}/charges/{chargeId}', headers = headers)

print(r.json())

DELETE /products-templates/{id}/charges/{chargeId}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product Template ID
chargeId	path	string(uuid)	true	Charge ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

KitTemplates

Retrieves a list of kit templates

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/kit-templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/kit-templates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/kit-templates', headers = headers)

print(r.json())

GET /kit-templates

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page
pageSize	query	integer	false	PageSize
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "cost": 0,
      "sell": 0,
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "proRata": true,
      "excludeSurcharges": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of kit templates	KitTemplatePaging
default	Default	Error details	Error

Creates a new kit template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/kit-templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/kit-templates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/kit-templates', headers = headers)

print(r.json())

POST /kit-templates

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "cost": 0,
  "sell": 0,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "proRata": true,
  "excludeSurcharges": true
}

Parameters

Name	In	Type	Required	Description
body	body	Kit	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created kit template	string

Updates a kit template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/kit-templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/kit-templates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/kit-templates/{id}', headers = headers)

print(r.json())

PUT /kit-templates/{id}

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "cost": 0,
  "sell": 0,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "proRata": true,
  "excludeSurcharges": true
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit ID
body	body	Kit	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a kit template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/kit-templates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/kit-templates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/kit-templates/{id}', headers = headers)

print(r.json())

DELETE /kit-templates/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit 0ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Retrieves a list of kit products

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/kit-templates/{id}/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/kit-templates/{id}/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/kit-templates/{id}/products', headers = headers)

print(r.json())

GET /kit-templates/{id}/products

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

[
  {
    "productId": "string",
    "productName": "string",
    "productLabel": "string",
    "supplier": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "productCategory": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "glCode": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "bundle": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "charges": [
      {
        "amount": 0,
        "amountPercentage": 0,
        "chargeType": {
          "id": 0,
          "name": "string"
        },
        "cost": 0,
        "dateEnd": "2019-08-24T14:15:22Z",
        "dateStart": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "quantity": 0,
        "scopeType": {
          "id": 0,
          "name": "string"
        },
        "sell": 0
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List of kit products	Inline
default	Default	Error details	Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[KitProduct]	false	none	none
» productId	string	false	none	none
» productName	string	false	none	none
» productLabel	string	false	none	none
» supplier	SupplierReference	false	none	none
»» id	string(uuid)	false	none	none
»» name	string	false	none	none
» productCategory	ProductCategoryReference	false	none	none
»» id	string(uuid)	false	none	none
»» name	string	false	none	none
» glCode	GLCodeReference	false	none	none
»» id	string(uuid)	false	none	none
»» name	string	false	none	none
» bundle	BundleReference	false	none	none
»» id	string(uuid)	false	none	none
»» name	string	false	none	none
» charges	[Charge]	false	none	none
»» amount	number	false	none	none
»» amountPercentage	number	false	none	none
»» chargeType	ChargeType	false	none	none
»»» id	integer	false	none	none
»»» name	string	false	none	none
»» cost	number	false	none	none
»» dateEnd	string(date-time)	false	none	none
»» dateStart	string(date-time)	false	none	none
»» description	string	false	none	none
»» id	string(uuid)	false	none	none
»» name	string	false	none	none
»» quantity	number	false	none	none
»» scopeType	ScopeType	false	none	none
»»» id	integer	false	none	none
»»» name	string	false	none	none
»» sell	number	false	none	none

Creates a new kit product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/kit-templates/{id}/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/kit-templates/{id}/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/kit-templates/{id}/products', headers = headers)

print(r.json())

POST /kit-templates/{id}/products

Body parameter

{
  "productId": "string",
  "productName": "string",
  "productLabel": "string",
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit ID
body	body	KitProduct	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created kit product	string

Updates a product for the kit

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/kit-templates/{id}/products/{productId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/kit-templates/{id}/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/kit-templates/{id}/products/{productId}', headers = headers)

print(r.json())

PUT /kit-templates/{id}/products/{productId}

Body parameter

{
  "productId": "string",
  "productName": "string",
  "productLabel": "string",
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit ID
productId	path	string(uuid)	true	Product ID
body	body	KitProduct	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a product for the kit template

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/kit-templates/{id}/products/{productId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/kit-templates/{id}/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/kit-templates/{id}/products/{productId}', headers = headers)

print(r.json())

DELETE /kit-templates/{id}/products/{productId}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Kit ID
productId	path	string(uuid)	true	Product ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Invoices

Search for invoices

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/invoices/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/invoices/search',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/invoices/search', headers = headers)

print(r.json())

POST /invoices/search

Body parameter

{
  "$and": [
    {
      "CustomerId": "2900207f-61b9-4f8a-8f20-e24baf689d3d",
      "InvoiceDate": "2019-08-24T14:15:22Z",
      "BillingPeriodId": "f090d09e-f275-4c9e-93b6-da9c1de68f10"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	InvoiceSearch	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "amount": 0,
      "amountDue": 0,
      "amountPaid": 0,
      "billingPeriod": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "creditNoteId": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateDue": "2019-08-24T14:15:22Z",
      "dateGenerated": "2019-08-24T14:15:22Z",
      "deliveryMethod": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "invoiceTypeId": 0,
      "isCreditNote": true,
      "periodEnd": "2019-08-24T14:15:22Z",
      "periodStart": "2019-08-24T14:15:22Z",
      "status": {
        "id": 0,
        "name": "string"
      },
      "subTotal": 0,
      "taxAmount": 0,
      "organisationId": 0
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of invoices matching the search criteria	InvoicesPaging
default	Default	Error details	Error

Retrieves an invoice line details

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/invoices/{id}/details", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/invoices/{id}/details',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/invoices/{id}/details', headers = headers)

print(r.json())

GET /invoices/{id}/details

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	invoice ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "invoiceNumber": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "transactions": [
    {
      "id": "string",
      "productCode": "string",
      "productLabel": "string",
      "quantity": 0.1,
      "amount": 0.1,
      "tax": 0.1,
      "total": 0.1,
      "isHidden": true,
      "dateStart": "2019-08-24T14:15:22Z",
      "dateEnd": "2019-08-24T14:15:22Z"
    }
  ],
  "usage": [
    {
      "id": "string",
      "serviceItem": "string",
      "serviceItemDescription": "string",
      "service": "string",
      "recordType": "string",
      "quantity": 0.1,
      "amount": 0.1,
      "tax": 0.1,
      "total": 0.1
    }
  ],
  "surcharges": [
    {
      "id": "string",
      "name": "string",
      "amount": 0.1
    }
  ],
  "taxes": [
    {
      "name": "string",
      "value": 0.1,
      "isTaxInclusive": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Invoice line details	InvoiceDetails
default	Default	Error details	Error

Products

Retrieves a list of products

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/products', headers = headers)

print(r.json())

GET /products

Parameters

Name	In	Type	Required	Description
customerId	query	string(uuid)	false	Customer ID
page	query	integer	false	Page
pageSize	query	integer	false	PageSize
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "data": [
    {
      "dateStart": "2019-08-24T14:15:22Z",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "bundle": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "label": "string",
      "costCentre": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateEnd": "2019-08-24T14:15:22Z",
      "description": "string",
      "isExcludingSurcharges": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "code": "string",
      "allowProRata": true,
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      },
      "serviceItem": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "siteZ": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "siteZCustomer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "supplier": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxInclusive": true,
      "isHidden": true,
      "kit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "charges": [
        {
          "amount": 0,
          "amountPercentage": 0,
          "chargeType": {
            "id": 0,
            "name": "string"
          },
          "cost": 0,
          "dateEnd": "2019-08-24T14:15:22Z",
          "dateStart": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "quantity": 0,
          "scopeType": {
            "id": 0,
            "name": "string"
          },
          "sell": 0
        }
      ],
      "taxDetails": {
        "avalara": {
          "tsPair": {
            "code": "string",
            "description": "string"
          },
          "saleType": {
            "id": 0,
            "name": "string"
          }
        }
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "serviceItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "taxCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of products	ProductPaging
default	Default	Error details	Error

Creates a new product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/products', headers = headers)

print(r.json())

POST /products

Body parameter

{
  "dateStart": "2019-08-24T14:15:22Z",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "label": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "2019-08-24T14:15:22Z",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "code": "string",
  "allowProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZ": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZCustomer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "isHidden": true,
  "kit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ],
  "taxDetails": {
    "avalara": {
      "tsPair": {
        "code": "string",
        "description": "string"
      },
      "saleType": {
        "id": 0,
        "name": "string"
      }
    }
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "taxCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Product	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created product	string

Updates a product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/products/{id}', headers = headers)

print(r.json())

PUT /products/{id}

Body parameter

{
  "dateStart": "2019-08-24T14:15:22Z",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "label": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "2019-08-24T14:15:22Z",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "code": "string",
  "allowProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZ": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZCustomer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "isHidden": true,
  "kit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ],
  "taxDetails": {
    "avalara": {
      "tsPair": {
        "code": "string",
        "description": "string"
      },
      "saleType": {
        "id": 0,
        "name": "string"
      }
    }
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "taxCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
body	body	Product	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/products/{id}', headers = headers)

print(r.json())

DELETE /products/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Retrieves a product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.dgportal.net/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.dgportal.net/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.dgportal.net/products/{id}', headers = headers)

print(r.json())

GET /products/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

{
  "dateStart": "2019-08-24T14:15:22Z",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "label": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "2019-08-24T14:15:22Z",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "code": "string",
  "allowProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZ": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZCustomer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "isHidden": true,
  "kit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ],
  "taxDetails": {
    "avalara": {
      "tsPair": {
        "code": "string",
        "description": "string"
      },
      "saleType": {
        "id": 0,
        "name": "string"
      }
    }
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "taxCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Product details	Product
default	Default	Error details	Error

Creates a charge for the product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.dgportal.net/products/{id}/charges", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.dgportal.net/products/{id}/charges',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.dgportal.net/products/{id}/charges', headers = headers)

print(r.json())

POST /products/{id}/charges

Body parameter

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeType": {
    "id": 0,
    "name": "string"
  },
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "quantity": 0,
  "scopeType": {
    "id": 0,
    "name": "string"
  },
  "sell": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
body	body	Charge	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

200 Response

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Status	Meaning	Description	Schema
200	OK	ID of created charge	string
default	Default	Error details	Error

Updates a charge for the product

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.dgportal.net/products/{id}/charges/{chargeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.dgportal.net/products/{id}/charges/{chargeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.dgportal.net/products/{id}/charges/{chargeId}', headers = headers)

print(r.json())

PUT /products/{id}/charges/{chargeId}

Body parameter

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeType": {
    "id": 0,
    "name": "string"
  },
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "quantity": 0,
  "scopeType": {
    "id": 0,
    "name": "string"
  },
  "sell": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
chargeId	path	string(uuid)	true	Charge ID
body	body	Charge	false	none
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated successfully	None
default	Default	Error details	Error

Deletes a charge

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "ClientId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.dgportal.net/products/{id}/charges/{chargeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'ClientId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.dgportal.net/products/{id}/charges/{chargeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'ClientId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.dgportal.net/products/{id}/charges/{chargeId}', headers = headers)

print(r.json())

DELETE /products/{id}/charges/{chargeId}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Product ID
chargeId	path	string(uuid)	true	Charge ID
ClientId	header	string	true	A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Example responses

default Response

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deleted successfully	None
default	Default	Error details	Error

Schemas

Error

{
  "code": "string",
  "details": "string",
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
details	string	false	none	none
error	string	false	none	none

CustomerReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

Currency

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

InvoiceLayout

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

PaymentTerm

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

SiteReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

TaxRateReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

TypeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

RatingReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

RecordTypeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

ExemptionReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

RateCardReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

AccountManagerReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

BusinessUnitReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

DeliveryMethodReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

CustomerGroupReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

InvoiceLayoutReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

CreditNoteLayoutReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

BillingPeriodReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

InvoiceStatusReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

Address

{
  "postalAddress1": "string",
  "postalAddress2": "string",
  "city": "string",
  "postalCode": "string",
  "country": "string",
  "state": "string"
}

Properties

Name	Type	Required	Restrictions	Description
postalAddress1	string	false	none	none
postalAddress2	string	false	none	none
city	string	false	none	none
postalCode	string	false	none	none
country	string	false	none	none
state	string	false	none	none

Agreement

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "name": "string",
  "billingContactEmail": "string",
  "billingContactFirstName": "string",
  "billingContactLastName": "string",
  "billingFrequencyType": "string",
  "billingStartDate": "2019-08-24T14:15:22Z",
  "billingStartDateLocked": true,
  "ccBillingContactEmail": "string",
  "currency": {
    "id": 0,
    "name": "string"
  },
  "dateStart": "2019-08-24T14:15:22Z",
  "dateEnd": "2019-08-24T14:15:22Z",
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isDefault": true,
  "notes": "string",
  "paymentTerm": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "organizationId": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
customer	CustomerReference	true	none	none
name	string	true	none	none
billingContactEmail	string	false	none	none
billingContactFirstName	string	false	none	none
billingContactLastName	string	false	none	none
billingFrequencyType	string	true	none	none
billingStartDate	string(date-time)	true	none	none
billingStartDateLocked	boolean	false	none	none
ccBillingContactEmail	string	false	none	none
currency	Currency	false	none	none
dateStart	string(date-time)	true	none	none
dateEnd	string(date-time)	false	none	none
invoiceLayout	InvoiceLayout	false	none	none
isDefault	boolean	false	none	none
notes	string	false	none	none
paymentTerm	PaymentTerm	true	none	none
poNumber	string	false	none	none
site	SiteReference	false	none	none
taxRate	TaxRateReference	false	none	none
organizationId	number	false	none	none

AgreementReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

Site

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string",
    "contactPhone": "string"
  },
  "referenceCode": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "externalReference": "string",
  "isHidingTaxes": true,
  "code": "string",
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none
address	SiteAddress	false	none	none
referenceCode	string	false	none	none
customer	CustomerReference	false	none	none
rateCard	RateCardReference	false	none	none
externalReference	string	false	none	none
isHidingTaxes	boolean	false	none	none
code	string	false	none	none
extraField1	string	false	none	none
extraField2	string	false	none	none
extraField3	string	false	none	none
extraField4	string	false	none	none
extraField5	string	false	none	none

SiteAddress

{
  "postalAddress1": "string",
  "postalAddress2": "string",
  "city": "string",
  "postalCode": "string",
  "country": "string",
  "state": "string",
  "contactPhone": "string"
}

Properties

Name	Type	Required	Restrictions	Description
postalAddress1	string	false	none	none
postalAddress2	string	false	none	none
city	string	false	none	none
postalCode	string	false	none	none
country	string	false	none	none
state	string	false	none	none
contactPhone	string	false	none	none

RatingAssignments

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "startDate": "2019-08-24T14:15:22Z",
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
isDefault	boolean	false	none	none
startDate	string(date-time)	false	none	none
site	SiteReference	false	none	none
customer	CustomerReference	false	none	none
rateCard	RateCardReference	false	none	none
serviceItem	ServiceItemReference	false	none	none
service	ServiceReference	false	none	none

RateCard

{
  "description": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "service": {
    "id": 0,
    "name": "string"
  },
  "type": {
    "id": 0,
    "name": "string"
  },
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	none
id	string	false	none	none
isDefault	boolean	false	none	none
name	string	false	none	none
service	ServiceReference	false	none	none
type	TypeReference	false	none	none
taxRate	TaxRateReference	false	none	none

ServiceItem

{
  "dateStart": "string",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "aliases": [
    "string"
  ],
  "serviceItem": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "string",
  "description": "string",
  "id": "string",
  "internalNotes": "string",
  "isActive": true,
  "serviceItemType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
dateStart	string	false	none	none
agreement	AgreementReference	false	none	none
aliases	[string]	false	none	none
serviceItem	string	false	none	none
costCentre	string	false	none	none
customer	CustomerReference	false	none	none
dateEnd	string	false	none	none
description	string	false	none	none
id	string	false	none	none
internalNotes	string	false	none	none
isActive	boolean	false	none	none
serviceItemType	ServiceItemReference	false	none	none
service	ServiceReference	false	none	none
site	SiteReference	false	none	none

Rate

{
  "destinationDescription": "string",
  "durationRounding": "string",
  "flagFall": 0,
  "freeUnits": 0,
  "id": "string",
  "isDefault": true,
  "prefix": "string",
  "ratingAmount": 0,
  "ratingAmountCost": 0,
  "rating": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "recordType": {
    "id": 0,
    "name": "string"
  },
  "supplierCallTypeCode": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
destinationDescription	string	false	none	none
durationRounding	string	false	none	none
flagFall	number	false	none	none
freeUnits	number	false	none	none
id	string	false	none	none
isDefault	boolean	false	none	none
prefix	string	false	none	none
ratingAmount	number	false	none	none
ratingAmountCost	number	false	none	none
rating	RatingReference	false	none	none
recordType	RecordTypeReference	false	none	none
supplierCallTypeCode	string	false	none	none
taxRate	TaxRateReference	false	none	none

PriceBookProduct

{
  "id": "string",
  "name": "string",
  "label": "string",
  "costAmount": 0,
  "ratingType": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ratingAmount": 0,
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "allowProRata": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "templateProduct": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isHidden": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
label	string	false	none	none
costAmount	number	false	none	none
ratingType	RatingReference	false	none	none
ratingAmount	number	false	none	none
taxRate	TaxRateReference	false	none	none
allowProRata	boolean	false	none	none
glCode	GLCodeReference	false	none	none
productCategory	ProductCategoryReference	false	none	none
templateProduct	TemplateProductReference	false	none	none
isHidden	boolean	false	none	none

Customer

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAccountingReference": "string",
  "accountManager": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isAllowResellerCharge": true,
  "address": {
    "postalAddress1": "string",
    "postalAddress2": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "state": "string"
  },
  "bankAccount": "string",
  "emailInvoiceTo": "string",
  "invoiceAttentionOfLastName": "string",
  "invoiceAttentionOfName": "string",
  "contactPhone": "string",
  "businessUnit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "ccInvoiceTo": "string",
  "creditLimit": 0,
  "customerCode": "string",
  "deliveryMethod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "doNotGenerateInvoices": true,
  "group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "integrations": {
    "connectWise": {
      "identifier": "string"
    }
  },
  "invoiceLayout": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "poNumber": "string",
  "isActive": true,
  "companyName": "string",
  "doNotGenerateTaxes": true,
  "paymentMethod": "string",
  "taxNumber": "string",
  "taxRate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxesCalculationBasedOnSiteZipCode": true,
  "customFields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "caption": "string",
      "type": "string",
      "entryMethod": "string",
      "numberOfDecimals": 0,
      "value": "string"
    }
  ],
  "taxDetails": {
    "avalara": {
      "taxExemptions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    }
  },
  "canCharge": true,
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
externalAccountingReference	string	false	none	none
accountManager	AccountManagerReference	false	none	none
agreement	AgreementReference	false	none	none
isAllowResellerCharge	boolean	false	none	none
address	Address	false	none	none
bankAccount	string	false	none	none
emailInvoiceTo	string	false	none	none
invoiceAttentionOfLastName	string	false	none	none
invoiceAttentionOfName	string	false	none	none
contactPhone	string	false	none	none
businessUnit	BusinessUnitReference	false	none	none
creditNoteLayout	CreditNoteLayoutReference	false	none	none
ccInvoiceTo	string	false	none	none
creditLimit	number	false	none	none
customerCode	string	false	none	none
deliveryMethod	DeliveryMethodReference	false	none	none
doNotGenerateInvoices	boolean	false	none	none
group	CustomerGroupReference	false	none	none
integrations	CustomerIntegrations	false	none	none
invoiceLayout	InvoiceLayoutReference	false	none	none
poNumber	string	false	none	none
isActive	boolean	false	none	none
companyName	string	false	none	none
doNotGenerateTaxes	boolean	false	none	none
paymentMethod	string	false	none	none
taxNumber	string	false	none	none
taxRate	TaxRateReference	false	none	none
isTaxesCalculationBasedOnSiteZipCode	boolean	false	none	none
customFields	[CustomField]	false	none	none
taxDetails	CustomerTaxDetails	false	none	none
canCharge	boolean	false	none	none
extraField1	string	false	none	none
extraField2	string	false	none	none
extraField3	string	false	none	none
extraField4	string	false	none	none
extraField5	string	false	none	none

CustomerIntegrations

{
  "connectWise": {
    "identifier": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
connectWise	ConnectWiseIntegration	false	none	none

ConnectWiseIntegration

{
  "identifier": "string"
}

Properties

Name	Type	Required	Restrictions	Description
identifier	string	false	none	Идентификатор в системе ConnectWise

CustomerUserGet

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "dateCreated": "2019-08-24T14:15:22Z",
  "active": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
customers	[CustomerReference]	false	none	none
displayName	string	false	none	none
username	string	false	none	none
dateCreated	string(date-time)	false	none	none
active	boolean	false	none	none

CustomerUserUpdate

{
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "active": true,
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
customers	[CustomerReference]	false	none	none
displayName	string	false	none	none
username	string	false	none	none
active	boolean	false	none	none
password	string	false	none	none

CustomerUserCreate

{
  "customers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "displayName": "string",
  "username": "string",
  "password": "string",
  "sendRegistrationLink": true,
  "ccRegistrationLinkTo": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
customers	[CustomerReference]	false	none	none
displayName	string	false	none	none
username	string	false	none	none
password	string	false	none	none
sendRegistrationLink	boolean	false	none	none
ccRegistrationLinkTo	[string]	false	none	none

ChargeUnit

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeId": "string",
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "quantity": 0,
  "sell": 0
}

Properties

Name	Type	Required	Restrictions	Description
amount	number	false	none	none
amountPercentage	number	false	none	none
chargeId	string	false	none	none
cost	number	false	none	none
dateEnd	string(date-time)	false	none	none
dateStart	string(date-time)	false	none	none
id	string(uuid)	false	none	none
quantity	number	false	none	none
sell	number	false	none	none

ChargeType

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

ScopeType

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

Charge

{
  "amount": 0,
  "amountPercentage": 0,
  "chargeType": {
    "id": 0,
    "name": "string"
  },
  "cost": 0,
  "dateEnd": "2019-08-24T14:15:22Z",
  "dateStart": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "quantity": 0,
  "scopeType": {
    "id": 0,
    "name": "string"
  },
  "sell": 0
}

Properties

Name	Type	Required	Restrictions	Description
amount	number	false	none	none
amountPercentage	number	false	none	none
chargeType	ChargeType	false	none	none
cost	number	false	none	none
dateEnd	string(date-time)	false	none	none
dateStart	string(date-time)	false	none	none
description	string	false	none	none
id	string(uuid)	false	none	none
name	string	false	none	none
quantity	number	false	none	none
scopeType	ScopeType	false	none	none
sell	number	false	none	none

ProductTemplate

{
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "code": "string",
  "costCentre": "string",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "isAllowingProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productKit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
bundle	BundleReference	false	none	none
code	string	true	none	none
costCentre	string	false	none	none
description	string	false	none	none
isExcludingSurcharges	boolean	false	none	none
glCode	GLCodeReference	false	none	none
id	string(uuid)	false	none	none
label	string	false	none	none
isAllowingProRata	boolean	false	none	none
productCategory	ProductCategoryReference	false	none	none
supplier	SupplierReference	false	none	none
isTaxInclusive	boolean	false	none	none
inAdvance	InAdvanceReference	true	none	none
productKit	KitReference	false	none	none
charges	[Charge]	false	none	none

BundleReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

ExemptionCodeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

RegulatoryCodeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

UnitTypeCodeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

InAdvanceReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

GLCodeReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

ProductCategoryReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

TemplateProductReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

SupplierReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

TaxCodeReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

ServiceReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

ServiceItemReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

KitReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

Kit

{
  "id": "string",
  "name": "string",
  "description": "string",
  "cost": 0,
  "sell": 0,
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "proRata": true,
  "excludeSurcharges": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
cost	number	false	none	none
sell	number	false	none	none
inAdvance	InAdvanceReference	false	none	none
productCategory	ProductCategoryReference	false	none	none
proRata	boolean	false	none	none
excludeSurcharges	boolean	false	none	none

KitProduct

{
  "productId": "string",
  "productName": "string",
  "productLabel": "string",
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
productId	string	false	none	none
productName	string	false	none	none
productLabel	string	false	none	none
supplier	SupplierReference	false	none	none
productCategory	ProductCategoryReference	false	none	none
glCode	GLCodeReference	false	none	none
bundle	BundleReference	false	none	none
charges	[Charge]	false	none	none

Product

{
  "dateStart": "2019-08-24T14:15:22Z",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "bundle": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "label": "string",
  "costCentre": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateEnd": "2019-08-24T14:15:22Z",
  "description": "string",
  "isExcludingSurcharges": true,
  "glCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "inAdvance": {
    "id": 0,
    "name": "string"
  },
  "code": "string",
  "allowProRata": true,
  "productCategory": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "service": {
    "id": 0,
    "name": "string"
  },
  "serviceItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZ": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "siteZCustomer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "isTaxInclusive": true,
  "isHidden": true,
  "kit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "charges": [
    {
      "amount": 0,
      "amountPercentage": 0,
      "chargeType": {
        "id": 0,
        "name": "string"
      },
      "cost": 0,
      "dateEnd": "2019-08-24T14:15:22Z",
      "dateStart": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "quantity": 0,
      "scopeType": {
        "id": 0,
        "name": "string"
      },
      "sell": 0
    }
  ],
  "taxDetails": {
    "avalara": {
      "tsPair": {
        "code": "string",
        "description": "string"
      },
      "saleType": {
        "id": 0,
        "name": "string"
      }
    }
  },
  "rateCard": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "serviceItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ],
  "taxCode": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "extraField1": "string",
  "extraField2": "string",
  "extraField3": "string",
  "extraField4": "string",
  "extraField5": "string"
}

Properties

Name	Type	Required	Restrictions	Description
dateStart	string(date-time)	true	none	none
agreement	AgreementReference	true	none	none
bundle	BundleReference	false	none	none
label	string	true	none	none
costCentre	string	false	none	none
customer	CustomerReference	true	none	none
dateEnd	string(date-time)	false	none	none
description	string	false	none	none
isExcludingSurcharges	boolean	false	none	none
glCode	GLCodeReference	false	none	none
id	string(uuid)	false	none	none
inAdvance	InAdvanceReference	true	none	none
code	string	true	none	none
allowProRata	boolean	false	none	none
productCategory	ProductCategoryReference	false	none	none
service	ServiceReference	false	none	none
serviceItem	ServiceItemReference	false	none	none
site	SiteReference	false	none	none
siteZ	SiteReference	false	none	none
siteZCustomer	CustomerReference	false	none	none
supplier	SupplierReference	false	none	none
isTaxInclusive	boolean	false	none	none
isHidden	boolean	false	none	none
kit	KitReference	false	none	none
charges	[Charge]	false	none	none
taxDetails	ProductTaxDetails	false	none	none
rateCard	RateCardReference	false	none	none
serviceItems	[ServiceItemReference]	false	none	none
taxCode	TaxCodeReference	false	none	none
extraField1	string	false	none	none
extraField2	string	false	none	none
extraField3	string	false	none	none
extraField4	string	false	none	none
extraField5	string	false	none	none

AgreementPaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "name": "string",
      "billingContactEmail": "string",
      "billingContactFirstName": "string",
      "billingContactLastName": "string",
      "billingFrequencyType": "string",
      "billingStartDate": "2019-08-24T14:15:22Z",
      "billingStartDateLocked": true,
      "ccBillingContactEmail": "string",
      "currency": {
        "id": 0,
        "name": "string"
      },
      "dateStart": "2019-08-24T14:15:22Z",
      "dateEnd": "2019-08-24T14:15:22Z",
      "invoiceLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isDefault": true,
      "notes": "string",
      "paymentTerm": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "poNumber": "string",
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "organizationId": 0
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Agreement]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

ProductTemplatePaging

{
  "data": [
    {
      "bundle": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "code": "string",
      "costCentre": "string",
      "description": "string",
      "isExcludingSurcharges": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "isAllowingProRata": true,
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "supplier": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxInclusive": true,
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "productKit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "charges": [
        {
          "amount": 0,
          "amountPercentage": 0,
          "chargeType": {
            "id": 0,
            "name": "string"
          },
          "cost": 0,
          "dateEnd": "2019-08-24T14:15:22Z",
          "dateStart": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "quantity": 0,
          "scopeType": {
            "id": 0,
            "name": "string"
          },
          "sell": 0
        }
      ]
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[ProductTemplate]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

KitTemplatePaging

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "cost": 0,
      "sell": 0,
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "proRata": true,
      "excludeSurcharges": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Kit]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

ProductPaging

{
  "data": [
    {
      "dateStart": "2019-08-24T14:15:22Z",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "bundle": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "label": "string",
      "costCentre": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateEnd": "2019-08-24T14:15:22Z",
      "description": "string",
      "isExcludingSurcharges": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "inAdvance": {
        "id": 0,
        "name": "string"
      },
      "code": "string",
      "allowProRata": true,
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      },
      "serviceItem": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "siteZ": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "siteZCustomer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "supplier": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxInclusive": true,
      "isHidden": true,
      "kit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "charges": [
        {
          "amount": 0,
          "amountPercentage": 0,
          "chargeType": {
            "id": 0,
            "name": "string"
          },
          "cost": 0,
          "dateEnd": "2019-08-24T14:15:22Z",
          "dateStart": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "quantity": 0,
          "scopeType": {
            "id": 0,
            "name": "string"
          },
          "sell": 0
        }
      ],
      "taxDetails": {
        "avalara": {
          "tsPair": {
            "code": "string",
            "description": "string"
          },
          "saleType": {
            "id": 0,
            "name": "string"
          }
        }
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "serviceItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "taxCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Product]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

CustomersPaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalAccountingReference": "string",
      "accountManager": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isAllowResellerCharge": true,
      "address": {
        "postalAddress1": "string",
        "postalAddress2": "string",
        "city": "string",
        "postalCode": "string",
        "country": "string",
        "state": "string"
      },
      "bankAccount": "string",
      "emailInvoiceTo": "string",
      "invoiceAttentionOfLastName": "string",
      "invoiceAttentionOfName": "string",
      "contactPhone": "string",
      "businessUnit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "creditNoteLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "ccInvoiceTo": "string",
      "creditLimit": 0,
      "customerCode": "string",
      "deliveryMethod": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "doNotGenerateInvoices": true,
      "group": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "integrations": {
        "connectWise": {
          "identifier": "string"
        }
      },
      "invoiceLayout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "poNumber": "string",
      "isActive": true,
      "companyName": "string",
      "doNotGenerateTaxes": true,
      "paymentMethod": "string",
      "taxNumber": "string",
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isTaxesCalculationBasedOnSiteZipCode": true,
      "customFields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "caption": "string",
          "type": "string",
          "entryMethod": "string",
          "numberOfDecimals": 0,
          "value": "string"
        }
      ],
      "taxDetails": {
        "avalara": {
          "taxExemptions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string"
            }
          ]
        }
      },
      "canCharge": true,
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Customer]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

CustomerUsersPaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customers": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "displayName": "string",
      "username": "string",
      "dateCreated": "2019-08-24T14:15:22Z",
      "active": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[CustomerUserGet]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

ServiceItemPaging

{
  "data": [
    {
      "dateStart": "string",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "aliases": [
        "string"
      ],
      "serviceItem": "string",
      "costCentre": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateEnd": "string",
      "description": "string",
      "id": "string",
      "internalNotes": "string",
      "isActive": true,
      "serviceItemType": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      },
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[ServiceItem]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

SitePaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "address": {
        "postalAddress1": "string",
        "postalAddress2": "string",
        "city": "string",
        "postalCode": "string",
        "country": "string",
        "state": "string",
        "contactPhone": "string"
      },
      "referenceCode": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "externalReference": "string",
      "isHidingTaxes": true,
      "code": "string",
      "extraField1": "string",
      "extraField2": "string",
      "extraField3": "string",
      "extraField4": "string",
      "extraField5": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Site]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

RatingAssignmentsPaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isDefault": true,
      "startDate": "2019-08-24T14:15:22Z",
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "rateCard": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "serviceItem": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "service": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[RatingAssignments]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

RatePaging

{
  "data": [
    {
      "destinationDescription": "string",
      "durationRounding": "string",
      "flagFall": 0,
      "freeUnits": 0,
      "id": "string",
      "isDefault": true,
      "prefix": "string",
      "ratingAmount": 0,
      "ratingAmountCost": 0,
      "rating": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "recordType": {
        "id": 0,
        "name": "string"
      },
      "supplierCallTypeCode": "string",
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Rate]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

RateCardPaging

{
  "data": [
    {
      "description": "string",
      "id": "string",
      "isDefault": true,
      "name": "string",
      "service": {
        "id": 0,
        "name": "string"
      },
      "type": {
        "id": 0,
        "name": "string"
      },
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[RateCard]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

PriceBookProductPaging

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "label": "string",
      "costAmount": 0,
      "ratingType": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "ratingAmount": 0,
      "taxRate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "allowProRata": true,
      "glCode": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "productCategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "templateProduct": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "isHidden": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[PriceBookProduct]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

InvoicesPaging

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "agreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "amount": 0,
      "amountDue": 0,
      "amountPaid": 0,
      "billingPeriod": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "creditNoteId": "string",
      "customer": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "dateDue": "2019-08-24T14:15:22Z",
      "dateGenerated": "2019-08-24T14:15:22Z",
      "deliveryMethod": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "invoiceTypeId": 0,
      "isCreditNote": true,
      "periodEnd": "2019-08-24T14:15:22Z",
      "periodStart": "2019-08-24T14:15:22Z",
      "status": {
        "id": 0,
        "name": "string"
      },
      "subTotal": 0,
      "taxAmount": 0,
      "organisationId": 0
    }
  ],
  "page": 0,
  "pageSize": 0,
  "pages": 0,
  "records": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	[Invoice]	false	none	none
page	integer	false	none	none
pageSize	integer	false	none	none
pages	integer	false	none	none
records	integer	false	none	none

CustomField

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "caption": "string",
  "type": "string",
  "entryMethod": "string",
  "numberOfDecimals": 0,
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
caption	string	false	none	none
type	string	false	none	none
entryMethod	string	false	none	none
numberOfDecimals	integer	false	none	none
value	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

AvalaraTaxExemptionReference

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
name	string	false	none	none

AvalaraCustomerTaxDetails

{
  "taxExemptions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
taxExemptions	[AvalaraTaxExemptionReference]	false	none	none

AvalaraTSPairReference

{
  "code": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
description	string	false	none	none

AvalaraSaleTypeReference

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

AvalaraProductTaxDetails

{
  "tsPair": {
    "code": "string",
    "description": "string"
  },
  "saleType": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
tsPair	AvalaraTSPairReference	false	none	none
saleType	AvalaraSaleTypeReference	false	none	none

CustomerTaxDetails

{
  "avalara": {
    "taxExemptions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
avalara	AvalaraCustomerTaxDetails	false	none	none

ProductTaxDetails

{
  "avalara": {
    "tsPair": {
      "code": "string",
      "description": "string"
    },
    "saleType": {
      "id": 0,
      "name": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
avalara	AvalaraProductTaxDetails	false	none	none

Invoice

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "agreement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "amount": 0,
  "amountDue": 0,
  "amountPaid": 0,
  "billingPeriod": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "creditNoteId": "string",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "dateDue": "2019-08-24T14:15:22Z",
  "dateGenerated": "2019-08-24T14:15:22Z",
  "deliveryMethod": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "invoiceTypeId": 0,
  "isCreditNote": true,
  "periodEnd": "2019-08-24T14:15:22Z",
  "periodStart": "2019-08-24T14:15:22Z",
  "status": {
    "id": 0,
    "name": "string"
  },
  "subTotal": 0,
  "taxAmount": 0,
  "organisationId": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
agreement	AgreementReference	false	none	none
amount	number	false	none	none
amountDue	number	false	none	none
amountPaid	number	false	none	none
billingPeriod	BillingPeriodReference	false	none	none
creditNoteId	string	false	none	none
customer	CustomerReference	false	none	none
dateDue	string(date-time)	false	none	none
dateGenerated	string(date-time)	false	none	none
deliveryMethod	string	false	none	none
invoiceDate	string(date-time)	false	none	none
invoiceNumber	string	false	none	none
invoiceTypeId	integer	false	none	none
isCreditNote	boolean	false	none	none
periodEnd	string(date-time)	false	none	none
periodStart	string(date-time)	false	none	none
status	InvoiceStatusReference	false	none	none
subTotal	number	false	none	none
taxAmount	number	false	none	none
organisationId	number	false	none	none

InvoiceSearch

{
  "$and": [
    {
      "CustomerId": "2900207f-61b9-4f8a-8f20-e24baf689d3d",
      "InvoiceDate": "2019-08-24T14:15:22Z",
      "BillingPeriodId": "f090d09e-f275-4c9e-93b6-da9c1de68f10"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
$and	[object]	false	none	none
» CustomerId	string(uuid)	false	none	none
» InvoiceDate	string(date-time)	false	none	none
» BillingPeriodId	string(uuid)	false	none	none

InvoiceDetails

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "invoiceNumber": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "transactions": [
    {
      "id": "string",
      "productCode": "string",
      "productLabel": "string",
      "quantity": 0.1,
      "amount": 0.1,
      "tax": 0.1,
      "total": 0.1,
      "isHidden": true,
      "dateStart": "2019-08-24T14:15:22Z",
      "dateEnd": "2019-08-24T14:15:22Z"
    }
  ],
  "usage": [
    {
      "id": "string",
      "serviceItem": "string",
      "serviceItemDescription": "string",
      "service": "string",
      "recordType": "string",
      "quantity": 0.1,
      "amount": 0.1,
      "tax": 0.1,
      "total": 0.1
    }
  ],
  "surcharges": [
    {
      "id": "string",
      "name": "string",
      "amount": 0.1
    }
  ],
  "taxes": [
    {
      "name": "string",
      "value": 0.1,
      "isTaxInclusive": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
invoiceNumber	string	false	none	none
invoiceDate	string(date-time)	false	none	none
transactions	[InvoiceDetailsTransaction]	false	none	none
usage	[InvoiceDetailsUsage]	false	none	none
surcharges	[InvoiceDetailsSurcharge]	false	none	none
taxes	[InvoiceDetailsTax]	false	none	none

InvoiceDetailsTransaction

{
  "id": "string",
  "productCode": "string",
  "productLabel": "string",
  "quantity": 0.1,
  "amount": 0.1,
  "tax": 0.1,
  "total": 0.1,
  "isHidden": true,
  "dateStart": "2019-08-24T14:15:22Z",
  "dateEnd": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
productCode	string	false	none	none
productLabel	string	false	none	none
quantity	number(float)	false	none	none
amount	number(float)	false	none	none
tax	number(float)	false	none	none
total	number(float)	false	none	none
isHidden	boolean	false	none	none
dateStart	string(date-time)	false	none	none
dateEnd	string(date-time)	false	none	none

InvoiceDetailsUsage

{
  "id": "string",
  "serviceItem": "string",
  "serviceItemDescription": "string",
  "service": "string",
  "recordType": "string",
  "quantity": 0.1,
  "amount": 0.1,
  "tax": 0.1,
  "total": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
serviceItem	string	false	none	none
serviceItemDescription	string	false	none	none
service	string	false	none	none
recordType	string	false	none	none
quantity	number(float)	false	none	none
amount	number(float)	false	none	none
tax	number(float)	false	none	none
total	number(float)	false	none	none

InvoiceDetailsSurcharge

{
  "id": "string",
  "name": "string",
  "amount": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
amount	number(float)	false	none	none

InvoiceDetailsTax

{
  "name": "string",
  "value": 0.1,
  "isTaxInclusive": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
value	number(float)	false	none	none
isTaxInclusive	boolean	false	none	none

undefined