API Customers | Inventory Pro

Customers

A customer record represents a company or individual who owns stock held in your warehouses or receives shipments.

The Customer Object

The list response (GET /Customer/All) returns a projected subset. The single response (GET /Customer/{id}) returns the raw customer entity.

List shape:

{
  "rec": 101,
  "shortId": "ACME-CORP",
  "name": "Acme Corporation",
  "contact": "Jane Smith",
  "accNo": "ACC-100",
  "phone": "555-0100",
  "fax": "555-0101",
  "email": "[EMAIL]",
  "address1": "123 Industrial Way",
  "address2": "",
  "city": "Springfield",
  "state": "IL",
  "zip": "62701",
  "country": "US",
  "priceLevel": 1,
  "notes": "",
  "taxId": 0,
  "term": 30,
  "modified": "2025-01-20T14:22:00Z"
}

Field	Type	Description
`rec`	integer	Internal customer record ID
`shortId`	string	Unique customer identifier
`name`	string	Customer name
`contact`	string	Primary contact name
`accNo`	string	Account number
`phone`	string	Phone number
`fax`	string	Fax number
`email`	string	Email address
`address1`	string	Primary address line
`address2`	string	Secondary address line
`city`	string	City
`state`	string	State or province
`zip`	string	Postal code
`country`	string	Country code
`priceLevel`	integer	Price/discount level
`notes`	string	Notes
`taxId`	integer	Tax ID
`term`	integer	Payment terms code
`modified`	datetime	Last modification timestamp

Note: The single-customer response (GET /Customer/{id}) returns the full customer entity, which includes additional fields beyond the list projection.

List Active Customers

GET /Customer

Returns active (non-discontinued) customers with standard pagination parameters. Discontinued customers are excluded. Supports modifiedSince filtering.

{
  "value": [
    {
      "rec": 101,
      "shortId": "ACME-CORP",
      "name": "Acme Corporation",
      "contact": "Jane Smith",
      "accNo": "ACC-100",
      "phone": "555-0100",
      "fax": "555-0101",
      "email": "[EMAIL]",
      "address1": "123 Industrial Way",
      "address2": "",
      "city": "Springfield",
      "state": "IL",
      "zip": "62701",
      "country": "US",
      "priceLevel": 1,
      "notes": "",
      "taxId": 0,
      "term": 30,
      "modified": "2025-01-20T14:22:00Z"
    }
  ],
  "totalCount": 46,
  "page": 1,
  "pageSize": 25,
  "pageCount": 2,
  "hasMore": true
}

List All Customers

GET /Customer/All

Returns all customers (including discontinued) with standard pagination parameters. Supports modifiedSince filtering.

{
  "value": [
    {
      "shortId": "ACME-CORP",
      "name": "Acme Corporation",
      "contact": "Jane Smith",
      "accNo": "ACC-100",
      "phone": "555-0100",
      "fax": "555-0101",
      "email": "[EMAIL]",
      "address1": "123 Industrial Way",
      "address2": "",
      "city": "Springfield",
      "state": "IL",
      "zip": "62701",
      "country": "US",
      "priceLevel": 1,
      "notes": "",
      "taxId": 0,
      "term": 30,
      "modified": "2025-01-20T14:22:00Z"
    },
    {
      "rec": 102,
      "shortId": "BRIGHT-MFG",
      "name": "Bright Manufacturing LLC",
      "contact": "Tom Briggs",
      "accNo": "ACC-101",
      "phone": "555-0201",
      "fax": "555-0202",
      "email": "[EMAIL]",
      "address1": "88 Factory Rd",
      "address2": "Suite 200",
      "city": "Rockford",
      "state": "IL",
      "zip": "61101",
      "country": "US",
      "priceLevel": 2,
      "notes": "",
      "taxId": 0,
      "term": 30,
      "modified": "2025-01-20T14:22:00Z"
    }
  ],
  "totalCount": 48,
  "page": 1,
  "pageSize": 25,
  "pageCount": 2,
  "hasMore": true
}

Get a Customer

GET /Customer/{id}

Returns the full customer entity by ShortID. Returns 404 if the customer does not exist.

GET /Customer/ACME-CORP

{
  "shortId": "ACME-CORP",
  "name": "Acme Corporation",
  "address1": "123 Industrial Way",
  "address2": "",
  "city": "Springfield",
  "state": "IL",
  "zip": "62701",
  "country": "US",
  "phone": "555-0100",
  "fax": "555-0101",
  "email": "[EMAIL]",
  "contact": "Jane Smith"
}

Create or Update a Customer

POST /Customer

Upserts a customer. If ShortID matches an existing record it is updated; otherwise a new record is created.

Request

{
  "ShortID": "ACME-CORP",
  "Name": "Acme Corporation",
  "Contact": "Jane Smith",
  "Address1": "123 Industrial Way",
  "Address2": "",
  "City": "Springfield",
  "State": "IL",
  "Zip": "62701",
  "Country": "US",
  "Telephone": "555-0100",
  "Fax": "555-0101",
  "Email": "[EMAIL]"
}

Field	Type	Required	Description
`ShortID`	string	Yes	Unique identifier. Used to match existing records on upsert.
`Name`	string	Yes	Customer name
`Contact`	string	No	Primary contact name
`AccNo`	string	No	Account number
`Telephone`	string	No	Phone number
`Fax`	string	No	Fax number
`Email`	string	No	Email address
`Address1`	string	No	Primary address line
`Address2`	string	No	Secondary address line
`City`	string	No	City
`State`	string	No	State or province
`Zip`	string	No	Postal code
`Country`	string	No	Country code
`LocationOf`	string	No	Location reference
`DiscountOption`	integer	No	Price/discount level (default 0)
`Notes`	string	No	Notes
`TaxID`	integer	No	Tax ID (default 0)
`Term`	string	No	Payment terms

Note: The write body uses PascalCase field names. ShortID and Name are required.

Response

{
  "shortID": "ACME-CORP",
  "status": "imported"
}

Discontinue a Customer

DELETE /Customer/{id}

Marks the customer as discontinued. Historical records are preserved. Returns 200 with a confirmation message.

DELETE /Customer/ACME-CORP

"Customer Discontinued: ACME-CORP"

Permissions

Action	Permission
List / Get	Customers List (SecurityID 130)
Create / Update / Discontinue	Create/Modify Customer (SecurityID 131)