Rockwell Automation · Schema

SyncCustomerDTO

The full Customer Resource structure

Industrial AutomationManufacturingPLCSCADAIndustrial IoTFortune 500Industrial

Properties

Name Type Description
id string A unique identifier for the Customer Address. This will be automatically generated if omitted from the request.
code string
name string
status string Setup Table: Customer Status
type string Setup Table: Customer Type
note string
supplierCode string
otherCustomerCode string
rating string Setup Table: Customer Rating
industries array Setup Table: Industries
defaultCarrierIds array A list of Default Carriers, by Supplier ID.
region string
businessType string Setup Table: Business Type
category string Setup Table: Customer Category
class string Setup Table: Customer Class
catalog string Screen: Catalogs
assignedToId string The sales person assigned to this customer, by IAM Account ID.
assignedTo2Id string The sales person assigned to this customer, by IAM Account ID.
assignedTo3Id string The sales person assigned to this customer, by IAM Account ID.
assignedToGroup string
contactResourceId string The Contact_Id of the sales person assigned to this Customer.
annualSalesMillions number
estimatedEmployees string
phone string
fax string
email string
trackingNoOnWeighScaleRequired boolean
multipleOrdersPerShipper boolean
estimatedAnnualSales string
newShipperPerReleaseNo boolean
defaultBackOrder string Setup Table: Back Order
financials object
addresses array The customer's sub-resources: customer addresses
maxDaysOutstanding integer
currencyCode string
terms string Setup Table: Terms
requestedTerms string Setup Table: Terms
creditLimit number
salesTaxExempt boolean
creditHold boolean
creditStatus string Setup Table: Credit Status
creditRating string Setup Table: Credit Rating
creditReviewDate string
creditNote string
invoiceDelivery string Setup Table: Invoice Delivery. The default value is "Mail/Print Invoice".
salesTaxExemptNo string
billingSeparation integer
invoiceLineReference string The customer's invoices will reference one of the following options: Part No, Release No, Customer Order No
taxIdNo string
retroactivePricing boolean
governmentIssuedTaxNo string
invoicePo string The invoice PO will reference of the following options: Release No or Customer Release No.
quoteTo boolean If true, this address may be used for customer quotes.
shipTo boolean If true, this address may be used for customer shipping.
billTo boolean If true, this address may be used for customer invoices.
billToAddressId string The customer address ID to be used for customer billing.
remitTo boolean If true, this address may be used for remittance.
thirdPartyShipTo boolean If true, this is a valid third-party shipping address.
thirdPartyShipToAddressId string The customer address ID to be used for third-party shipping.
pool boolean If true, this is a valid pool address. A pool is a location used to organize shipments and routes the shippers to the Ship To location.
poolAddressId string The customer address ID to be used for pooling.
oldCustomerNo string
active boolean
address string
city string
state string
zip string
country string
county string
shippingInstructions string
ignoreTransitOnWeekends boolean
transportationLeadTime integer
truckType string Screen: Truck Types
salespersonId string The salesperson assigned to this customer, by IAM account ID.
statementAddressId string The address to which statements should be sent, if this address is a valid Billing address.
freightTerms string Setup Table: Freight Terms
insideSalespersonId string The salesperson assigned to this customer, by IAM account ID.
defaultShipFrom string Screen: Building List
freightBillTo boolean If true, this is a valid address for freight billing.
freightBillToAddressId string The customer address to be used for freight billing.
soldTo boolean
dunsNo string
commercialInvoiceVatNo string
template boolean Only one address can be used as the address template.
incoTerms string
negotiatedPlace string
backOrder string Setup Table: Back_Order
View JSON Schema on GitHub

JSON Schema

