POSitive Anywhere
Web Service Documentation
Service: api
Method: transaction_invoice_list
Returns invoice headers
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Group: request
block
(long integer)
blocksize
(long integer)
divisionid
(long integer)
localtransactionid
(string[60])
transactionid
(string[60])
transactionnumber
(long integer)
localcustomerid
(string[60])
customerid
(long integer)
startdatetime
(string[30])
endtime
(string[30])
This parameter is Optional
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])
total_records
(long integer)
total_blocks
(long integer)
blocksize
(long integer)
block_returned
(long integer)
returned_records
(long integer)
List: transactions
localtransactionid
(string[60])
transactionid
(string[60])
transactionnumber
(long integer)
divisionid
(long integer)
divisionname
(string[60])
type
(string[60])
localcustomerid
(string[60])
customerid
(long integer)
localshippingaddressid
(string[60])
shippingaddressid
(string[60])
created_at
(string[20])
purchaseordernumber
(string[60])
taxamount
(string[20])
total
(string[60])
originalpendingtransactionID
(string[16])
originalpendinglocaltransactionid
(string[60])
originalpendingtransactionnumber
(long integer)
JSON POST (JSON Response)
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
jsondata
result
Example Request
POST /transaction_invoice_list HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"block" : value,
"blocksize" : value,
"divisionid" : value,
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : value,
"localcustomerid" : "value",
"customerid" : value,
"startdatetime" : "value",
"endtime" : "value"
}
}
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"block" : value,
"blocksize" : value,
"divisionid" : value,
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : value,
"localcustomerid" : "value",
"customerid" : value,
"startdatetime" : "value",
"endtime" : "value"
}
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Example Code - JavaScript
function transaction_invoice_list_jsonpost(host,jsondata,username,password,result){
fetch(host + "/transaction_invoice_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"
fetch(host + "/transaction_invoice_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/transaction_invoice_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/transaction_invoice_list',jsonData)
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/transaction_invoice_list',jsonData)
Try It - Live
User Name
Password
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.
result
Example Request
GET /transaction_invoice_list?request-block=value&request-blocksize=value&request-divisionid=value&request-localtransactionid=value&request-transactionid=value&request-transactionnumber=value&request-localcustomerid=value&request-customerid=value&request-startdatetime=value&request-endtime=value HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Example Code - JavaScript
function transaction_invoice_list_getjson(host,urldata,username,password,result){
fetch(host + "/transaction_invoice_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"
fetch(host + "/transaction_invoice_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" --get --data "request-block=value&request-blocksize=value&request-divisionid=value&request-localtransactionid=value&request-transactionid=value&request-transactionnumber=value&request-localcustomerid=value&request-customerid=value&request-startdatetime=value&request-endtime=value" https://localhost:2293/transaction_invoice_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/transaction_invoice_list?request-block=value&request-blocksize=value&request-divisionid=value&request-localtransactionid=value&request-transactionid=value&request-transactionnumber=value&request-localcustomerid=value&request-customerid=value&request-startdatetime=value&request-endtime=value')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/transaction_invoice_list?request-block=value&request-blocksize=value&request-divisionid=value&request-localtransactionid=value&request-transactionid=value&request-transactionnumber=value&request-localcustomerid=value&request-customerid=value&request-startdatetime=value&request-endtime=value')
Try It - Live
User Name
Password
request-block
request-blocksize
request-divisionid
request-localtransactionid
request-transactionid
request-transactionnumber
request-localcustomerid
request-customerid
request-startdatetime
request-endtime
result
REST GET (JSON Response)
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
GET /api/transaction_invoice_list? HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"transaction_invoice_list_response" : {
"result" : {
"status" : "value",
"total_records" : value,
"total_blocks" : value,
"blocksize" : value,
"block_returned" : value,
"returned_records" : value
},
"transactions" : [
{
"localtransactionid" : "value",
"transactionid" : "value",
"transactionnumber" : "value",
"divisionid" : "value",
"divisionname" : "value",
"type" : "value",
"localcustomerid" : "value",
"customerid" : "value",
"localshippingaddressid" : "value",
"shippingaddressid" : "value",
"created_at" : "value",
"purchaseordernumber" : "value",
"taxamount" : "value",
"total" : "value",
"originalpendingtransactionID" : "value",
"originalpendinglocaltransactionid" : "value",
"originalpendingtransactionnumber" : "value"
}
]
}
}
Example Code - JavaScript
function transaction_invoice_list_restjson(host,id,username,password,result){
fetch(host + "/api/transaction_invoice_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"
fetch(host + "/api/transaction_invoice_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/transaction_invoice_list/5
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/api/transaction_invoice_list/5')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/transaction_invoice_list/5')
Try It - Live
User Name
Password
id
result
Copyright 2024 POSitive Software Company All Rights Reserved