This app requires JavaScript! api Web Service Documentation

POSitive Anywhere

Web Service Documentation
Service: api
Method: customer_list
Lists all customers in blocks of 50. Returns total number of customer records and how many records were returned. Call this method with incrementing block numbers until the status returned is "no records retrieved".
Parameters
Group: options
block
(long integer)
 
OPTIONS:BLOCKSIZE
(long integer)
 
localcustomerid
(string[60])
 
customerid
(string[60])
 
postalcode
(string[10])
 
This parameter is Optional
Possible Return Data

List: ErrorQueue
ErrorNumber
(long integer)
 
ErrorPosition
(string[255])
 
ErrorRecordId
(string[255])
 
ErrorDescription
(string[255])
 
ErrorRecommendation
(string[255])
 
Group: result
status
(string[5000])
 
total_records
(long integer)
 
total_blocks
(long integer)
 
block_returned
(long integer)
 
returned_records
(long integer)
 
Field: customers
(long integer)
 
  customerlist
  List
 
 
    customer
    Group
 
 
      localcustomerid
      (string[60])
Your local unique Customer identifier
String from 0 to 60 characters
      customerid
      (int)
POSitive unique Customer identifier
Number
  customerlist
  List
 
 
    customer
    Group
 
 
      localcustomerid
      (string[60])
Your local unique Customer identifier
String from 0 to 60 characters
      customerid
      (int)
POSitive unique Customer identifier
Number
      customertype
      (string[1])
Type of Customer ("B" for Business, "P" for Person)
String from 0 to 1 characters
      lookupcode
      (string[60])
Unique lookup code (phone number, account number, etc)
String from 0 to 60 characters
      email
      (LIKE)
Email address
String from 0 to 200 characters
      company
      (LIKE)
Company name
String from 0 to 60 characters
      firstname
      (LIKE)
First name
String from 0 to 30 characters
      lastname
      (LIKE)
Last name
String from 0 to 30 characters
      homephone
      (LIKE)
Home phone
String from 0 to 20 characters
      workphone
      (LIKE)
Work phone
String from 0 to 20 characters
      cellphone
      (LIKE)
Cell phone
String from 0 to 20 characters
      faxphone
      (LIKE)
Fax phone
String from 0 to 20 characters
      taxvat
      (string[40])
Resale ID or VAT Number
String from 0 to 40 characters
      taxgroupid
      (string[60])
Tax group id, related to value retrieved from tax_customer_group_id
String from 0 to 60 characters
      creditlimit
      (string[60])
Customer credit limit
String from 0 to 60 characters
      amountowed
      (string[60])
Amount owed
String from 0 to 60 characters
      credithold
      (string[60])
Customer is on credit hold (true or false)
String from 0 to 60 characters
      orderhold
      (string[60])
Customer is on order hold (true of false)
String from 0 to 60 characters
      pricegroup
      (string[60])
Price group (description)
String from 0 to 60 characters
      pricegroupid
      (int)
Price Group unique identifier
Number
      udf
      List
 
 
        name
        (string[30])
UDF Field name
String from 0 to 30 characters
        value
        (string[40])
UDF Field value
String from 0 to 40 characters
      
      End
 
 
    
    End
 
 
  
  End
 
 
(long integer)