POSitive Anywhere

Web Service Documentation

Service: api

Method: tax_customer_group_list

Customer Tax Group definitions. Each Customer is assigned to a tax group. Each tax group has individually defined Product Category tax groups and rates.

You must be logged in to use this method.
Basic Authentication is supported.

Parameters

Possible Return Data

List: ErrorQueue

ErrorNumber

(long integer)

ErrorPosition

(string[255])

ErrorRecordId

(string[255])

ErrorDescription

(string[255])

ErrorRecommendation

(string[255])

Group: result

status

(string[5000])

List: customer_group

groupid

(long integer)

description

(string[30])

JSON POST (JSON Response)

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Example Request

POST /tax_customer_group_list HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length

{}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "customer_udf_response" : {
    "result" : {
      "status" : "value"
    },
    "customer_group" : [
      {
        "groupid" : "value",
        "description" : "value"
      }
    ]
  }
}

Example Code - JavaScript

function tax_customer_group_list_jsonpost(host,jsondata,username,password,result){
  fetch(host + "/tax_customer_group_list", {
    method: "POST",
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Content-Type": "application/json",
      "Accept": "application/json;",
    },
    body: jsondata
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
    textToTextarea(text,result)  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @jsonDataFile.json https://localhost:2293/tax_customer_group_list

Example Code - Clarion with NetTalk

net NetWebClient

  net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
  net.ContentType = 'application/json'
  net.SetAccept('application/json')
  net.Post('https://localhost:2293/tax_customer_group_list',jsonData)

Try It - Live

User Name

Password

jsondata

result

HTTP GET (JSON Response)

The following is a sample JSON GET request and response. The placeholders shown need to be replaced with actual values.

Example Request

GET /tax_customer_group_list HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json

Example Response

Example Code - JavaScript

function tax_customer_group_list_getjson(host,urldata,username,password,result){
  fetch(host + "/tax_customer_group_list" +"?" + urldata, {
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Accept": "application/json;",
    }
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Accept: application/json" https://localhost:2293/tax_customer_group_list

Example Code - Clarion with NetTalk

net NetWebClient

  net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
  net.SetAccept('application/json')
  net.Get('https://localhost:2293/tax_customer_group_list')

Try It - Live

User Name

Password

result

REST GET (JSON Response)

The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.

Example Request

GET /api/tax_customer_group_list? HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json

Example Response

Example Code - JavaScript

function tax_customer_group_list_restjson(host,id,username,password,result){
  fetch(host + "/api/tax_customer_group_list/" + id, {
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Accept": "application/json;",
    }
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Accept: application/json" https://localhost:2293/api/tax_customer_group_list/5

Example Code - Clarion with NetTalk

Try It - Live

User Name

Password

result