rockwell-automation-sync-customer-dto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/rockwell-automation/main/json-schema/rockwell-automation-sync-customer-dto-schema.json",
  "title": "SyncCustomerDTO",
  "description": "The full Customer Resource structure",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rockwell-automation-plex-openapi.yml#/components/schemas/SyncCustomerDTO",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "A unique identifier for the Customer Address. This will be automatically generated if omitted from the request."
    },
    "code": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "Setup Table: Customer Status"
    },
    "type": {
      "type": "string",
      "description": "Setup Table: Customer Type"
    },
    "note": {
      "type": "string"
    },
    "supplierCode": {
      "type": "string"
    },
    "otherCustomerCode": {
      "type": "string"
    },
    "rating": {
      "type": "string",
      "description": "Setup Table: Customer Rating"
    },
    "industries": {
      "type": "array",
      "description": "Setup Table: Industries",
      "items": {
        "type": "string"
      }
    },
    "defaultCarrierIds": {
      "type": "array",
      "description": "A list of Default Carriers, by Supplier ID.",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "region": {
      "type": "string"
    },
    "businessType": {
      "type": "string",
      "description": "Setup Table: Business Type"
    },
    "category": {
      "type": "string",
      "description": "Setup Table: Customer Category"
    },
    "class": {
      "type": "string",
      "description": "Setup Table: Customer Class"
    },
    "catalog": {
      "type": "string",
      "description": "Screen: Catalogs"
    },
    "assignedToId": {
      "type": "string",
      "format": "uuid",
      "description": "The sales person assigned to this customer, by IAM Account ID."
    },
    "assignedTo2Id": {
      "type": "string",
      "format": "uuid",
      "description": "The sales person assigned to this customer, by IAM Account ID."
    },
    "assignedTo3Id": {
      "type": "string",
      "format": "uuid",
      "description": "The sales person assigned to this customer, by IAM Account ID."
    },
    "assignedToGroup": {
      "type": "string"
    },
    "contactResourceId": {
      "type": "string",
      "format": "uuid",
      "description": "The Contact_Id of the sales person assigned to this Customer."
    },
    "annualSalesMillions": {
      "type": "number",
      "format": "double"
    },
    "estimatedEmployees": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "fax": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "trackingNoOnWeighScaleRequired": {
      "type": "boolean"
    },
    "multipleOrdersPerShipper": {
      "type": "boolean"
    },
    "estimatedAnnualSales": {
      "type": "string"
    },
    "newShipperPerReleaseNo": {
      "type": "boolean"
    },
    "defaultBackOrder": {
      "type": "string",
      "description": "Setup Table: Back Order"
    },
    "financials": {
      "$ref": "#/$defs/UpdateCustomerFinancialsDTO"
    },
    "addresses": {
      "type": "array",
      "description": "The customer's sub-resources: customer addresses",
      "items": {
        "type": "object",
        "description": "The CustomerAddress model exposed for adding.",
        "properties": {}
      }
    },
    "maxDaysOutstanding": {
      "type": "integer",
      "format": "int32"
    },
    "currencyCode": {
      "type": "string"
    },
    "terms": {
      "type": "string",
      "description": "Setup Table: Terms"
    },
    "requestedTerms": {
      "type": "string",
      "description": "Setup Table: Terms"
    },
    "creditLimit": {
      "type": "number",
      "format": "double"
    },
    "salesTaxExempt": {
      "type": "boolean"
    },
    "creditHold": {
      "type": "boolean"
    },
    "creditStatus": {
      "type": "string",
      "description": "Setup Table: Credit Status"
    },
    "creditRating": {
      "type": "string",
      "description": "Setup Table: Credit Rating"
    },
    "creditReviewDate": {
      "type": "string",
      "format": "date-time"
    },
    "creditNote": {
      "type": "string"
    },
    "invoiceDelivery": {
      "type": "string",
      "description": "Setup Table: Invoice Delivery. The default value is "Mail/Print Invoice"."
    },
    "salesTaxExemptNo": {
      "type": "string"
    },
    "billingSeparation": {
      "type": "integer",
      "format": "int32"
    },
    "invoiceLineReference": {
      "type": "string",
      "description": "The customer's invoices will reference one of the following options: Part No, Release No, Customer Order No"
    },
    "taxIdNo": {
      "type": "string"
    },
    "retroactivePricing": {
      "type": "boolean"
    },
    "governmentIssuedTaxNo": {
      "type": "string"
    },
    "invoicePo": {
      "type": "string",
      "description": "The invoice PO will reference of the following options: Release No or Customer Release No."
    },
    "quoteTo": {
      "type": "boolean",
      "description": "If true, this address may be used for customer quotes."
    },
    "shipTo": {
      "type": "boolean",
      "description": "If true, this address may be used for customer shipping."
    },
    "billTo": {
      "type": "boolean",
      "description": "If true, this address may be used for customer invoices."
    },
    "billToAddressId": {
      "type": "string",
      "format": "uuid",
      "description": "The customer address ID to be used for customer billing."
    },
    "remitTo": {
      "type": "boolean",
      "description": "If true, this address may be used for remittance."
    },
    "thirdPartyShipTo": {
      "type": "boolean",
      "description": "If true, this is a valid third-party shipping address."
    },
    "thirdPartyShipToAddressId": {
      "type": "string",
      "format": "uuid",
      "description": "The customer address ID to be used for third-party shipping."
    },
    "pool": {
      "type": "boolean",
      "description": "If true, this is a valid pool address. A pool is a location used to organize shipments and routes the shippers to the Ship To location."
    },
    "poolAddressId": {
      "type": "string",
      "format": "uuid",
      "description": "The customer address ID to be used for pooling."
    },
    "oldCustomerNo": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "address": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "zip": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "county": {
      "type": "string"
    },
    "shippingInstructions": {
      "type": "string"
    },
    "ignoreTransitOnWeekends": {
      "type": "boolean"
    },
    "transportationLeadTime": {
      "type": "integer",
      "format": "int32"
    },
    "truckType": {
      "type": "string",
      "description": "Screen: Truck Types"
    },
    "salespersonId": {
      "type": "string",
      "format": "uuid",
      "description": "The salesperson assigned to this customer, by IAM account ID."
    },
    "statementAddressId": {
      "type": "string",
      "format": "uuid",
      "description": "The address to which statements should be sent, if this address is a valid Billing address."
    },
    "freightTerms": {
      "type": "string",
      "description": "Setup Table: Freight Terms"
    },
    "insideSalespersonId": {
      "type": "string",
      "format": "uuid",
      "description": "The salesperson assigned to this customer, by IAM account ID."
    },
    "defaultShipFrom": {
      "type": "string",
      "description": "Screen: Building List"
    },
    "freightBillTo": {
      "type": "boolean",
      "description": "If true, this is a valid address for freight billing."
    },
    "freightBillToAddressId": {
      "type": "string",
      "format": "uuid",
      "description": "The customer address to be used for freight billing."
    },
    "soldTo": {
      "type": "boolean"
    },
    "dunsNo": {
      "type": "string"
    },
    "commercialInvoiceVatNo": {
      "type": "string"
    },
    "template": {
      "type": "boolean",
      "description": "Only one address can be used as the address template."
    },
    "incoTerms": {
      "type": "string"
    },
    "negotiatedPlace": {
      "type": "string"
    },
    "backOrder": {
      "type": "string",
      "description": "Setup Table: Back_Order"
    }
  },
  "required": [
    "code",
    "name",
    "status",
    "type",
    "businessType",
    "code"
  ],
  "$defs": {
    "UpdateCustomerFinancialsDTO": {
      "type": "object",
      "description": "The customer financial model for updating.",
      "properties": {
        "maxDaysOutstanding": {
          "type": "integer",
          "format": "int32"
        },
        "currencyCode": {
          "type": "string"
        },
        "terms": {
          "type": "string",
          "description": "Setup Table: Terms"
        },
        "requestedTerms": {
          "type": "string",
          "description": "Setup Table: Terms"
        },
        "creditLimit": {
          "type": "number",
          "format": "double"
        },
        "salesTaxExempt": {
          "type": "integer",
          "format": "int32"
        },
        "creditHold": {
          "type": "boolean"
        },
        "creditStatus": {
          "type": "string",
          "description": "Setup Table: Credit Status"
        },
        "creditRating": {
          "type": "string",
          "description": "Setup Table: Credit Rating"
        },
        "creditReviewDate": {
          "type": "string",
          "format": "date-time"
        },
        "creditNote": {
          "type": "string"
        },
        "invoiceDelivery": {
          "type": "string",
          "description": "Setup Table: Invoice Delivery. The default value is "Mail/Print Invoice"."
        },
        "salesTaxExemptNo": {
          "type": "string"
        },
        "billingSeparation": {
          "type": "integer",
          "format": "int32"
        },
        "invoiceLineReference": {
          "type": "string",
          "description": "The customer's invoices will reference one of the following options: Part No, Release No, Customer Order No"
        },
        "taxIdNo": {
          "type": "string"
        },
        "retroactivePricing": {
          "type": "boolean"
        },
        "governmentIssuedTaxNo": {
          "type": "string"
        },
        "invoicePo": {
          "type": "string",
          "description": "The invoice PO will reference of the following options: Release No or Customer Release No."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/rockwell-automation-sync-customer-dto"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.