API Docs - How it works

GETOperations

addresslistGet

Returns address information.

The AddressList request returns information about the specified address.


/addresslist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/addresslist?AddressID=&AddressListID=&CardRecordID=&ContactName=&Location=&City=&Country=&Email=&Fax=&Phone1=&Phone2=&Phone3=&postcode=&street=&streetline1=&streetline2=&streetline3="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer addressID = 56; // Integer | the primary key value of the address record.
        Integer addressListID = 56; // Integer | The primary key value of the address list record.
        Integer cardRecordID = 56; // Integer | The primary key value of the card record.
        String contactName = contactName_example; // String | The name on the contact card
        String location = location_example; // String | The location details of the address record.
        String city = city_example; // String | The city or ship to city of a customer card.
        String country = country_example; // String | Country of the location address.
        String email = email_example; // String | Email address of a card record.
        String fax = fax_example; // String | The fax number of a card record.
        String phone1 = phone1_example; // String | Phone number 1 of a card record.
        String phone2 = phone2_example; // String | Phone number 2 of a card record.
        String phone3 = phone3_example; // String | Phone number 3 of a card record.
        String postcode = postcode_example; // String | State of a card record.
        String street = street_example; // String | Full contents of the ship to address field.
        String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
        String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
        String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
        try {
            addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#addresslistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer addressID = 56; // Integer | the primary key value of the address record.
        Integer addressListID = 56; // Integer | The primary key value of the address list record.
        Integer cardRecordID = 56; // Integer | The primary key value of the card record.
        String contactName = contactName_example; // String | The name on the contact card
        String location = location_example; // String | The location details of the address record.
        String city = city_example; // String | The city or ship to city of a customer card.
        String country = country_example; // String | Country of the location address.
        String email = email_example; // String | Email address of a card record.
        String fax = fax_example; // String | The fax number of a card record.
        String phone1 = phone1_example; // String | Phone number 1 of a card record.
        String phone2 = phone2_example; // String | Phone number 2 of a card record.
        String phone3 = phone3_example; // String | Phone number 3 of a card record.
        String postcode = postcode_example; // String | State of a card record.
        String street = street_example; // String | Full contents of the ship to address field.
        String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
        String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
        String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
        try {
            addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#addresslistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *addressID = 56; // the primary key value of the address record. (optional)
Integer *addressListID = 56; // The primary key value of the address list record. (optional)
Integer *cardRecordID = 56; // The primary key value of the card record. (optional)
String *contactName = contactName_example; // The name on the contact card (optional)
String *location = location_example; // The location details of the address record. (optional)
String *city = city_example; // The city or ship to city of a customer card. (optional)
String *country = country_example; // Country of the location address. (optional)
String *email = email_example; // Email address of a card record. (optional)
String *fax = fax_example; // The fax number of a card record. (optional)
String *phone1 = phone1_example; // Phone number 1 of a card record. (optional)
String *phone2 = phone2_example; // Phone number 2 of a card record. (optional)
String *phone3 = phone3_example; // Phone number 3 of a card record. (optional)
String *postcode = postcode_example; // State of a card record. (optional)
String *street = street_example; // Full contents of the ship to address field. (optional)
String *streetline1 = streetline1_example; // First line of cards Address or Ship To address. (optional)
String *streetline2 = streetline2_example; // Second line of cards Address or Ship To address. (optional)
String *streetline3 = streetline3_example; // Third line of cards Address or Ship To address. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns address information.
[apiInstance addresslistGetWith:addressID
    addressListID:addressListID
    cardRecordID:cardRecordID
    contactName:contactName
    location:location
    city:city
    country:country
    email:email
    fax:fax
    phone1:phone1
    phone2:phone2
    phone3:phone3
    postcode:postcode
    street:street
    streetline1:streetline1
    streetline2:streetline2
    streetline3:streetline3
              completionHandler: ^(addresslist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'addressID': 56, // {{Integer}} the primary key value of the address record.
  'addressListID': 56, // {{Integer}} The primary key value of the address list record.
  'cardRecordID': 56, // {{Integer}} The primary key value of the card record.
  'contactName': contactName_example, // {{String}} The name on the contact card
  'location': location_example, // {{String}} The location details of the address record.
  'city': city_example, // {{String}} The city or ship to city of a customer card.
  'country': country_example, // {{String}} Country of the location address.
  'email': email_example, // {{String}} Email address of a card record.
  'fax': fax_example, // {{String}} The fax number of a card record.
  'phone1': phone1_example, // {{String}} Phone number 1 of a card record.
  'phone2': phone2_example, // {{String}} Phone number 2 of a card record.
  'phone3': phone3_example, // {{String}} Phone number 3 of a card record.
  'postcode': postcode_example, // {{String}} State of a card record.
  'street': street_example, // {{String}} Full contents of the ship to address field.
  'streetline1': streetline1_example, // {{String}} First line of cards Address or Ship To address.
  'streetline2': streetline2_example, // {{String}} Second line of cards Address or Ship To address.
  'streetline3': streetline3_example // {{String}} Third line of cards Address or Ship To address.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addresslistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addresslistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var addressID = 56;  // Integer | the primary key value of the address record. (optional) 
            var addressListID = 56;  // Integer | The primary key value of the address list record. (optional) 
            var cardRecordID = 56;  // Integer | The primary key value of the card record. (optional) 
            var contactName = contactName_example;  // String | The name on the contact card (optional) 
            var location = location_example;  // String | The location details of the address record. (optional) 
            var city = city_example;  // String | The city or ship to city of a customer card. (optional) 
            var country = country_example;  // String | Country of the location address. (optional) 
            var email = email_example;  // String | Email address of a card record. (optional) 
            var fax = fax_example;  // String | The fax number of a card record. (optional) 
            var phone1 = phone1_example;  // String | Phone number 1 of a card record. (optional) 
            var phone2 = phone2_example;  // String | Phone number 2 of a card record. (optional) 
            var phone3 = phone3_example;  // String | Phone number 3 of a card record. (optional) 
            var postcode = postcode_example;  // String | State of a card record. (optional) 
            var street = street_example;  // String | Full contents of the ship to address field. (optional) 
            var streetline1 = streetline1_example;  // String | First line of cards Address or Ship To address. (optional) 
            var streetline2 = streetline2_example;  // String | Second line of cards Address or Ship To address. (optional) 
            var streetline3 = streetline3_example;  // String | Third line of cards Address or Ship To address. (optional) 

            try
            {
                // Returns address information.
                addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.addresslistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$addressID = 56; // Integer | the primary key value of the address record.
$addressListID = 56; // Integer | The primary key value of the address list record.
$cardRecordID = 56; // Integer | The primary key value of the card record.
$contactName = contactName_example; // String | The name on the contact card
$location = location_example; // String | The location details of the address record.
$city = city_example; // String | The city or ship to city of a customer card.
$country = country_example; // String | Country of the location address.
$email = email_example; // String | Email address of a card record.
$fax = fax_example; // String | The fax number of a card record.
$phone1 = phone1_example; // String | Phone number 1 of a card record.
$phone2 = phone2_example; // String | Phone number 2 of a card record.
$phone3 = phone3_example; // String | Phone number 3 of a card record.
$postcode = postcode_example; // String | State of a card record.
$street = street_example; // String | Full contents of the ship to address field.
$streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
$streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
$streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.

try {
    $result = $api_instance->addresslistGet($addressID, $addressListID, $cardRecordID, $contactName, $location, $city, $country, $email, $fax, $phone1, $phone2, $phone3, $postcode, $street, $streetline1, $streetline2, $streetline3);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->addresslistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $addressID = 56; # Integer | the primary key value of the address record.
my $addressListID = 56; # Integer | The primary key value of the address list record.
my $cardRecordID = 56; # Integer | The primary key value of the card record.
my $contactName = contactName_example; # String | The name on the contact card
my $location = location_example; # String | The location details of the address record.
my $city = city_example; # String | The city or ship to city of a customer card.
my $country = country_example; # String | Country of the location address.
my $email = email_example; # String | Email address of a card record.
my $fax = fax_example; # String | The fax number of a card record.
my $phone1 = phone1_example; # String | Phone number 1 of a card record.
my $phone2 = phone2_example; # String | Phone number 2 of a card record.
my $phone3 = phone3_example; # String | Phone number 3 of a card record.
my $postcode = postcode_example; # String | State of a card record.
my $street = street_example; # String | Full contents of the ship to address field.
my $streetline1 = streetline1_example; # String | First line of cards Address or Ship To address.
my $streetline2 = streetline2_example; # String | Second line of cards Address or Ship To address.
my $streetline3 = streetline3_example; # String | Third line of cards Address or Ship To address.

eval { 
    my $result = $api_instance->addresslistGet(addressID => $addressID, addressListID => $addressListID, cardRecordID => $cardRecordID, contactName => $contactName, location => $location, city => $city, country => $country, email => $email, fax => $fax, phone1 => $phone1, phone2 => $phone2, phone3 => $phone3, postcode => $postcode, street => $street, streetline1 => $streetline1, streetline2 => $streetline2, streetline3 => $streetline3);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->addresslistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
addressID = 56 # Integer | the primary key value of the address record. (optional)
addressListID = 56 # Integer | The primary key value of the address list record. (optional)
cardRecordID = 56 # Integer | The primary key value of the card record. (optional)
contactName = contactName_example # String | The name on the contact card (optional)
location = location_example # String | The location details of the address record. (optional)
city = city_example # String | The city or ship to city of a customer card. (optional)
country = country_example # String | Country of the location address. (optional)
email = email_example # String | Email address of a card record. (optional)
fax = fax_example # String | The fax number of a card record. (optional)
phone1 = phone1_example # String | Phone number 1 of a card record. (optional)
phone2 = phone2_example # String | Phone number 2 of a card record. (optional)
phone3 = phone3_example # String | Phone number 3 of a card record. (optional)
postcode = postcode_example # String | State of a card record. (optional)
street = street_example # String | Full contents of the ship to address field. (optional)
streetline1 = streetline1_example # String | First line of cards Address or Ship To address. (optional)
streetline2 = streetline2_example # String | Second line of cards Address or Ship To address. (optional)
streetline3 = streetline3_example # String | Third line of cards Address or Ship To address. (optional)

try: 
    # Returns address information.
    api_response = api_instance.addresslist_get(addressID=addressID, addressListID=addressListID, cardRecordID=cardRecordID, contactName=contactName, location=location, city=city, country=country, email=email, fax=fax, phone1=phone1, phone2=phone2, phone3=phone3, postcode=postcode, street=street, streetline1=streetline1, streetline2=streetline2, streetline3=streetline3)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->addresslistGet: %s\n" % e)

Parameters

Query parameters
Name Description
AddressID
Integer
the primary key value of the address record.
AddressListID
Integer
The primary key value of the address list record.
CardRecordID
Integer
The primary key value of the card record.
ContactName
String
The name on the contact card
Location
String
The location details of the address record.
City
String
The city or ship to city of a customer card.
Country
String
Country of the location address.
Email
String
Email address of a card record.
Fax
String
The fax number of a card record.
Phone1
String
Phone number 1 of a card record.
Phone2
String
Phone number 2 of a card record.
Phone3
String
Phone number 3 of a card record.
postcode
String
State of a card record.
street
String
Full contents of the ship to address field.
streetline1
String
First line of cards Address or Ship To address.
streetline2
String
Second line of cards Address or Ship To address.
streetline3
String
Third line of cards Address or Ship To address.

Responses

Status: 200 - OK


attachmentsAttachmentGet

Returns attachment.

Returns information about the specified attachment.


/attachments/attachment

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/attachments/attachment?BaseStockID=&filename="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String filename = filename_example; // String | a valid filename
        try {
            byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#attachmentsAttachmentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String filename = filename_example; // String | a valid filename
        try {
            byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#attachmentsAttachmentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *filename = filename_example; // a valid filename (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns attachment.
[apiInstance attachmentsAttachmentGetWith:baseStockID
    filename:filename
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'filename': filename_example // {{String}} a valid filename
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.attachmentsAttachmentGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class attachmentsAttachmentGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var filename = filename_example;  // String | a valid filename (optional) 

            try
            {
                // Returns attachment.
                byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.attachmentsAttachmentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$filename = filename_example; // String | a valid filename

try {
    $result = $api_instance->attachmentsAttachmentGet($baseStockID, $filename);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->attachmentsAttachmentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $filename = filename_example; # String | a valid filename

eval { 
    my $result = $api_instance->attachmentsAttachmentGet(baseStockID => $baseStockID, filename => $filename);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->attachmentsAttachmentGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
filename = filename_example # String | a valid filename (optional)

try: 
    # Returns attachment.
    api_response = api_instance.attachments_attachment_get(baseStockID=baseStockID, filename=filename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->attachmentsAttachmentGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
filename
String
a valid filename

Responses

Status: 200 - get the attached image


barcodelistGet

Returns information about the specified barcode

The barcodelist request returns information about the specified barcode.


/barcodelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/barcodelist?ItemNumber=&Barcode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer barcode = 56; // Integer | Pass query by barcode.
        try {
            barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#barcodelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer barcode = 56; // Integer | Pass query by barcode.
        try {
            barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#barcodelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *barcode = 56; // Pass query by barcode. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified barcode
[apiInstance barcodelistGetWith:itemNumber
    barcode:barcode
              completionHandler: ^(barcodeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'barcode': 56 // {{Integer}} Pass query by barcode.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class barcodelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var barcode = 56;  // Integer | Pass query by barcode. (optional) 

            try
            {
                // Returns information about the specified barcode
                barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.barcodelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$itemNumber = itemNumber_example; // String | Pass by an item number.
$barcode = 56; // Integer | Pass query by barcode.

try {
    $result = $api_instance->barcodelistGet($itemNumber, $barcode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->barcodelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $barcode = 56; # Integer | Pass query by barcode.

eval { 
    my $result = $api_instance->barcodelistGet(itemNumber => $itemNumber, barcode => $barcode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->barcodelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
barcode = 56 # Integer | Pass query by barcode. (optional)

try: 
    # Returns information about the specified barcode
    api_response = api_instance.barcodelist_get(itemNumber=itemNumber, barcode=barcode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->barcodelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
ItemNumber
String
Pass by an item number.
Barcode
Integer
Pass query by barcode.

Responses

Status: 200 - OK


billofmaterialsGet

Returns information about the specified bill of materials.

The billofmaterials request returns information about the specified bill of materials.


/billofmaterials

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/billofmaterials?BaseStockID=&BaseStockLineID=&ItemNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.
        Integer baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
        String itemNumber = itemNumber_example; // String | The item number.
        try {
            array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#billofmaterialsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.
        Integer baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
        String itemNumber = itemNumber_example; // String | The item number.
        try {
            array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#billofmaterialsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // The primary key of the item master record. (optional)
Integer *baseStockLineID = 56; // The primary key of the item master record for a stock line item. (optional)
String *itemNumber = itemNumber_example; // The item number. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified bill of materials.
[apiInstance billofmaterialsGetWith:baseStockID
    baseStockLineID:baseStockLineID
    itemNumber:itemNumber
              completionHandler: ^(array[billofmaterials] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} The primary key of the item master record.
  'baseStockLineID': 56, // {{Integer}} The primary key of the item master record for a stock line item.
  'itemNumber': itemNumber_example // {{String}} The item number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.billofmaterialsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class billofmaterialsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | The primary key of the item master record. (optional) 
            var baseStockLineID = 56;  // Integer | The primary key of the item master record for a stock line item. (optional) 
            var itemNumber = itemNumber_example;  // String | The item number. (optional) 

            try
            {
                // Returns information about the specified bill of materials.
                array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.billofmaterialsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | The primary key of the item master record.
$baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
$itemNumber = itemNumber_example; // String | The item number.

try {
    $result = $api_instance->billofmaterialsGet($baseStockID, $baseStockLineID, $itemNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->billofmaterialsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | The primary key of the item master record.
my $baseStockLineID = 56; # Integer | The primary key of the item master record for a stock line item.
my $itemNumber = itemNumber_example; # String | The item number.

eval { 
    my $result = $api_instance->billofmaterialsGet(baseStockID => $baseStockID, baseStockLineID => $baseStockLineID, itemNumber => $itemNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->billofmaterialsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | The primary key of the item master record. (optional)
baseStockLineID = 56 # Integer | The primary key of the item master record for a stock line item. (optional)
itemNumber = itemNumber_example # String | The item number. (optional)

try: 
    # Returns information about the specified bill of materials.
    api_response = api_instance.billofmaterials_get(baseStockID=baseStockID, baseStockLineID=baseStockLineID, itemNumber=itemNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->billofmaterialsGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
The primary key of the item master record.
BaseStockLineID
Integer
The primary key of the item master record for a stock line item.
ItemNumber
String
The item number.

Responses

Status: 200 - OK


binlistGet

Returns binlist information.

The binlist request returns information about the specified bin.


/binlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/binlist?bBin=&BinID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String bBin = bBin_example; // String | The assigned bin name.
        Integer binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.
        try {
            binlist result = apiInstance.binlistGet(bBin, binID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#binlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String bBin = bBin_example; // String | The assigned bin name.
        Integer binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.
        try {
            binlist result = apiInstance.binlistGet(bBin, binID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#binlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *bBin = bBin_example; // The assigned bin name. (optional)
Integer *binID = 56; // A valid value is the valid BinID, that you used for the REST call. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns binlist information.
[apiInstance binlistGetWith:bBin
    binID:binID
              completionHandler: ^(binlist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'bBin': bBin_example, // {{String}} The assigned bin name.
  'binID': 56 // {{Integer}} A valid value is the valid BinID, that you used for the REST call.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.binlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class binlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var bBin = bBin_example;  // String | The assigned bin name. (optional) 
            var binID = 56;  // Integer | A valid value is the valid BinID, that you used for the REST call. (optional) 

            try
            {
                // Returns binlist information.
                binlist result = apiInstance.binlistGet(bBin, binID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.binlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$bBin = bBin_example; // String | The assigned bin name.
$binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.

try {
    $result = $api_instance->binlistGet($bBin, $binID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->binlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $bBin = bBin_example; # String | The assigned bin name.
my $binID = 56; # Integer | A valid value is the valid BinID, that you used for the REST call.

eval { 
    my $result = $api_instance->binlistGet(bBin => $bBin, binID => $binID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->binlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
bBin = bBin_example # String | The assigned bin name. (optional)
binID = 56 # Integer | A valid value is the valid BinID, that you used for the REST call. (optional)

try: 
    # Returns binlist information.
    api_response = api_instance.binlist_get(bBin=bBin, binID=binID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->binlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
bBin
String
The assigned bin name.
BinID
Integer
A valid value is the valid BinID, that you used for the REST call.

Responses

Status: 200 - OK


contactlistGet

Returns a list of contact information

The contactlist request returns a list of contact records.


/contactlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/contactlist?LinkCardRecordID=&CardsTypeID=&CreateDate=&FirstName=&LastName=&Name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *linkCardRecordID = 56; // The card ID number of the record within the Card table containing contact details. (optional)
String *cardsTypeID = cardsTypeID_example; // CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
String *createDate = createDate_example; // The creation date of the contact record. (optional)
String *firstName = firstName_example; // Blank if the card record represents a company, otherwise the first name of the individual. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the individual's last name. (optional)
String *name = name_example; // If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns a list of contact information
[apiInstance contactlistGetWith:linkCardRecordID
    cardsTypeID:cardsTypeID
    createDate:createDate
    firstName:firstName
    lastName:lastName
    name:name
              completionHandler: ^(contactslist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'linkCardRecordID': 56, // {{Integer}} The card ID number of the record within the Card table containing contact details.
  'cardsTypeID': cardsTypeID_example, // {{String}} CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
  'createDate': createDate_example, // {{String}} The creation date of the contact record.
  'firstName': firstName_example, // {{String}} Blank if the card record represents a company, otherwise the first name of the individual.
  'lastName': lastName_example, // {{String}} The company name if the card record represents a company, otherwise the individual's last name.
  'name': name_example // {{String}} If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var linkCardRecordID = 56;  // Integer | The card ID number of the record within the Card table containing contact details. (optional) 
            var cardsTypeID = cardsTypeID_example;  // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional) 
            var createDate = createDate_example;  // String | The creation date of the contact record. (optional) 
            var firstName = firstName_example;  // String | Blank if the card record represents a company, otherwise the first name of the individual. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the individual's last name. (optional) 
            var name = name_example;  // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional) 

            try
            {
                // Returns a list of contact information
                contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.contactlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
$cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
$createDate = createDate_example; // String | The creation date of the contact record.
$firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
$name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

try {
    $result = $api_instance->contactlistGet($linkCardRecordID, $cardsTypeID, $createDate, $firstName, $lastName, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->contactlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $linkCardRecordID = 56; # Integer | The card ID number of the record within the Card table containing contact details.
my $cardsTypeID = cardsTypeID_example; # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
my $createDate = createDate_example; # String | The creation date of the contact record.
my $firstName = firstName_example; # String | Blank if the card record represents a company, otherwise the first name of the individual.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the individual's last name.
my $name = name_example; # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

eval { 
    my $result = $api_instance->contactlistGet(linkCardRecordID => $linkCardRecordID, cardsTypeID => $cardsTypeID, createDate => $createDate, firstName => $firstName, lastName => $lastName, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->contactlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
linkCardRecordID = 56 # Integer | The card ID number of the record within the Card table containing contact details. (optional)
cardsTypeID = cardsTypeID_example # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
createDate = createDate_example # String | The creation date of the contact record. (optional)
firstName = firstName_example # String | Blank if the card record represents a company, otherwise the first name of the individual. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the individual's last name. (optional)
name = name_example # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

try: 
    # Returns a list of contact information
    api_response = api_instance.contactlist_get(linkCardRecordID=linkCardRecordID, cardsTypeID=cardsTypeID, createDate=createDate, firstName=firstName, lastName=lastName, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->contactlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
LinkCardRecordID
Integer
The card ID number of the record within the Card table containing contact details.
CardsTypeID
String
CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
CreateDate
String
The creation date of the contact record.
FirstName
String
Blank if the card record represents a company, otherwise the first name of the individual.
LastName
String
The company name if the card record represents a company, otherwise the individual's last name.
Name
String
If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

Responses

Status: 200 - OK


contactsGet

Returns Contact information.

The contact request returns information about the specified contact.


/contacts

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/contacts?CardIdentification=&CardRecordID=&CardsTypeID=&CreateDate=&FirstName=&LastName=&Name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *cardRecordID = 56; // The card ID number of the record within the Card table containing contact details. (optional)
String *cardsTypeID = cardsTypeID_example; // CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
String *createDate = createDate_example; // The creation date of the contact record. (optional)
String *firstName = firstName_example; // Blank if the card record represents a company, otherwise the first name of the individual. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the individual's last name. (optional)
String *name = name_example; // If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns Contact information.
[apiInstance contactsGetWith:cardIdentification
    cardRecordID:cardRecordID
    cardsTypeID:cardsTypeID
    createDate:createDate
    firstName:firstName
    lastName:lastName
    name:name
              completionHandler: ^(contactsget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'cardRecordID': 56, // {{Integer}} The card ID number of the record within the Card table containing contact details.
  'cardsTypeID': cardsTypeID_example, // {{String}} CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
  'createDate': createDate_example, // {{String}} The creation date of the contact record.
  'firstName': firstName_example, // {{String}} Blank if the card record represents a company, otherwise the first name of the individual.
  'lastName': lastName_example, // {{String}} The company name if the card record represents a company, otherwise the individual's last name.
  'name': name_example // {{String}} If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var cardRecordID = 56;  // Integer | The card ID number of the record within the Card table containing contact details. (optional) 
            var cardsTypeID = cardsTypeID_example;  // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional) 
            var createDate = createDate_example;  // String | The creation date of the contact record. (optional) 
            var firstName = firstName_example;  // String | Blank if the card record represents a company, otherwise the first name of the individual. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the individual's last name. (optional) 
            var name = name_example;  // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional) 

            try
            {
                // Returns Contact information.
                contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.contactsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
$cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
$createDate = createDate_example; // String | The creation date of the contact record.
$firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
$name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

try {
    $result = $api_instance->contactsGet($cardIdentification, $cardRecordID, $cardsTypeID, $createDate, $firstName, $lastName, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->contactsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $cardRecordID = 56; # Integer | The card ID number of the record within the Card table containing contact details.
my $cardsTypeID = cardsTypeID_example; # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
my $createDate = createDate_example; # String | The creation date of the contact record.
my $firstName = firstName_example; # String | Blank if the card record represents a company, otherwise the first name of the individual.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the individual's last name.
my $name = name_example; # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

eval { 
    my $result = $api_instance->contactsGet(cardIdentification => $cardIdentification, cardRecordID => $cardRecordID, cardsTypeID => $cardsTypeID, createDate => $createDate, firstName => $firstName, lastName => $lastName, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->contactsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
cardRecordID = 56 # Integer | The card ID number of the record within the Card table containing contact details. (optional)
cardsTypeID = cardsTypeID_example # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
createDate = createDate_example # String | The creation date of the contact record. (optional)
firstName = firstName_example # String | Blank if the card record represents a company, otherwise the first name of the individual. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the individual's last name. (optional)
name = name_example # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

try: 
    # Returns Contact information.
    api_response = api_instance.contacts_get(cardIdentification=cardIdentification, cardRecordID=cardRecordID, cardsTypeID=cardsTypeID, createDate=createDate, firstName=firstName, lastName=lastName, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->contactsGet: %s\n" % e)

Parameters

Query parameters
Name Description
CardIdentification
String
User defined unique card ID.
CardRecordID
Integer
The card ID number of the record within the Card table containing contact details.
CardsTypeID
String
CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
CreateDate
String
The creation date of the contact record.
FirstName
String
Blank if the card record represents a company, otherwise the first name of the individual.
LastName
String
The company name if the card record represents a company, otherwise the individual's last name.
Name
String
If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

Responses

Status: 200 - OK


customerpaymentsGet

Returns payment information.

The payment customer request returns information about the specified payment.


/customerpayments

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/customerpayments?Account=&ChequeNumber=&Comments=&CustomerID=&CustomerName=&CustomerPO=&InvoiceNumber=&Memo=&PaymentID=&ReceiptNumber=&SaleID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The account name.
        Integer chequeNumber = 56; // Integer | The payment cheque number
        String comments = comments_example; // String | Comment of the payments
        Integer customerID = 56; // Integer | The primary key value of the Customer record.
        String customerName = customerName_example; // String | The name of the customer
        Integer customerPO = 56; // Integer | The customer purchase order number
        Integer invoiceNumber = 56; // Integer | The invoice number of the sale
        String memo = memo_example; // String | Any reminding notes attached to the payment.
        String paymentID = paymentID_example; // String | The primary key value of the customer payment.
        Integer receiptNumber = 56; // Integer | The receipt number of the payment
        Integer saleID = 56; // Integer | The primary key value of the sale record.
        try {
            customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#customerpaymentsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The account name.
        Integer chequeNumber = 56; // Integer | The payment cheque number
        String comments = comments_example; // String | Comment of the payments
        Integer customerID = 56; // Integer | The primary key value of the Customer record.
        String customerName = customerName_example; // String | The name of the customer
        Integer customerPO = 56; // Integer | The customer purchase order number
        Integer invoiceNumber = 56; // Integer | The invoice number of the sale
        String memo = memo_example; // String | Any reminding notes attached to the payment.
        String paymentID = paymentID_example; // String | The primary key value of the customer payment.
        Integer receiptNumber = 56; // Integer | The receipt number of the payment
        Integer saleID = 56; // Integer | The primary key value of the sale record.
        try {
            customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#customerpaymentsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *account = account_example; // The account name. (optional)
Integer *chequeNumber = 56; // The payment cheque number (optional)
String *comments = comments_example; // Comment of the payments (optional)
Integer *customerID = 56; // The primary key value of the Customer record. (optional)
String *customerName = customerName_example; // The name of the customer (optional)
Integer *customerPO = 56; // The customer purchase order number (optional)
Integer *invoiceNumber = 56; // The invoice number of the sale (optional)
String *memo = memo_example; // Any reminding notes attached to the payment. (optional)
String *paymentID = paymentID_example; // The primary key value of the customer payment. (optional)
Integer *receiptNumber = 56; // The receipt number of the payment (optional)
Integer *saleID = 56; // The primary key value of the sale record. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns payment information.
[apiInstance customerpaymentsGetWith:account
    chequeNumber:chequeNumber
    comments:comments
    customerID:customerID
    customerName:customerName
    customerPO:customerPO
    invoiceNumber:invoiceNumber
    memo:memo
    paymentID:paymentID
    receiptNumber:receiptNumber
    saleID:saleID
              completionHandler: ^(customerpaymentsget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'account': account_example, // {{String}} The account name.
  'chequeNumber': 56, // {{Integer}} The payment cheque number
  'comments': comments_example, // {{String}} Comment of the payments
  'customerID': 56, // {{Integer}} The primary key value of the Customer record.
  'customerName': customerName_example, // {{String}} The name of the customer
  'customerPO': 56, // {{Integer}} The customer purchase order number
  'invoiceNumber': 56, // {{Integer}} The invoice number of the sale
  'memo': memo_example, // {{String}} Any reminding notes attached to the payment.
  'paymentID': paymentID_example, // {{String}} The primary key value of the customer payment.
  'receiptNumber': 56, // {{Integer}} The receipt number of the payment
  'saleID': 56 // {{Integer}} The primary key value of the sale record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerpaymentsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customerpaymentsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var account = account_example;  // String | The account name. (optional) 
            var chequeNumber = 56;  // Integer | The payment cheque number (optional) 
            var comments = comments_example;  // String | Comment of the payments (optional) 
            var customerID = 56;  // Integer | The primary key value of the Customer record. (optional) 
            var customerName = customerName_example;  // String | The name of the customer (optional) 
            var customerPO = 56;  // Integer | The customer purchase order number (optional) 
            var invoiceNumber = 56;  // Integer | The invoice number of the sale (optional) 
            var memo = memo_example;  // String | Any reminding notes attached to the payment. (optional) 
            var paymentID = paymentID_example;  // String | The primary key value of the customer payment. (optional) 
            var receiptNumber = 56;  // Integer | The receipt number of the payment (optional) 
            var saleID = 56;  // Integer | The primary key value of the sale record. (optional) 

            try
            {
                // Returns payment information.
                customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.customerpaymentsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$account = account_example; // String | The account name.
$chequeNumber = 56; // Integer | The payment cheque number
$comments = comments_example; // String | Comment of the payments
$customerID = 56; // Integer | The primary key value of the Customer record.
$customerName = customerName_example; // String | The name of the customer
$customerPO = 56; // Integer | The customer purchase order number
$invoiceNumber = 56; // Integer | The invoice number of the sale
$memo = memo_example; // String | Any reminding notes attached to the payment.
$paymentID = paymentID_example; // String | The primary key value of the customer payment.
$receiptNumber = 56; // Integer | The receipt number of the payment
$saleID = 56; // Integer | The primary key value of the sale record.

try {
    $result = $api_instance->customerpaymentsGet($account, $chequeNumber, $comments, $customerID, $customerName, $customerPO, $invoiceNumber, $memo, $paymentID, $receiptNumber, $saleID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->customerpaymentsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $account = account_example; # String | The account name.
my $chequeNumber = 56; # Integer | The payment cheque number
my $comments = comments_example; # String | Comment of the payments
my $customerID = 56; # Integer | The primary key value of the Customer record.
my $customerName = customerName_example; # String | The name of the customer
my $customerPO = 56; # Integer | The customer purchase order number
my $invoiceNumber = 56; # Integer | The invoice number of the sale
my $memo = memo_example; # String | Any reminding notes attached to the payment.
my $paymentID = paymentID_example; # String | The primary key value of the customer payment.
my $receiptNumber = 56; # Integer | The receipt number of the payment
my $saleID = 56; # Integer | The primary key value of the sale record.

eval { 
    my $result = $api_instance->customerpaymentsGet(account => $account, chequeNumber => $chequeNumber, comments => $comments, customerID => $customerID, customerName => $customerName, customerPO => $customerPO, invoiceNumber => $invoiceNumber, memo => $memo, paymentID => $paymentID, receiptNumber => $receiptNumber, saleID => $saleID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->customerpaymentsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
account = account_example # String | The account name. (optional)
chequeNumber = 56 # Integer | The payment cheque number (optional)
comments = comments_example # String | Comment of the payments (optional)
customerID = 56 # Integer | The primary key value of the Customer record. (optional)
customerName = customerName_example # String | The name of the customer (optional)
customerPO = 56 # Integer | The customer purchase order number (optional)
invoiceNumber = 56 # Integer | The invoice number of the sale (optional)
memo = memo_example # String | Any reminding notes attached to the payment. (optional)
paymentID = paymentID_example # String | The primary key value of the customer payment. (optional)
receiptNumber = 56 # Integer | The receipt number of the payment (optional)
saleID = 56 # Integer | The primary key value of the sale record. (optional)

try: 
    # Returns payment information.
    api_response = api_instance.customerpayments_get(account=account, chequeNumber=chequeNumber, comments=comments, customerID=customerID, customerName=customerName, customerPO=customerPO, invoiceNumber=invoiceNumber, memo=memo, paymentID=paymentID, receiptNumber=receiptNumber, saleID=saleID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->customerpaymentsGet: %s\n" % e)

Parameters

Query parameters
Name Description
Account
String
The account name.
ChequeNumber
Integer
The payment cheque number
Comments
String
Comment of the payments
CustomerID
Integer
The primary key value of the Customer record.
CustomerName
String
The name of the customer
CustomerPO
Integer
The customer purchase order number
InvoiceNumber
Integer
The invoice number of the sale
Memo
String
Any reminding notes attached to the payment.
PaymentID
String
The primary key value of the customer payment.
ReceiptNumber
Integer
The receipt number of the payment
SaleID
Integer
The primary key value of the sale record.

Responses

Status: 200 - OK


formGet

Generates the report and return the url to get the report.

The form generates the report with the given params and return the url to get generated report


/form

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/form?Filename=&ID=&SaveAsExcel=&SaveAsHtml=&Type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String filename = filename_example; // String | A valid filename.
        Integer iD = 56; // Integer | The primary key value of the form record.
        Boolean saveAsExcel = true; // Boolean | Save as excel.
        Boolean saveAsHtml = true; // Boolean | Save as HTML.
        String type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
        try {
            form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#formGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String filename = filename_example; // String | A valid filename.
        Integer iD = 56; // Integer | The primary key value of the form record.
        Boolean saveAsExcel = true; // Boolean | Save as excel.
        Boolean saveAsHtml = true; // Boolean | Save as HTML.
        String type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
        try {
            form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#formGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *filename = filename_example; // A valid filename. (optional)
Integer *iD = 56; // The primary key value of the form record. (optional)
Boolean *saveAsExcel = true; // Save as excel. (optional)
Boolean *saveAsHtml = true; // Save as HTML. (optional)
String *type = type_example; // Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Generates the report and return the url to get the report.
[apiInstance formGetWith:filename
    iD:iD
    saveAsExcel:saveAsExcel
    saveAsHtml:saveAsHtml
    type:type
              completionHandler: ^(form output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'filename': filename_example, // {{String}} A valid filename.
  'iD': 56, // {{Integer}} The primary key value of the form record.
  'saveAsExcel': true, // {{Boolean}} Save as excel.
  'saveAsHtml': true, // {{Boolean}} Save as HTML.
  'type': type_example // {{String}} Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.formGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class formGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var filename = filename_example;  // String | A valid filename. (optional) 
            var iD = 56;  // Integer | The primary key value of the form record. (optional) 
            var saveAsExcel = true;  // Boolean | Save as excel. (optional) 
            var saveAsHtml = true;  // Boolean | Save as HTML. (optional) 
            var type = type_example;  // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional) 

            try
            {
                // Generates the report and return the url to get the report.
                form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.formGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$filename = filename_example; // String | A valid filename.
$iD = 56; // Integer | The primary key value of the form record.
$saveAsExcel = true; // Boolean | Save as excel.
$saveAsHtml = true; // Boolean | Save as HTML.
$type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

try {
    $result = $api_instance->formGet($filename, $iD, $saveAsExcel, $saveAsHtml, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->formGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $filename = filename_example; # String | A valid filename.
my $iD = 56; # Integer | The primary key value of the form record.
my $saveAsExcel = true; # Boolean | Save as excel.
my $saveAsHtml = true; # Boolean | Save as HTML.
my $type = type_example; # String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

eval { 
    my $result = $api_instance->formGet(filename => $filename, iD => $iD, saveAsExcel => $saveAsExcel, saveAsHtml => $saveAsHtml, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->formGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
filename = filename_example # String | A valid filename. (optional)
iD = 56 # Integer | The primary key value of the form record. (optional)
saveAsExcel = true # Boolean | Save as excel. (optional)
saveAsHtml = true # Boolean | Save as HTML. (optional)
type = type_example # String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional)

try: 
    # Generates the report and return the url to get the report.
    api_response = api_instance.form_get(filename=filename, iD=iD, saveAsExcel=saveAsExcel, saveAsHtml=saveAsHtml, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->formGet: %s\n" % e)

Parameters

Query parameters
Name Description
Filename
String
A valid filename.
ID
Integer
The primary key value of the form record.
SaveAsExcel
Boolean
Save as excel.
SaveAsHtml
Boolean
Save as HTML.
Type
String
Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

Responses

Status: 200 - OK


getInventory

The inventory request returns information about the specified inventory.

By passing in the appropriate options, you can search for available inventory in the system


/inventory

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/inventory?BaseStockID=&BatchListID=&BinID=&ItemName=&ItemNumber=&LocationID=&BRN="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer batchListID = 56; // Integer | Pass a primary key of a batch list item.
        Integer binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
        String itemName = itemName_example; // String | Pass by an item name.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        String bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.
        try {
            inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer batchListID = 56; // Integer | Pass a primary key of a batch list item.
        Integer binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
        String itemName = itemName_example; // String | Pass by an item name.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        String bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.
        try {
            inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getInventory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
Integer *batchListID = 56; // Pass a primary key of a batch list item. (optional)
Integer *binID = 56; // Pass by primary key of the item's assigned Bin. (optional)
String *itemName = itemName_example; // Pass by an item name. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *locationID = 56; // Pass by primary key of an items location. (optional)
String *bRN = bRN_example; // Pass by the Batch Registration Number of an item. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// The inventory request returns information about the specified inventory.
[apiInstance getInventoryWith:baseStockID
    batchListID:batchListID
    binID:binID
    itemName:itemName
    itemNumber:itemNumber
    locationID:locationID
    bRN:bRN
              completionHandler: ^(inventory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'batchListID': 56, // {{Integer}} Pass a primary key of a batch list item.
  'binID': 56, // {{Integer}} Pass by primary key of the item's assigned Bin.
  'itemName': itemName_example, // {{String}} Pass by an item name.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'locationID': 56, // {{Integer}} Pass by primary key of an items location.
  'bRN': bRN_example // {{String}} Pass by the Batch Registration Number of an item.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInventory(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInventoryExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var batchListID = 56;  // Integer | Pass a primary key of a batch list item. (optional) 
            var binID = 56;  // Integer | Pass by primary key of the item's assigned Bin. (optional) 
            var itemName = itemName_example;  // String | Pass by an item name. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var locationID = 56;  // Integer | Pass by primary key of an items location. (optional) 
            var bRN = bRN_example;  // String | Pass by the Batch Registration Number of an item. (optional) 

            try
            {
                // The inventory request returns information about the specified inventory.
                inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$batchListID = 56; // Integer | Pass a primary key of a batch list item.
$binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
$itemName = itemName_example; // String | Pass by an item name.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$locationID = 56; // Integer | Pass by primary key of an items location.
$bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.

try {
    $result = $api_instance->getInventory($baseStockID, $batchListID, $binID, $itemName, $itemNumber, $locationID, $bRN);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $batchListID = 56; # Integer | Pass a primary key of a batch list item.
my $binID = 56; # Integer | Pass by primary key of the item's assigned Bin.
my $itemName = itemName_example; # String | Pass by an item name.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $locationID = 56; # Integer | Pass by primary key of an items location.
my $bRN = bRN_example; # String | Pass by the Batch Registration Number of an item.

eval { 
    my $result = $api_instance->getInventory(baseStockID => $baseStockID, batchListID => $batchListID, binID => $binID, itemName => $itemName, itemNumber => $itemNumber, locationID => $locationID, bRN => $bRN);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
batchListID = 56 # Integer | Pass a primary key of a batch list item. (optional)
binID = 56 # Integer | Pass by primary key of the item's assigned Bin. (optional)
itemName = itemName_example # String | Pass by an item name. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
locationID = 56 # Integer | Pass by primary key of an items location. (optional)
bRN = bRN_example # String | Pass by the Batch Registration Number of an item. (optional)

try: 
    # The inventory request returns information about the specified inventory.
    api_response = api_instance.get_inventory(baseStockID=baseStockID, batchListID=batchListID, binID=binID, itemName=itemName, itemNumber=itemNumber, locationID=locationID, bRN=bRN)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getInventory: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
BatchListID
Integer
Pass a primary key of a batch list item.
BinID
Integer
Pass by primary key of the item's assigned Bin.
ItemName
String
Pass by an item name.
ItemNumber
String
Pass by an item number.
LocationID
Integer
Pass by primary key of an items location.
BRN
String
Pass by the Batch Registration Number of an item.

Responses

Status: 200 - OK


getItem

Returns information about a specified item.

The items endpoint returns one record per SKU (stock keeping unit) or sometimes called the Item Master List. Each record provides information regarding the generic item properties and specific article location details. This endpoint is typically used to generate lists of available inventory available for sale or consumption.


/items

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/items?BaseStockID=&CustomField1=&CustomField2=&CustomField3=&ItemName=&ItemNumber=&ItemNotes=&MYOBItemID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String itemName = itemName_example; // String | The item name.
        String itemNumber = itemNumber_example; // String | The allocated item number.
        String itemNotes = itemNotes_example; // String | The notes for an item.
        Integer mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database
        try {
            array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String itemName = itemName_example; // String | The item name.
        String itemNumber = itemNumber_example; // String | The allocated item number.
        String itemNotes = itemNotes_example; // String | The notes for an item.
        Integer mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database
        try {
            array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *customField1 = customField1_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *customField2 = customField2_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *customField3 = customField3_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *itemName = itemName_example; // The item name. (optional)
String *itemNumber = itemNumber_example; // The allocated item number. (optional)
String *itemNotes = itemNotes_example; // The notes for an item. (optional)
Integer *mYOBItemID = 56; // The primary key of the item in the MYOB database (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about a specified item.
[apiInstance getItemWith:baseStockID
    customField1:customField1
    customField2:customField2
    customField3:customField3
    itemName:itemName
    itemNumber:itemNumber
    itemNotes:itemNotes
    mYOBItemID:mYOBItemID
              completionHandler: ^(array[itemsGet] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'customField1': customField1_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'customField2': customField2_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'customField3': customField3_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'itemName': itemName_example, // {{String}} The item name.
  'itemNumber': itemNumber_example, // {{String}} The allocated item number.
  'itemNotes': itemNotes_example, // {{String}} The notes for an item.
  'mYOBItemID': 56 // {{Integer}} The primary key of the item in the MYOB database
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItem(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var customField1 = customField1_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var customField2 = customField2_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var customField3 = customField3_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var itemName = itemName_example;  // String | The item name. (optional) 
            var itemNumber = itemNumber_example;  // String | The allocated item number. (optional) 
            var itemNotes = itemNotes_example;  // String | The notes for an item. (optional) 
            var mYOBItemID = 56;  // Integer | The primary key of the item in the MYOB database (optional) 

            try
            {
                // Returns information about a specified item.
                array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$itemName = itemName_example; // String | The item name.
$itemNumber = itemNumber_example; // String | The allocated item number.
$itemNotes = itemNotes_example; // String | The notes for an item.
$mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database

try {
    $result = $api_instance->getItem($baseStockID, $customField1, $customField2, $customField3, $itemName, $itemNumber, $itemNotes, $mYOBItemID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $customField1 = customField1_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $customField2 = customField2_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $customField3 = customField3_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $itemName = itemName_example; # String | The item name.
my $itemNumber = itemNumber_example; # String | The allocated item number.
my $itemNotes = itemNotes_example; # String | The notes for an item.
my $mYOBItemID = 56; # Integer | The primary key of the item in the MYOB database

eval { 
    my $result = $api_instance->getItem(baseStockID => $baseStockID, customField1 => $customField1, customField2 => $customField2, customField3 => $customField3, itemName => $itemName, itemNumber => $itemNumber, itemNotes => $itemNotes, mYOBItemID => $mYOBItemID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
customField1 = customField1_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
customField2 = customField2_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
customField3 = customField3_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
itemName = itemName_example # String | The item name. (optional)
itemNumber = itemNumber_example # String | The allocated item number. (optional)
itemNotes = itemNotes_example # String | The notes for an item. (optional)
mYOBItemID = 56 # Integer | The primary key of the item in the MYOB database (optional)

try: 
    # Returns information about a specified item.
    api_response = api_instance.get_item(baseStockID=baseStockID, customField1=customField1, customField2=customField2, customField3=customField3, itemName=itemName, itemNumber=itemNumber, itemNotes=itemNotes, mYOBItemID=mYOBItemID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItem: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
CustomField1
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
CustomField2
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
CustomField3
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
ItemName
String
The item name.
ItemNumber
String
The allocated item number.
ItemNotes
String
The notes for an item.
MYOBItemID
Integer
The primary key of the item in the MYOB database

Responses

Status: 200 - OK


getItemFeature

Returns item feature information.

Returns information about the specified feature.


/itemFeature

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/itemFeature?BaseStockID=&ItemNumber=&Name=&Type=&Value="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        String name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
        String type = type_example; // String | Type of feature.
        String value = value_example; // String | Value of the feature.
        try {
            itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemFeature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        String name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
        String type = type_example; // String | Type of feature.
        String value = value_example; // String | Value of the feature.
        try {
            itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemFeature");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
String *name = name_example; // If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional)
String *type = type_example; // Type of feature. (optional)
String *value = value_example; // Value of the feature. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns item feature information.
[apiInstance getItemFeatureWith:baseStockID
    itemNumber:itemNumber
    name:name
    type:type
    value:value
              completionHandler: ^(itemFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'name': name_example, // {{String}} If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
  'type': type_example, // {{String}} Type of feature.
  'value': value_example // {{String}} Value of the feature.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemFeature(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemFeatureExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var name = name_example;  // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional) 
            var type = type_example;  // String | Type of feature. (optional) 
            var value = value_example;  // String | Value of the feature. (optional) 

            try
            {
                // Returns item feature information.
                itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItemFeature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
$type = type_example; // String | Type of feature.
$value = value_example; // String | Value of the feature.

try {
    $result = $api_instance->getItemFeature($baseStockID, $itemNumber, $name, $type, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItemFeature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $name = name_example; # String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
my $type = type_example; # String | Type of feature.
my $value = value_example; # String | Value of the feature.

eval { 
    my $result = $api_instance->getItemFeature(baseStockID => $baseStockID, itemNumber => $itemNumber, name => $name, type => $type, value => $value);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItemFeature: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
name = name_example # String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional)
type = type_example # String | Type of feature. (optional)
value = value_example # String | Value of the feature. (optional)

try: 
    # Returns item feature information.
    api_response = api_instance.get_item_feature(baseStockID=baseStockID, itemNumber=itemNumber, name=name, type=type, value=value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItemFeature: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.
Name
String
If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
Type
String
Type of feature.
Value
String
Value of the feature.

Responses

Status: 200 - OK


getItemList

Returns a list of item attributes

The itemslist endpoint enables queries on the master item list returning item attributes per basestockid. This endpoint is related to the item endpoint but will not return stock levels only item properties. This endpoint should be used to read general item attributes - for inventory levels see the inventorylist endpoint.


/itemsList

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/itemsList?BaseStockID=&ItemNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        try {
            inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        try {
            inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns a list of item attributes
[apiInstance getItemListWith:baseStockID
    itemNumber:itemNumber
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example // {{String}} Pass by an item number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 

            try
            {
                // Returns a list of item attributes
                inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItemList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.

try {
    $result = $api_instance->getItemList($baseStockID, $itemNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItemList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.

eval { 
    my $result = $api_instance->getItemList(baseStockID => $baseStockID, itemNumber => $itemNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItemList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)

try: 
    # Returns a list of item attributes
    api_response = api_instance.get_item_list(baseStockID=baseStockID, itemNumber=itemNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItemList: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.

Responses

Status: 200 - OK


locationbinGet

Returns locationbin information.

The locationbin request returns information about the specified location.


/locationbin

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/locationbin?BinName=&Location="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String binName = binName_example; // String | The Bin Name.
        String location = location_example; // String | The name of the location.
        try {
            locationbin result = apiInstance.locationbinGet(binName, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationbinGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String binName = binName_example; // String | The Bin Name.
        String location = location_example; // String | The name of the location.
        try {
            locationbin result = apiInstance.locationbinGet(binName, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationbinGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *binName = binName_example; // The Bin Name. (optional)
String *location = location_example; // The name of the location. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns locationbin information.
[apiInstance locationbinGetWith:binName
    location:location
              completionHandler: ^(locationbin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'binName': binName_example, // {{String}} The Bin Name.
  'location': location_example // {{String}} The name of the location.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationbinGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locationbinGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var binName = binName_example;  // String | The Bin Name. (optional) 
            var location = location_example;  // String | The name of the location. (optional) 

            try
            {
                // Returns locationbin information.
                locationbin result = apiInstance.locationbinGet(binName, location);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.locationbinGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$binName = binName_example; // String | The Bin Name.
$location = location_example; // String | The name of the location.

try {
    $result = $api_instance->locationbinGet($binName, $location);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->locationbinGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $binName = binName_example; # String | The Bin Name.
my $location = location_example; # String | The name of the location.

eval { 
    my $result = $api_instance->locationbinGet(binName => $binName, location => $location);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->locationbinGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
binName = binName_example # String | The Bin Name. (optional)
location = location_example # String | The name of the location. (optional)

try: 
    # Returns locationbin information.
    api_response = api_instance.locationbin_get(binName=binName, location=location)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->locationbinGet: %s\n" % e)

Parameters

Query parameters
Name Description
BinName
String
The Bin Name.
Location
String
The name of the location.

Responses

Status: 200 - OK


locationsGet

Returns information about the specified location.

The locations request returns information about the specified locations.


/locations

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/locations?cardIdentification=&locationsID=&contactID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer locationsID = 56; // Integer | The primary key of the location record.
        Integer contactID = 56; // Integer | Unique identifier for a stored Contact's details.
        try {
            array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer locationsID = 56; // Integer | The primary key of the location record.
        Integer contactID = 56; // Integer | Unique identifier for a stored Contact's details.
        try {
            array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *locationsID = 56; // The primary key of the location record. (optional)
Integer *contactID = 56; // Unique identifier for a stored Contact's details. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified location.
[apiInstance locationsGetWith:cardIdentification
    locationsID:locationsID
    contactID:contactID
              completionHandler: ^(array[locations] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'locationsID': 56, // {{Integer}} The primary key of the location record.
  'contactID': 56 // {{Integer}} Unique identifier for a stored Contact's details.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locationsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var locationsID = 56;  // Integer | The primary key of the location record. (optional) 
            var contactID = 56;  // Integer | Unique identifier for a stored Contact's details. (optional) 

            try
            {
                // Returns information about the specified location.
                array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.locationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$locationsID = 56; // Integer | The primary key of the location record.
$contactID = 56; // Integer | Unique identifier for a stored Contact's details.

try {
    $result = $api_instance->locationsGet($cardIdentification, $locationsID, $contactID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->locationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $locationsID = 56; # Integer | The primary key of the location record.
my $contactID = 56; # Integer | Unique identifier for a stored Contact's details.

eval { 
    my $result = $api_instance->locationsGet(cardIdentification => $cardIdentification, locationsID => $locationsID, contactID => $contactID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->locationsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
locationsID = 56 # Integer | The primary key of the location record. (optional)
contactID = 56 # Integer | Unique identifier for a stored Contact's details. (optional)

try: 
    # Returns information about the specified location.
    api_response = api_instance.locations_get(cardIdentification=cardIdentification, locationsID=locationsID, contactID=contactID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->locationsGet: %s\n" % e)

Parameters

Query parameters
Name Description
cardIdentification
String
User defined unique card ID.
locationsID
Integer
The primary key of the location record.
contactID
Integer
Unique identifier for a stored Contact's details.

Responses

Status: 200 - OK


paymentsupplierGet

Returns supplier payment information.


/paymentsupplier

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/paymentsupplier?Account=&ChequeNumber=&DateClosed=&InvoiceNumber=&PaymentDate=&PaymentID=&PurchaseID=&ReceiptNumber=&SupplierID=&SupplierName=&SupplierPO="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The supplier account number.
        Integer chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
        String dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
        String invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
        String paymentDate = paymentDate_example; // String | The date of a supplier payment
        Integer paymentID = 56; // Integer | The primary key value of the payment record.
        Integer purchaseID = 56; // Integer | The primary key value of the purchase record.
        String receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
        Integer supplierID = 56; // Integer | The primary key value of the supplier record.
        String supplierName = supplierName_example; // String | The name of the supplier.
        Integer supplierPO = 56; // Integer | The supplier purchase order number.
        try {
            paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#paymentsupplierGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The supplier account number.
        Integer chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
        String dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
        String invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
        String paymentDate = paymentDate_example; // String | The date of a supplier payment
        Integer paymentID = 56; // Integer | The primary key value of the payment record.
        Integer purchaseID = 56; // Integer | The primary key value of the purchase record.
        String receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
        Integer supplierID = 56; // Integer | The primary key value of the supplier record.
        String supplierName = supplierName_example; // String | The name of the supplier.
        Integer supplierPO = 56; // Integer | The supplier purchase order number.
        try {
            paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#paymentsupplierGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *account = account_example; // The supplier account number. (optional)
Integer *chequeNumber = 56; // The number on the cheque related to a specified payment (optional)
String *dateClosed = dateClosed_example; // The date in which a payment record was closed. (optional)
String *invoiceNumber = invoiceNumber_example; // The invoice number related to a payment. (optional)
String *paymentDate = paymentDate_example; // The date of a supplier payment (optional)
Integer *paymentID = 56; // The primary key value of the payment record. (optional)
Integer *purchaseID = 56; // The primary key value of the purchase record. (optional)
String *receiptNumber = receiptNumber_example; // The receipt number of a payment. (optional)
Integer *supplierID = 56; // The primary key value of the supplier record. (optional)
String *supplierName = supplierName_example; // The name of the supplier. (optional)
Integer *supplierPO = 56; // The supplier purchase order number. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns supplier payment information.
[apiInstance paymentsupplierGetWith:account
    chequeNumber:chequeNumber
    dateClosed:dateClosed
    invoiceNumber:invoiceNumber
    paymentDate:paymentDate
    paymentID:paymentID
    purchaseID:purchaseID
    receiptNumber:receiptNumber
    supplierID:supplierID
    supplierName:supplierName
    supplierPO:supplierPO
              completionHandler: ^(paymentsupplierget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'account': account_example, // {{String}} The supplier account number.
  'chequeNumber': 56, // {{Integer}} The number on the cheque related to a specified payment
  'dateClosed': dateClosed_example, // {{String}} The date in which a payment record was closed.
  'invoiceNumber': invoiceNumber_example, // {{String}} The invoice number related to a payment.
  'paymentDate': paymentDate_example, // {{String}} The date of a supplier payment
  'paymentID': 56, // {{Integer}} The primary key value of the payment record.
  'purchaseID': 56, // {{Integer}} The primary key value of the purchase record.
  'receiptNumber': receiptNumber_example, // {{String}} The receipt number of a payment.
  'supplierID': 56, // {{Integer}} The primary key value of the supplier record.
  'supplierName': supplierName_example, // {{String}} The name of the supplier.
  'supplierPO': 56 // {{Integer}} The supplier purchase order number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.paymentsupplierGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class paymentsupplierGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var account = account_example;  // String | The supplier account number. (optional) 
            var chequeNumber = 56;  // Integer | The number on the cheque related to a specified payment (optional) 
            var dateClosed = dateClosed_example;  // String | The date in which a payment record was closed. (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The invoice number related to a payment. (optional) 
            var paymentDate = paymentDate_example;  // String | The date of a supplier payment (optional) 
            var paymentID = 56;  // Integer | The primary key value of the payment record. (optional) 
            var purchaseID = 56;  // Integer | The primary key value of the purchase record. (optional) 
            var receiptNumber = receiptNumber_example;  // String | The receipt number of a payment. (optional) 
            var supplierID = 56;  // Integer | The primary key value of the supplier record. (optional) 
            var supplierName = supplierName_example;  // String | The name of the supplier. (optional) 
            var supplierPO = 56;  // Integer | The supplier purchase order number. (optional) 

            try
            {
                // Returns supplier payment information.
                paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.paymentsupplierGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$account = account_example; // String | The supplier account number.
$chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
$dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
$invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
$paymentDate = paymentDate_example; // String | The date of a supplier payment
$paymentID = 56; // Integer | The primary key value of the payment record.
$purchaseID = 56; // Integer | The primary key value of the purchase record.
$receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
$supplierID = 56; // Integer | The primary key value of the supplier record.
$supplierName = supplierName_example; // String | The name of the supplier.
$supplierPO = 56; // Integer | The supplier purchase order number.

try {
    $result = $api_instance->paymentsupplierGet($account, $chequeNumber, $dateClosed, $invoiceNumber, $paymentDate, $paymentID, $purchaseID, $receiptNumber, $supplierID, $supplierName, $supplierPO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->paymentsupplierGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $account = account_example; # String | The supplier account number.
my $chequeNumber = 56; # Integer | The number on the cheque related to a specified payment
my $dateClosed = dateClosed_example; # String | The date in which a payment record was closed.
my $invoiceNumber = invoiceNumber_example; # String | The invoice number related to a payment.
my $paymentDate = paymentDate_example; # String | The date of a supplier payment
my $paymentID = 56; # Integer | The primary key value of the payment record.
my $purchaseID = 56; # Integer | The primary key value of the purchase record.
my $receiptNumber = receiptNumber_example; # String | The receipt number of a payment.
my $supplierID = 56; # Integer | The primary key value of the supplier record.
my $supplierName = supplierName_example; # String | The name of the supplier.
my $supplierPO = 56; # Integer | The supplier purchase order number.

eval { 
    my $result = $api_instance->paymentsupplierGet(account => $account, chequeNumber => $chequeNumber, dateClosed => $dateClosed, invoiceNumber => $invoiceNumber, paymentDate => $paymentDate, paymentID => $paymentID, purchaseID => $purchaseID, receiptNumber => $receiptNumber, supplierID => $supplierID, supplierName => $supplierName, supplierPO => $supplierPO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->paymentsupplierGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
account = account_example # String | The supplier account number. (optional)
chequeNumber = 56 # Integer | The number on the cheque related to a specified payment (optional)
dateClosed = dateClosed_example # String | The date in which a payment record was closed. (optional)
invoiceNumber = invoiceNumber_example # String | The invoice number related to a payment. (optional)
paymentDate = paymentDate_example # String | The date of a supplier payment (optional)
paymentID = 56 # Integer | The primary key value of the payment record. (optional)
purchaseID = 56 # Integer | The primary key value of the purchase record. (optional)
receiptNumber = receiptNumber_example # String | The receipt number of a payment. (optional)
supplierID = 56 # Integer | The primary key value of the supplier record. (optional)
supplierName = supplierName_example # String | The name of the supplier. (optional)
supplierPO = 56 # Integer | The supplier purchase order number. (optional)

try: 
    # Returns supplier payment information.
    api_response = api_instance.paymentsupplier_get(account=account, chequeNumber=chequeNumber, dateClosed=dateClosed, invoiceNumber=invoiceNumber, paymentDate=paymentDate, paymentID=paymentID, purchaseID=purchaseID, receiptNumber=receiptNumber, supplierID=supplierID, supplierName=supplierName, supplierPO=supplierPO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->paymentsupplierGet: %s\n" % e)

Parameters

Query parameters
Name Description
Account
String
The supplier account number.
ChequeNumber
Integer
The number on the cheque related to a specified payment
DateClosed
String
The date in which a payment record was closed.
InvoiceNumber
String
The invoice number related to a payment.
PaymentDate
String
The date of a supplier payment
PaymentID
Integer
The primary key value of the payment record.
PurchaseID
Integer
The primary key value of the purchase record.
ReceiptNumber
String
The receipt number of a payment.
SupplierID
Integer
The primary key value of the supplier record.
SupplierName
String
The name of the supplier.
SupplierPO
Integer
The supplier purchase order number.

Responses

Status: 200 - OK


pricelistGet

Return pricing of a specific item for a specific customer.

The Pricelistreturn pricing of a specific item for a specific customer.


/pricelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/pricelist?BaseStockID=&CardIdentification=&CardsID=&ItemNumber=&LastName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.'
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardsID = 56; // Integer | The primary key of the card record
        String itemNumber = itemNumber_example; // String | The item number.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.
        try {
            array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#pricelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.'
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardsID = 56; // Integer | The primary key of the card record
        String itemNumber = itemNumber_example; // String | The item number.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.
        try {
            array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#pricelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // The primary key of the item master record.' (optional)
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *cardsID = 56; // The primary key of the card record (optional)
String *itemNumber = itemNumber_example; // The item number. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the Individual's last name. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Return pricing of a specific item for a specific customer.
[apiInstance pricelistGetWith:baseStockID
    cardIdentification:cardIdentification
    cardsID:cardsID
    itemNumber:itemNumber
    lastName:lastName
              completionHandler: ^(array[pricelistitem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} The primary key of the item master record.'
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'cardsID': 56, // {{Integer}} The primary key of the card record
  'itemNumber': itemNumber_example, // {{String}} The item number.
  'lastName': lastName_example // {{String}} The company name if the card record represents a company, otherwise the Individual's last name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pricelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pricelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | The primary key of the item master record.' (optional) 
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var cardsID = 56;  // Integer | The primary key of the card record (optional) 
            var itemNumber = itemNumber_example;  // String | The item number. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the Individual's last name. (optional) 

            try
            {
                // Return pricing of a specific item for a specific customer.
                array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.pricelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | The primary key of the item master record.'
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$cardsID = 56; // Integer | The primary key of the card record
$itemNumber = itemNumber_example; // String | The item number.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.

try {
    $result = $api_instance->pricelistGet($baseStockID, $cardIdentification, $cardsID, $itemNumber, $lastName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->pricelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | The primary key of the item master record.'
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $cardsID = 56; # Integer | The primary key of the card record
my $itemNumber = itemNumber_example; # String | The item number.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the Individual's last name.

eval { 
    my $result = $api_instance->pricelistGet(baseStockID => $baseStockID, cardIdentification => $cardIdentification, cardsID => $cardsID, itemNumber => $itemNumber, lastName => $lastName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->pricelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | The primary key of the item master record.' (optional)
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
cardsID = 56 # Integer | The primary key of the card record (optional)
itemNumber = itemNumber_example # String | The item number. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the Individual's last name. (optional)

try: 
    # Return pricing of a specific item for a specific customer.
    api_response = api_instance.pricelist_get(baseStockID=baseStockID, cardIdentification=cardIdentification, cardsID=cardsID, itemNumber=itemNumber, lastName=lastName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->pricelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
The primary key of the item master record.'
CardIdentification
String
User defined unique card ID.
CardsID
Integer
The primary key of the card record
ItemNumber
String
The item number.
LastName
String
The company name if the card record represents a company, otherwise the Individual's last name.

Responses

Status: 200 - OK


salelistGet

Returns a list of sales

The salelist returns list of sales.


/salelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salelist?EntryDate=&InvoiceNumber=&MYOBSalesID=&MYOBShipMethodID=&MYOBTermsID=&PromiseDate=&PurchaseOrder=&SRN=&SaleDate=&SalesID=&TypeID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *entryDate = entryDate_example; // An date of entry for a specified sale (optional)
String *invoiceNumber = invoiceNumber_example; // The sale invoice number. (optional)
Integer *mYOBSalesID = 56; // The primary key value for the MYOB sale record. (optional)
Integer *mYOBShipMethodID = 56; // the primary key value for the MYOB shipping method record. (optional)
Integer *mYOBTermsID = 56; // The primary key value for the MYOB sale terms record. (optional)
String *promiseDate = promiseDate_example; // The promise date on the sale invoice (optional)
String *purchaseOrder = purchaseOrder_example; // The purchase order number attached to a sale. (optional)
String *sRN = sRN_example; // The serial number of an item attached to a specific sale. (optional)
String *saleDate = saleDate_example; // The date the sale was filed for a customer. (optional)
Integer *salesID = 56; // The primary key value for a sale record. (optional)
Integer *typeID = 56; // The primary key value for a sale's type record. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns a list of sales
[apiInstance salelistGetWith:entryDate
    invoiceNumber:invoiceNumber
    mYOBSalesID:mYOBSalesID
    mYOBShipMethodID:mYOBShipMethodID
    mYOBTermsID:mYOBTermsID
    promiseDate:promiseDate
    purchaseOrder:purchaseOrder
    sRN:sRN
    saleDate:saleDate
    salesID:salesID
    typeID:typeID
              completionHandler: ^(salelist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'entryDate': entryDate_example, // {{String}} An date of entry for a specified sale
  'invoiceNumber': invoiceNumber_example, // {{String}} The sale invoice number.
  'mYOBSalesID': 56, // {{Integer}} The primary key value for the MYOB sale record.
  'mYOBShipMethodID': 56, // {{Integer}} the primary key value for the MYOB shipping method record.
  'mYOBTermsID': 56, // {{Integer}} The primary key value for the MYOB sale terms record.
  'promiseDate': promiseDate_example, // {{String}} The promise date on the sale invoice
  'purchaseOrder': purchaseOrder_example, // {{String}} The purchase order number attached to a sale.
  'sRN': sRN_example, // {{String}} The serial number of an item attached to a specific sale.
  'saleDate': saleDate_example, // {{String}} The date the sale was filed for a customer.
  'salesID': 56, // {{Integer}} The primary key value for a sale record.
  'typeID': 56 // {{Integer}} The primary key value for a sale's type record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var entryDate = entryDate_example;  // String | An date of entry for a specified sale (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The sale invoice number. (optional) 
            var mYOBSalesID = 56;  // Integer | The primary key value for the MYOB sale record. (optional) 
            var mYOBShipMethodID = 56;  // Integer | the primary key value for the MYOB shipping method record. (optional) 
            var mYOBTermsID = 56;  // Integer | The primary key value for the MYOB sale terms record. (optional) 
            var promiseDate = promiseDate_example;  // String | The promise date on the sale invoice (optional) 
            var purchaseOrder = purchaseOrder_example;  // String | The purchase order number attached to a sale. (optional) 
            var sRN = sRN_example;  // String | The serial number of an item attached to a specific sale. (optional) 
            var saleDate = saleDate_example;  // String | The date the sale was filed for a customer. (optional) 
            var salesID = 56;  // Integer | The primary key value for a sale record. (optional) 
            var typeID = 56;  // Integer | The primary key value for a sale's type record. (optional) 

            try
            {
                // Returns a list of sales
                salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$entryDate = entryDate_example; // String | An date of entry for a specified sale
$invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
$mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
$mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
$mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
$promiseDate = promiseDate_example; // String | The promise date on the sale invoice
$purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
$sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
$saleDate = saleDate_example; // String | The date the sale was filed for a customer.
$salesID = 56; // Integer | The primary key value for a sale record.
$typeID = 56; // Integer | The primary key value for a sale's type record.

try {
    $result = $api_instance->salelistGet($entryDate, $invoiceNumber, $mYOBSalesID, $mYOBShipMethodID, $mYOBTermsID, $promiseDate, $purchaseOrder, $sRN, $saleDate, $salesID, $typeID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $entryDate = entryDate_example; # String | An date of entry for a specified sale
my $invoiceNumber = invoiceNumber_example; # String | The sale invoice number.
my $mYOBSalesID = 56; # Integer | The primary key value for the MYOB sale record.
my $mYOBShipMethodID = 56; # Integer | the primary key value for the MYOB shipping method record.
my $mYOBTermsID = 56; # Integer | The primary key value for the MYOB sale terms record.
my $promiseDate = promiseDate_example; # String | The promise date on the sale invoice
my $purchaseOrder = purchaseOrder_example; # String | The purchase order number attached to a sale.
my $sRN = sRN_example; # String | The serial number of an item attached to a specific sale.
my $saleDate = saleDate_example; # String | The date the sale was filed for a customer.
my $salesID = 56; # Integer | The primary key value for a sale record.
my $typeID = 56; # Integer | The primary key value for a sale's type record.

eval { 
    my $result = $api_instance->salelistGet(entryDate => $entryDate, invoiceNumber => $invoiceNumber, mYOBSalesID => $mYOBSalesID, mYOBShipMethodID => $mYOBShipMethodID, mYOBTermsID => $mYOBTermsID, promiseDate => $promiseDate, purchaseOrder => $purchaseOrder, sRN => $sRN, saleDate => $saleDate, salesID => $salesID, typeID => $typeID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
entryDate = entryDate_example # String | An date of entry for a specified sale (optional)
invoiceNumber = invoiceNumber_example # String | The sale invoice number. (optional)
mYOBSalesID = 56 # Integer | The primary key value for the MYOB sale record. (optional)
mYOBShipMethodID = 56 # Integer | the primary key value for the MYOB shipping method record. (optional)
mYOBTermsID = 56 # Integer | The primary key value for the MYOB sale terms record. (optional)
promiseDate = promiseDate_example # String | The promise date on the sale invoice (optional)
purchaseOrder = purchaseOrder_example # String | The purchase order number attached to a sale. (optional)
sRN = sRN_example # String | The serial number of an item attached to a specific sale. (optional)
saleDate = saleDate_example # String | The date the sale was filed for a customer. (optional)
salesID = 56 # Integer | The primary key value for a sale record. (optional)
typeID = 56 # Integer | The primary key value for a sale's type record. (optional)

try: 
    # Returns a list of sales
    api_response = api_instance.salelist_get(entryDate=entryDate, invoiceNumber=invoiceNumber, mYOBSalesID=mYOBSalesID, mYOBShipMethodID=mYOBShipMethodID, mYOBTermsID=mYOBTermsID, promiseDate=promiseDate, purchaseOrder=purchaseOrder, sRN=sRN, saleDate=saleDate, salesID=salesID, typeID=typeID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
EntryDate
String
An date of entry for a specified sale
InvoiceNumber
String
The sale invoice number.
MYOBSalesID
Integer
The primary key value for the MYOB sale record.
MYOBShipMethodID
Integer
the primary key value for the MYOB shipping method record.
MYOBTermsID
Integer
The primary key value for the MYOB sale terms record.
PromiseDate
String
The promise date on the sale invoice
PurchaseOrder
String
The purchase order number attached to a sale.
SRN
String
The serial number of an item attached to a specific sale.
SaleDate
String
The date the sale was filed for a customer.
SalesID
Integer
The primary key value for a sale record.
TypeID
Integer
The primary key value for a sale's type record.

Responses

Status: 200 - OK


salesGet

Returns information about the specified sale.

The sales endpoint returns header sale order details with child sale line items. The primary key for sale orders is the INVOICE NUMBER and SRN together or saleid. Orders with the same SRN are related due to the backordering and split shipping of lines. Sale Returns can also be read using this endpoint and will usually have the same Invoice Number as the original Sale Invoice. The endpoint is used to obtain detailed information regarding customer sales orders and returns.


/sales

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/sales?EntryDate=&InvoiceNumber=&MYOBSalesID=&MYOBShipMethodID=&MYOBTermsID=&PromiseDate=&PurchaseOrder=&SRN=&SaleDate=&SalesID=&TypeID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *entryDate = entryDate_example; // An date of entry for a specified sale (optional)
String *invoiceNumber = invoiceNumber_example; // The sale invoice number. (optional)
Integer *mYOBSalesID = 56; // The primary key value for the MYOB sale record. (optional)
Integer *mYOBShipMethodID = 56; // the primary key value for the MYOB shipping method record. (optional)
Integer *mYOBTermsID = 56; // The primary key value for the MYOB sale terms record. (optional)
String *promiseDate = promiseDate_example; // The promise date on the sale invoice (optional)
String *purchaseOrder = purchaseOrder_example; // The purchase order number attached to a sale. (optional)
String *sRN = sRN_example; // The serial number of an item attached to a specific sale. (optional)
String *saleDate = saleDate_example; // The date the sale was filed for a customer. (optional)
Integer *salesID = 56; // The primary key value for a sale record. (optional)
Integer *typeID = 56; // The primary key value for a sale's type record. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified sale.
[apiInstance salesGetWith:entryDate
    invoiceNumber:invoiceNumber
    mYOBSalesID:mYOBSalesID
    mYOBShipMethodID:mYOBShipMethodID
    mYOBTermsID:mYOBTermsID
    promiseDate:promiseDate
    purchaseOrder:purchaseOrder
    sRN:sRN
    saleDate:saleDate
    salesID:salesID
    typeID:typeID
              completionHandler: ^(salesget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'entryDate': entryDate_example, // {{String}} An date of entry for a specified sale
  'invoiceNumber': invoiceNumber_example, // {{String}} The sale invoice number.
  'mYOBSalesID': 56, // {{Integer}} The primary key value for the MYOB sale record.
  'mYOBShipMethodID': 56, // {{Integer}} the primary key value for the MYOB shipping method record.
  'mYOBTermsID': 56, // {{Integer}} The primary key value for the MYOB sale terms record.
  'promiseDate': promiseDate_example, // {{String}} The promise date on the sale invoice
  'purchaseOrder': purchaseOrder_example, // {{String}} The purchase order number attached to a sale.
  'sRN': sRN_example, // {{String}} The serial number of an item attached to a specific sale.
  'saleDate': saleDate_example, // {{String}} The date the sale was filed for a customer.
  'salesID': 56, // {{Integer}} The primary key value for a sale record.
  'typeID': 56 // {{Integer}} The primary key value for a sale's type record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salesGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var entryDate = entryDate_example;  // String | An date of entry for a specified sale (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The sale invoice number. (optional) 
            var mYOBSalesID = 56;  // Integer | The primary key value for the MYOB sale record. (optional) 
            var mYOBShipMethodID = 56;  // Integer | the primary key value for the MYOB shipping method record. (optional) 
            var mYOBTermsID = 56;  // Integer | The primary key value for the MYOB sale terms record. (optional) 
            var promiseDate = promiseDate_example;  // String | The promise date on the sale invoice (optional) 
            var purchaseOrder = purchaseOrder_example;  // String | The purchase order number attached to a sale. (optional) 
            var sRN = sRN_example;  // String | The serial number of an item attached to a specific sale. (optional) 
            var saleDate = saleDate_example;  // String | The date the sale was filed for a customer. (optional) 
            var salesID = 56;  // Integer | The primary key value for a sale record. (optional) 
            var typeID = 56;  // Integer | The primary key value for a sale's type record. (optional) 

            try
            {
                // Returns information about the specified sale.
                salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$entryDate = entryDate_example; // String | An date of entry for a specified sale
$invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
$mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
$mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
$mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
$promiseDate = promiseDate_example; // String | The promise date on the sale invoice
$purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
$sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
$saleDate = saleDate_example; // String | The date the sale was filed for a customer.
$salesID = 56; // Integer | The primary key value for a sale record.
$typeID = 56; // Integer | The primary key value for a sale's type record.

try {
    $result = $api_instance->salesGet($entryDate, $invoiceNumber, $mYOBSalesID, $mYOBShipMethodID, $mYOBTermsID, $promiseDate, $purchaseOrder, $sRN, $saleDate, $salesID, $typeID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $entryDate = entryDate_example; # String | An date of entry for a specified sale
my $invoiceNumber = invoiceNumber_example; # String | The sale invoice number.
my $mYOBSalesID = 56; # Integer | The primary key value for the MYOB sale record.
my $mYOBShipMethodID = 56; # Integer | the primary key value for the MYOB shipping method record.
my $mYOBTermsID = 56; # Integer | The primary key value for the MYOB sale terms record.
my $promiseDate = promiseDate_example; # String | The promise date on the sale invoice
my $purchaseOrder = purchaseOrder_example; # String | The purchase order number attached to a sale.
my $sRN = sRN_example; # String | The serial number of an item attached to a specific sale.
my $saleDate = saleDate_example; # String | The date the sale was filed for a customer.
my $salesID = 56; # Integer | The primary key value for a sale record.
my $typeID = 56; # Integer | The primary key value for a sale's type record.

eval { 
    my $result = $api_instance->salesGet(entryDate => $entryDate, invoiceNumber => $invoiceNumber, mYOBSalesID => $mYOBSalesID, mYOBShipMethodID => $mYOBShipMethodID, mYOBTermsID => $mYOBTermsID, promiseDate => $promiseDate, purchaseOrder => $purchaseOrder, sRN => $sRN, saleDate => $saleDate, salesID => $salesID, typeID => $typeID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
entryDate = entryDate_example # String | An date of entry for a specified sale (optional)
invoiceNumber = invoiceNumber_example # String | The sale invoice number. (optional)
mYOBSalesID = 56 # Integer | The primary key value for the MYOB sale record. (optional)
mYOBShipMethodID = 56 # Integer | the primary key value for the MYOB shipping method record. (optional)
mYOBTermsID = 56 # Integer | The primary key value for the MYOB sale terms record. (optional)
promiseDate = promiseDate_example # String | The promise date on the sale invoice (optional)
purchaseOrder = purchaseOrder_example # String | The purchase order number attached to a sale. (optional)
sRN = sRN_example # String | The serial number of an item attached to a specific sale. (optional)
saleDate = saleDate_example # String | The date the sale was filed for a customer. (optional)
salesID = 56 # Integer | The primary key value for a sale record. (optional)
typeID = 56 # Integer | The primary key value for a sale's type record. (optional)

try: 
    # Returns information about the specified sale.
    api_response = api_instance.sales_get(entryDate=entryDate, invoiceNumber=invoiceNumber, mYOBSalesID=mYOBSalesID, mYOBShipMethodID=mYOBShipMethodID, mYOBTermsID=mYOBTermsID, promiseDate=promiseDate, purchaseOrder=purchaseOrder, sRN=sRN, saleDate=saleDate, salesID=salesID, typeID=typeID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesGet: %s\n" % e)

Parameters

Query parameters
Name Description
EntryDate
String
An date of entry for a specified sale
InvoiceNumber
String
The sale invoice number.
MYOBSalesID
Integer
The primary key value for the MYOB sale record.
MYOBShipMethodID
Integer
the primary key value for the MYOB shipping method record.
MYOBTermsID
Integer
The primary key value for the MYOB sale terms record.
PromiseDate
String
The promise date on the sale invoice
PurchaseOrder
String
The purchase order number attached to a sale.
SRN
String
The serial number of an item attached to a specific sale.
SaleDate
String
The date the sale was filed for a customer.
SalesID
Integer
The primary key value for a sale record.
TypeID
Integer
The primary key value for a sale's type record.

Responses

Status: 200 - OK


salesqueueGet

Returns the current sale queue information.


/salesqueue

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salesqueue?DELETE=&FLUSH=&FLUSH_WAIT=&UNLOCK=&WITHLOCK="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String dELETE = dELETE_example; // String | Delete the containing JSON queue files.
        String fLUSH = fLUSH_example; // String | Remove the lock.
        String fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
        String uNLOCK = uNLOCK_example; // String | Unlock the folder
        String wITHLOCK = wITHLOCK_example; // String | Lock the folder.
        try {
            salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueueGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String dELETE = dELETE_example; // String | Delete the containing JSON queue files.
        String fLUSH = fLUSH_example; // String | Remove the lock.
        String fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
        String uNLOCK = uNLOCK_example; // String | Unlock the folder
        String wITHLOCK = wITHLOCK_example; // String | Lock the folder.
        try {
            salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueueGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *dELETE = dELETE_example; // Delete the containing JSON queue files. (optional)
String *fLUSH = fLUSH_example; // Remove the lock. (optional)
String *fLUSHWAIT = fLUSHWAIT_example; // Wait. (optional)
String *uNLOCK = uNLOCK_example; // Unlock the folder (optional)
String *wITHLOCK = wITHLOCK_example; // Lock the folder. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns the current sale queue information.
[apiInstance salesqueueGetWith:dELETE
    fLUSH:fLUSH
    fLUSHWAIT:fLUSHWAIT
    uNLOCK:uNLOCK
    wITHLOCK:wITHLOCK
              completionHandler: ^(salesqueue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'dELETE': dELETE_example, // {{String}} Delete the containing JSON queue files.
  'fLUSH': fLUSH_example, // {{String}} Remove the lock.
  'fLUSHWAIT': fLUSHWAIT_example, // {{String}} Wait.
  'uNLOCK': uNLOCK_example, // {{String}} Unlock the folder
  'wITHLOCK': wITHLOCK_example // {{String}} Lock the folder.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salesqueueGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salesqueueGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var dELETE = dELETE_example;  // String | Delete the containing JSON queue files. (optional) 
            var fLUSH = fLUSH_example;  // String | Remove the lock. (optional) 
            var fLUSHWAIT = fLUSHWAIT_example;  // String | Wait. (optional) 
            var uNLOCK = uNLOCK_example;  // String | Unlock the folder (optional) 
            var wITHLOCK = wITHLOCK_example;  // String | Lock the folder. (optional) 

            try
            {
                // Returns the current sale queue information.
                salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesqueueGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$dELETE = dELETE_example; // String | Delete the containing JSON queue files.
$fLUSH = fLUSH_example; // String | Remove the lock.
$fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
$uNLOCK = uNLOCK_example; // String | Unlock the folder
$wITHLOCK = wITHLOCK_example; // String | Lock the folder.

try {
    $result = $api_instance->salesqueueGet($dELETE, $fLUSH, $fLUSHWAIT, $uNLOCK, $wITHLOCK);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesqueueGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $dELETE = dELETE_example; # String | Delete the containing JSON queue files.
my $fLUSH = fLUSH_example; # String | Remove the lock.
my $fLUSHWAIT = fLUSHWAIT_example; # String | Wait.
my $uNLOCK = uNLOCK_example; # String | Unlock the folder
my $wITHLOCK = wITHLOCK_example; # String | Lock the folder.

eval { 
    my $result = $api_instance->salesqueueGet(dELETE => $dELETE, fLUSH => $fLUSH, fLUSHWAIT => $fLUSHWAIT, uNLOCK => $uNLOCK, wITHLOCK => $wITHLOCK);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesqueueGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
dELETE = dELETE_example # String | Delete the containing JSON queue files. (optional)
fLUSH = fLUSH_example # String | Remove the lock. (optional)
fLUSHWAIT = fLUSHWAIT_example # String | Wait. (optional)
uNLOCK = uNLOCK_example # String | Unlock the folder (optional)
wITHLOCK = wITHLOCK_example # String | Lock the folder. (optional)

try: 
    # Returns the current sale queue information.
    api_response = api_instance.salesqueue_get(dELETE=dELETE, fLUSH=fLUSH, fLUSHWAIT=fLUSHWAIT, uNLOCK=uNLOCK, wITHLOCK=wITHLOCK)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesqueueGet: %s\n" % e)

Parameters

Query parameters
Name Description
DELETE
String
Delete the containing JSON queue files.
FLUSH
String
Remove the lock.
FLUSH_WAIT
String
Wait.
UNLOCK
String
Unlock the folder
WITHLOCK
String
Lock the folder.

Responses

Status: 200 - OK


salesqueuecountGet

Returns a count of sale queue items.


/salesqueuecount

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salesqueuecount"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            salesqueuecount result = apiInstance.salesqueuecountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueuecountGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            salesqueuecount result = apiInstance.salesqueuecountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueuecountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns a count of sale queue items.
[apiInstance salesqueuecountGetWithCompletionHandler: 
              ^(salesqueuecount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salesqueuecountGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salesqueuecountGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();

            try
            {
                // Returns a count of sale queue items.
                salesqueuecount result = apiInstance.salesqueuecountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesqueuecountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();

try {
    $result = $api_instance->salesqueuecountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesqueuecountGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();

eval { 
    my $result = $api_instance->salesqueuecountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesqueuecountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()

try: 
    # Returns a count of sale queue items.
    api_response = api_instance.salesqueuecount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesqueuecountGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


searchInventoryList

Returns current summary stock levels per basestockid.

The InventoryList endpoint is intended to enable queries on the item list returning current summary stock levels per basestockid. This endpoint will accept only ONE locationid parameter e.g. locationid = 5 or NO locationid which returns the total summary stock level for the entire inventory database.


/inventoryList

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/inventoryList?BaseStockID=&ItemNumber=&LocationID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        try {
            array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#searchInventoryList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        try {
            array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#searchInventoryList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *locationID = 56; // Pass by primary key of an items location. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns current summary stock levels per basestockid.
[apiInstance searchInventoryListWith:baseStockID
    itemNumber:itemNumber
    locationID:locationID
              completionHandler: ^(array[inventoryList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'locationID': 56 // {{Integer}} Pass by primary key of an items location.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchInventoryList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchInventoryListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var locationID = 56;  // Integer | Pass by primary key of an items location. (optional) 

            try
            {
                // Returns current summary stock levels per basestockid.
                array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.searchInventoryList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$locationID = 56; // Integer | Pass by primary key of an items location.

try {
    $result = $api_instance->searchInventoryList($baseStockID, $itemNumber, $locationID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->searchInventoryList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $locationID = 56; # Integer | Pass by primary key of an items location.

eval { 
    my $result = $api_instance->searchInventoryList(baseStockID => $baseStockID, itemNumber => $itemNumber, locationID => $locationID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->searchInventoryList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
locationID = 56 # Integer | Pass by primary key of an items location. (optional)

try: 
    # Returns current summary stock levels per basestockid.
    api_response = api_instance.search_inventory_list(baseStockID=baseStockID, itemNumber=itemNumber, locationID=locationID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->searchInventoryList: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.
LocationID
Integer
Pass by primary key of an items location.

Responses

Status: 200 - OK


specialpricingGet

Returns information about the specified special price list.

The specialpricing endpoint is required to enable client applications to determine if any agreed or negotiated price RULES exist for a particular customer or customer group. This endpoint does not CALCULATE the price for the contact/item but returns the base rules that should be applied in order to determines a contacts pricing. If no results are returned then no rules apply - if an *ALL CUSTOMERS rule is active this will be returned for every GET Query.


/specialpricing

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/specialpricing?basestockid=&contactid=&isinactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer basestockid = 56; // Integer | The primary key of the item master record.
        Integer contactid = 56; // Integer | The primary key of the stored contact record
        Boolean isinactive = true; // Boolean | is the list active.
        try {
            specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#specialpricingGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer basestockid = 56; // Integer | The primary key of the item master record.
        Integer contactid = 56; // Integer | The primary key of the stored contact record
        Boolean isinactive = true; // Boolean | is the list active.
        try {
            specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#specialpricingGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *basestockid = 56; // The primary key of the item master record. (optional)
Integer *contactid = 56; // The primary key of the stored contact record (optional)
Boolean *isinactive = true; // is the list active. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified special price list.
[apiInstance specialpricingGetWith:basestockid
    contactid:contactid
    isinactive:isinactive
              completionHandler: ^(specialpricingget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'basestockid': 56, // {{Integer}} The primary key of the item master record.
  'contactid': 56, // {{Integer}} The primary key of the stored contact record
  'isinactive': true // {{Boolean}} is the list active.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.specialpricingGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class specialpricingGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var basestockid = 56;  // Integer | The primary key of the item master record. (optional) 
            var contactid = 56;  // Integer | The primary key of the stored contact record (optional) 
            var isinactive = true;  // Boolean | is the list active. (optional) 

            try
            {
                // Returns information about the specified special price list.
                specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.specialpricingGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$basestockid = 56; // Integer | The primary key of the item master record.
$contactid = 56; // Integer | The primary key of the stored contact record
$isinactive = true; // Boolean | is the list active.

try {
    $result = $api_instance->specialpricingGet($basestockid, $contactid, $isinactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->specialpricingGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $basestockid = 56; # Integer | The primary key of the item master record.
my $contactid = 56; # Integer | The primary key of the stored contact record
my $isinactive = true; # Boolean | is the list active.

eval { 
    my $result = $api_instance->specialpricingGet(basestockid => $basestockid, contactid => $contactid, isinactive => $isinactive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->specialpricingGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
basestockid = 56 # Integer | The primary key of the item master record. (optional)
contactid = 56 # Integer | The primary key of the stored contact record (optional)
isinactive = true # Boolean | is the list active. (optional)

try: 
    # Returns information about the specified special price list.
    api_response = api_instance.specialpricing_get(basestockid=basestockid, contactid=contactid, isinactive=isinactive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->specialpricingGet: %s\n" % e)

Parameters

Query parameters
Name Description
basestockid
Integer
The primary key of the item master record.
contactid
Integer
The primary key of the stored contact record
isinactive
Boolean
is the list active.

Responses

Status: 200 - OK


statusGet

Returns order status information.

The status request returns information about the specified sale and transfers.


/status

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/status?PRN=&QID=&SalesID=&ShipReference=&TransfersID=&InvoiceNum=&OrderNum="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String pRN = pRN_example; // String | The payment reference number of a purchase.
        String qID = qID_example; // String | The transaction queue identification number.
        Integer salesID = 56; // Integer | The primary key value of a sale.
        String shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
        Integer transfersID = 56; // Integer | The primary key value for a transfer record.
        String invoiceNum = invoiceNum_example; // String | The sale invoice number.
        String orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.
        try {
            orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#statusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String pRN = pRN_example; // String | The payment reference number of a purchase.
        String qID = qID_example; // String | The transaction queue identification number.
        Integer salesID = 56; // Integer | The primary key value of a sale.
        String shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
        Integer transfersID = 56; // Integer | The primary key value for a transfer record.
        String invoiceNum = invoiceNum_example; // String | The sale invoice number.
        String orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.
        try {
            orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#statusGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pRN = pRN_example; // The payment reference number of a purchase. (optional)
String *qID = qID_example; // The transaction queue identification number. (optional)
Integer *salesID = 56; // The primary key value of a sale. (optional)
String *shipReference = shipReference_example; // A valid value is the valid ShipReference, that you used for the REST call. (optional)
Integer *transfersID = 56; // The primary key value for a transfer record. (optional)
String *invoiceNum = invoiceNum_example; // The sale invoice number. (optional)
String *orderNum = orderNum_example; // A valid value is the valid ordernum, that you used for the REST call. (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns order status information.
[apiInstance statusGetWith:pRN
    qID:qID
    salesID:salesID
    shipReference:shipReference
    transfersID:transfersID
    invoiceNum:invoiceNum
    orderNum:orderNum
              completionHandler: ^(orderstatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'pRN': pRN_example, // {{String}} The payment reference number of a purchase.
  'qID': qID_example, // {{String}} The transaction queue identification number.
  'salesID': 56, // {{Integer}} The primary key value of a sale.
  'shipReference': shipReference_example, // {{String}} A valid value is the valid ShipReference, that you used for the REST call.
  'transfersID': 56, // {{Integer}} The primary key value for a transfer record.
  'invoiceNum': invoiceNum_example, // {{String}} The sale invoice number.
  'orderNum': orderNum_example // {{String}} A valid value is the valid ordernum, that you used for the REST call.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.statusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class statusGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var pRN = pRN_example;  // String | The payment reference number of a purchase. (optional) 
            var qID = qID_example;  // String | The transaction queue identification number. (optional) 
            var salesID = 56;  // Integer | The primary key value of a sale. (optional) 
            var shipReference = shipReference_example;  // String | A valid value is the valid ShipReference, that you used for the REST call. (optional) 
            var transfersID = 56;  // Integer | The primary key value for a transfer record. (optional) 
            var invoiceNum = invoiceNum_example;  // String | The sale invoice number. (optional) 
            var orderNum = orderNum_example;  // String | A valid value is the valid ordernum, that you used for the REST call. (optional) 

            try
            {
                // Returns order status information.
                orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.statusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$pRN = pRN_example; // String | The payment reference number of a purchase.
$qID = qID_example; // String | The transaction queue identification number.
$salesID = 56; // Integer | The primary key value of a sale.
$shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
$transfersID = 56; // Integer | The primary key value for a transfer record.
$invoiceNum = invoiceNum_example; // String | The sale invoice number.
$orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.

try {
    $result = $api_instance->statusGet($pRN, $qID, $salesID, $shipReference, $transfersID, $invoiceNum, $orderNum);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->statusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $pRN = pRN_example; # String | The payment reference number of a purchase.
my $qID = qID_example; # String | The transaction queue identification number.
my $salesID = 56; # Integer | The primary key value of a sale.
my $shipReference = shipReference_example; # String | A valid value is the valid ShipReference, that you used for the REST call.
my $transfersID = 56; # Integer | The primary key value for a transfer record.
my $invoiceNum = invoiceNum_example; # String | The sale invoice number.
my $orderNum = orderNum_example; # String | A valid value is the valid ordernum, that you used for the REST call.

eval { 
    my $result = $api_instance->statusGet(pRN => $pRN, qID => $qID, salesID => $salesID, shipReference => $shipReference, transfersID => $transfersID, invoiceNum => $invoiceNum, orderNum => $orderNum);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->statusGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
pRN = pRN_example # String | The payment reference number of a purchase. (optional)
qID = qID_example # String | The transaction queue identification number. (optional)
salesID = 56 # Integer | The primary key value of a sale. (optional)
shipReference = shipReference_example # String | A valid value is the valid ShipReference, that you used for the REST call. (optional)
transfersID = 56 # Integer | The primary key value for a transfer record. (optional)
invoiceNum = invoiceNum_example # String | The sale invoice number. (optional)
orderNum = orderNum_example # String | A valid value is the valid ordernum, that you used for the REST call. (optional)

try: 
    # Returns order status information.
    api_response = api_instance.status_get(pRN=pRN, qID=qID, salesID=salesID, shipReference=shipReference, transfersID=transfersID, invoiceNum=invoiceNum, orderNum=orderNum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->statusGet: %s\n" % e)

Parameters

Query parameters
Name Description
PRN
String
The payment reference number of a purchase.
QID
String
The transaction queue identification number.
SalesID
Integer
The primary key value of a sale.
ShipReference
String
A valid value is the valid ShipReference, that you used for the REST call.
TransfersID
Integer
The primary key value for a transfer record.
InvoiceNum
String
The sale invoice number.
OrderNum
String
A valid value is the valid ordernum, that you used for the REST call.

Responses

Status: 200 - OK


timestampGet

Returns time information about the specified server.

Returns information about the specified server.


/timestamp

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/timestamp"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            inline_response_200 result = apiInstance.timestampGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#timestampGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            inline_response_200 result = apiInstance.timestampGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#timestampGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns time information about the specified server.
[apiInstance timestampGetWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.timestampGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class timestampGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();

            try
            {
                // Returns time information about the specified server.
                inline_response_200 result = apiInstance.timestampGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.timestampGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();

try {
    $result = $api_instance->timestampGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->timestampGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();

eval { 
    my $result = $api_instance->timestampGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->timestampGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()

try: 
    # Returns time information about the specified server.
    api_response = api_instance.timestamp_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->timestampGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


transferlistGet

Returns transfer list information

The Transferlist returns list of transfers.


/transferlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/transferlist?ContactName=&DstLocationID=&MyobShipMethodID=&Priority=&SrcLocationID=&StatusID=&TRN=&TransfersID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transferlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transferlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *contactName = contactName_example; // Contact name of the card attached to the transfer. (optional)
Integer *dstLocationID = 56; // the primary key value of the destination location. (optional)
Integer *myobShipMethodID = 56; // The primary key value of the MYOB ship method. (optional)
Integer *priority = 56; // Priority level (optional)
Integer *srcLocationID = 56; // The primary key value of the source location. (optional)
Integer *statusID = 56; // the primary key value of the status record. (optional)
String *tRN = tRN_example; // The transfer registration number. (optional)
Integer *transfersID = 56; // The primary key value of the transfer record/ (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns transfer list information
[apiInstance transferlistGetWith:contactName
    dstLocationID:dstLocationID
    myobShipMethodID:myobShipMethodID
    priority:priority
    srcLocationID:srcLocationID
    statusID:statusID
    tRN:tRN
    transfersID:transfersID
              completionHandler: ^(transferlist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'contactName': contactName_example, // {{String}} Contact name of the card attached to the transfer.
  'dstLocationID': 56, // {{Integer}} the primary key value of the destination location.
  'myobShipMethodID': 56, // {{Integer}} The primary key value of the MYOB ship method.
  'priority': 56, // {{Integer}} Priority level
  'srcLocationID': 56, // {{Integer}} The primary key value of the source location.
  'statusID': 56, // {{Integer}} the primary key value of the status record.
  'tRN': tRN_example, // {{String}} The transfer registration number.
  'transfersID': 56 // {{Integer}} The primary key value of the transfer record/
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transferlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transferlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var contactName = contactName_example;  // String | Contact name of the card attached to the transfer. (optional) 
            var dstLocationID = 56;  // Integer | the primary key value of the destination location. (optional) 
            var myobShipMethodID = 56;  // Integer | The primary key value of the MYOB ship method. (optional) 
            var priority = 56;  // Integer | Priority level (optional) 
            var srcLocationID = 56;  // Integer | The primary key value of the source location. (optional) 
            var statusID = 56;  // Integer | the primary key value of the status record. (optional) 
            var tRN = tRN_example;  // String | The transfer registration number. (optional) 
            var transfersID = 56;  // Integer | The primary key value of the transfer record/ (optional) 

            try
            {
                // Returns transfer list information
                transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.transferlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$contactName = contactName_example; // String | Contact name of the card attached to the transfer.
$dstLocationID = 56; // Integer | the primary key value of the destination location.
$myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
$priority = 56; // Integer | Priority level
$srcLocationID = 56; // Integer | The primary key value of the source location.
$statusID = 56; // Integer | the primary key value of the status record.
$tRN = tRN_example; // String | The transfer registration number.
$transfersID = 56; // Integer | The primary key value of the transfer record/

try {
    $result = $api_instance->transferlistGet($contactName, $dstLocationID, $myobShipMethodID, $priority, $srcLocationID, $statusID, $tRN, $transfersID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->transferlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $contactName = contactName_example; # String | Contact name of the card attached to the transfer.
my $dstLocationID = 56; # Integer | the primary key value of the destination location.
my $myobShipMethodID = 56; # Integer | The primary key value of the MYOB ship method.
my $priority = 56; # Integer | Priority level
my $srcLocationID = 56; # Integer | The primary key value of the source location.
my $statusID = 56; # Integer | the primary key value of the status record.
my $tRN = tRN_example; # String | The transfer registration number.
my $transfersID = 56; # Integer | The primary key value of the transfer record/

eval { 
    my $result = $api_instance->transferlistGet(contactName => $contactName, dstLocationID => $dstLocationID, myobShipMethodID => $myobShipMethodID, priority => $priority, srcLocationID => $srcLocationID, statusID => $statusID, tRN => $tRN, transfersID => $transfersID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->transferlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
contactName = contactName_example # String | Contact name of the card attached to the transfer. (optional)
dstLocationID = 56 # Integer | the primary key value of the destination location. (optional)
myobShipMethodID = 56 # Integer | The primary key value of the MYOB ship method. (optional)
priority = 56 # Integer | Priority level (optional)
srcLocationID = 56 # Integer | The primary key value of the source location. (optional)
statusID = 56 # Integer | the primary key value of the status record. (optional)
tRN = tRN_example # String | The transfer registration number. (optional)
transfersID = 56 # Integer | The primary key value of the transfer record/ (optional)

try: 
    # Returns transfer list information
    api_response = api_instance.transferlist_get(contactName=contactName, dstLocationID=dstLocationID, myobShipMethodID=myobShipMethodID, priority=priority, srcLocationID=srcLocationID, statusID=statusID, tRN=tRN, transfersID=transfersID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->transferlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
ContactName
String
Contact name of the card attached to the transfer.
DstLocationID
Integer
the primary key value of the destination location.
MyobShipMethodID
Integer
The primary key value of the MYOB ship method.
Priority
Integer
Priority level
SrcLocationID
Integer
The primary key value of the source location.
StatusID
Integer
the primary key value of the status record.
TRN
String
The transfer registration number.
TransfersID
Integer
The primary key value of the transfer record/

Responses

Status: 200 - OK


transfersGet

Returns information about the specified transfers.

The transfers request returns information about the specified transfer.


/transfers

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/transfers?ContactName=&CreateDate=&DstLocationID=&MyobShipMethodID=&Priority=&RecordDate=&SrcLocationID=&StatusID=&TRN=&TransfersID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

import java.io.File;
import java.util.*;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        String createDate = createDate_example; // String | Create date of the transfer entry.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer recordDate = 56; // Integer | The date a transfer entry was recorded.
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transfersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        String createDate = createDate_example; // String | Create date of the transfer entry.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer recordDate = 56; // Integer | The date a transfer entry was recorded.
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transfersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *contactName = contactName_example; // Contact name of the card attached to the transfer. (optional)
String *createDate = createDate_example; // Create date of the transfer entry. (optional)
Integer *dstLocationID = 56; // the primary key value of the destination location. (optional)
Integer *myobShipMethodID = 56; // The primary key value of the MYOB ship method. (optional)
Integer *priority = 56; // Priority level (optional)
Integer *recordDate = 56; // The date a transfer entry was recorded. (optional)
Integer *srcLocationID = 56; // The primary key value of the source location. (optional)
Integer *statusID = 56; // the primary key value of the status record. (optional)
String *tRN = tRN_example; // The transfer registration number. (optional)
Integer *transfersID = 56; // The primary key value of the transfer record/ (optional)

GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];

// Returns information about the specified transfers.
[apiInstance transfersGetWith:contactName
    createDate:createDate
    dstLocationID:dstLocationID
    myobShipMethodID:myobShipMethodID
    priority:priority
    recordDate:recordDate
    srcLocationID:srcLocationID
    statusID:statusID
    tRN:tRN
    transfersID:transfersID
              completionHandler: ^(transfer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'contactName': contactName_example, // {{String}} Contact name of the card attached to the transfer.
  'createDate': createDate_example, // {{String}} Create date of the transfer entry.
  'dstLocationID': 56, // {{Integer}} the primary key value of the destination location.
  'myobShipMethodID': 56, // {{Integer}} The primary key value of the MYOB ship method.
  'priority': 56, // {{Integer}} Priority level
  'recordDate': 56, // {{Integer}} The date a transfer entry was recorded.
  'srcLocationID': 56, // {{Integer}} The primary key value of the source location.
  'statusID': 56, // {{Integer}} the primary key value of the status record.
  'tRN': tRN_example, // {{String}} The transfer registration number.
  'transfersID': 56 // {{Integer}} The primary key value of the transfer record/
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transfersGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transfersGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var contactName = contactName_example;  // String | Contact name of the card attached to the transfer. (optional) 
            var createDate = createDate_example;  // String | Create date of the transfer entry. (optional) 
            var dstLocationID = 56;  // Integer | the primary key value of the destination location. (optional) 
            var myobShipMethodID = 56;  // Integer | The primary key value of the MYOB ship method. (optional) 
            var priority = 56;  // Integer | Priority level (optional) 
            var recordDate = 56;  // Integer | The date a transfer entry was recorded. (optional) 
            var srcLocationID = 56;  // Integer | The primary key value of the source location. (optional) 
            var statusID = 56;  // Integer | the primary key value of the status record. (optional) 
            var tRN = tRN_example;  // String | The transfer registration number. (optional) 
            var transfersID = 56;  // Integer | The primary key value of the transfer record/ (optional) 

            try
            {
                // Returns information about the specified transfers.
                transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.transfersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$contactName = contactName_example; // String | Contact name of the card attached to the transfer.
$createDate = createDate_example; // String | Create date of the transfer entry.
$dstLocationID = 56; // Integer | the primary key value of the destination location.
$myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
$priority = 56; // Integer | Priority level
$recordDate = 56; // Integer | The date a transfer entry was recorded.
$srcLocationID = 56; // Integer | The primary key value of the source location.
$statusID = 56; // Integer | the primary key value of the status record.
$tRN = tRN_example; // String | The transfer registration number.
$transfersID = 56; // Integer | The primary key value of the transfer record/

try {
    $result = $api_instance->transfersGet($contactName, $createDate, $dstLocationID, $myobShipMethodID, $priority, $recordDate, $srcLocationID, $statusID, $tRN, $transfersID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->transfersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $contactName = contactName_example; # String | Contact name of the card attached to the transfer.
my $createDate = createDate_example; # String | Create date of the transfer entry.
my $dstLocationID = 56; # Integer | the primary key value of the destination location.
my $myobShipMethodID = 56; # Integer | The primary key value of the MYOB ship method.
my $priority = 56; # Integer | Priority level
my $recordDate = 56; # Integer | The date a transfer entry was recorded.
my $srcLocationID = 56; # Integer | The primary key value of the source location.
my $statusID = 56; # Integer | the primary key value of the status record.
my $tRN = tRN_example; # String | The transfer registration number.
my $transfersID = 56; # Integer | The primary key value of the transfer record/

eval { 
    my $result = $api_instance->transfersGet(contactName => $contactName, createDate => $createDate, dstLocationID => $dstLocationID, myobShipMethodID => $myobShipMethodID, priority => $priority, recordDate => $recordDate, srcLocationID => $srcLocationID, statusID => $statusID, tRN => $tRN, transfersID => $transfersID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->transfersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
contactName = contactName_example # String | Contact name of the card attached to the transfer. (optional)
createDate = createDate_example # String | Create date of the transfer entry. (optional)
dstLocationID = 56 # Integer | the primary key value of the destination location. (optional)
myobShipMethodID = 56 # Integer | The primary key value of the MYOB ship method. (optional)
priority = 56 # Integer | Priority level (optional)
recordDate = 56 # Integer | The date a transfer entry was recorded. (optional)
srcLocationID = 56 # Integer | The primary key value of the source location. (optional)
statusID = 56 # Integer | the primary key value of the status record. (optional)
tRN = tRN_example # String | The transfer registration number. (optional)
transfersID = 56 # Integer | The primary key value of the transfer record/ (optional)

try: 
    # Returns information about the specified transfers.
    api_response = api_instance.transfers_get(contactName=contactName, createDate=createDate, dstLocationID=dstLocationID, myobShipMethodID=myobShipMethodID, priority=priority, recordDate=recordDate, srcLocationID=srcLocationID, statusID=statusID, tRN=tRN, transfersID=transfersID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->transfersGet: %s\n" % e)

Parameters

Query parameters
Name Description
ContactName
String
Contact name of the card attached to the transfer.
CreateDate
String
Create date of the transfer entry.
DstLocationID
Integer
the primary key value of the destination location.
MyobShipMethodID
Integer
The primary key value of the MYOB ship method.
Priority
Integer
Priority level
RecordDate
Integer
The date a transfer entry was recorded.
SrcLocationID
Integer
The primary key value of the source location.
StatusID
Integer
the primary key value of the status record.
TRN
String
The transfer registration number.
TransfersID
Integer
The primary key value of the transfer record/

Responses

Status: 200 - OK