Customer restricted locations

In shared multi-entity companies, customers can be restricted to specific locations or location groups to prevent the customer from being used in the wrong entity.

List customer restricted locations

get/objects/accounts-receivable/customer-restricted-location

Returns a collection with a key, ID, and link for each customer restricted location. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "200",
      • "id": "200",
      • "href": "/objects/accounts-receivable/customer-restricted-location/200"
      },
    • {
      • "key": "198",
      • "id": "198",
      • "href": "/objects/accounts-receivable/customer-restricted-location/198"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100
    }
}
Get a customer restricted location
get/objects/accounts-receivable/customer-restricted-location/{key}
Returns detailed information for a specified customer restricted location.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the customer restricted location.


 
 Example:  142
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "142",
    • "objectType": "CUSTOMER",
    • "id": "142",
    • "location": {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/location/3"
      },
    • "locationGroup": {
      • "key": null,
      • "id": null
      },
    • "customer": {
      • "key": "330",
      • "id": "Nov7-02",
      • "href": "/objects/accounts-receivable/customer/142"
      },
    • "href": "/objects/accounts-receivable/customer-restricted-location/142"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query customer restricted locations
post/services/core/query
Use the query service to find customer restricted locations that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples