Customer Account

Summary

A data record that stores information about a customer, such as their name, address, contact information, and payment terms. It can be used to link all of the customer's interactions with the company, such as sales orders, invoices, and payments.

Schema

Relationships

1. CustomerAccount belongs to zero or one CustomerCategory
2. CustomerAccount belongs to zero or one CustomerPriceGroup : belongsTo
3. CustomerAccount belongs to zero or one CustomerStatus

Definitions

Customer Account

Data Type	Field Name	Rules	About
String	accountCode	Zero or One	Business identifier for a customer account
BusinessPartner	businessPartner	One to Many	The collection of business partners internally referenced from within this class
CustomerCategory	customerCategory	Zero or One	Used to group customers by various criteria
String	customerName	Zero or One	The name of the customer associated with this account.
CustomerPriceGroup	customerPriceGroup	Zero or One
BusinessPartner	defaultReceiver	Zero or One	Points to the default receiver entry in the business partner object of this class
ExtensionField	extendedBy	Zero to Many	Refer to: Extension Field
ExternalID	externalIdentity	Zero to Many	Refer to: External ID
BusinessPartner	payer	Zero or One	Internal reference to the business partner record for the party responsible for payment
RecordedByUser	recordedBy	Zero to Many	The user who captured the sales order in the originating system.
BusinessPartner	seller	Zero or One	Internal reference to the business partner record for the sales organization
String	sourceSystemCode	Zero or One	Refer to: Source System
String	sourceSystemID	Zero or One	Refer to: Source System
String	salesRepName	Zero or One	The name of the sales rep

CustomerCategory

Data Type	Field Name	Rules	About
String	code	Exactly 1
String	description	Zero or One

CustomerPriceGroup

Data Type	Field Name	Rules	About
String	code	Exactly 1

CustomerStatus

Data Type	Field Name	Rules	About
String	code	Exactly 1	Active or
String	description	Zero or One

Sample JSON

{
  "schemaName": "limber",
  "schemaVersion": "2.1.0",
  "shapeName": "CustomerAccount",
  "dataId": {
    "@type": "DataReference",
    "schemaName": "limber",
    "shapeName": "CustomerAccount",
    "iri": "https://schema.limbergraph.com/limber/CustomerAccount#25679298-b31c-4090-94a8-1ed3d37e1637",
    "externalIdentities": [
      {
        "integrationKey": "SapS4",
        "externalId": "1000058::6900::10::00"
      }
    ],
    "keys": [
      {
        "accountCode": "SapS4-1000058::6900::10::00"
      },
      {
        "uniqueText": "25679298-b31c-4090-94a8-1ed3d37e1637"
      }
    ],
    "label": "SapS4-1000058::6900::10::00"
  },
  "dataAction": "PUBLISH",
  "mode": "LIVE",
  "integrationKey": "SapS4",
  "correlationId": "16c2a9c0-fc65-46ed-bb5a-17281dc380b7",
  "data": {
    "@type": "CustomerAccount",
    "externalIdentity": [
      {
        "@type": "ExternalID",
        "internalType": "CustomerAccount",
        "externalSystemCode": "SapS4",
        "externalId": "1000058::6900::10::00"
      }
    ],
    "extendedBy": [
      {
        "@type": "ExtensionField",
        "key": "customerNumber",
        "value": ["1000058"],
        "uniqueText": "34def81f-7d2e-42cd-a82e-18c0d7ed197d"
      },
      {
        "@type": "ExtensionField",
        "key": "customerPriceGroup",
        "value": ["Z0"],
        "uniqueText": "79a29e30-0b5a-4ed2-b3a5-9fe8568e8d63"
      },
      {
        "@type": "ExtensionField",
        "key": "previousCustomerNumber",
        "value": ["N001807"],
        "uniqueText": "8c57782d-567d-43db-86a9-0ef1368258f7"
      }
    ],
    "attributeField": [
      {
        "@type": "AttributeField",
        "key": "Division",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#0783f18a-c0c6-4df1-864d-8524b3ba5516",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "Division::00"
              }
            ],
            "keys": [
              {
                "discriminant": "Division",
                "code": "00"
              },
              {
                "uniqueText": "0783f18a-c0c6-4df1-864d-8524b3ba5516"
              }
            ],
            "label": "Flooring"
          }
        ],
        "uniqueText": "2f04f8cb-903e-41d1-9a7d-83cc0e3cf803"
      },
      {
        "@type": "AttributeField",
        "key": "distributionChannel",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#19c02c8c-88b1-474f-b8d7-c34746864b1b",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "DistributionChannel::10"
              }
            ],
            "keys": [
              {
                "discriminant": "DistributionChannel",
                "code": "10"
              },
              {
                "uniqueText": "19c02c8c-88b1-474f-b8d7-c34746864b1b"
              }
            ],
            "label": "Wholesale"
          }
        ],
        "uniqueText": "a2acde6c-69cb-4dc9-9021-47c87888002c"
      },
      {
        "@type": "AttributeField",
        "key": "CustomerGroup",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#6c8a19ce-18e8-4cfd-a3cd-cf0d35ab3f07",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "CustomerGroup::05"
              }
            ],
            "keys": [
              {
                "discriminant": "CustomerGroup",
                "code": "05"
              },
              {
                "uniqueText": "6c8a19ce-18e8-4cfd-a3cd-cf0d35ab3f07"
              }
            ],
            "label": "Flooring Other"
          }
        ],
        "uniqueText": "a1137dac-afb7-4d2e-b302-f64867ce89c9"
      },
      {
        "@type": "AttributeField",
        "key": "AnalyticalCustomerGroup",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#47ed026f-96e7-4b0e-abe4-95cd3d13cec3",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "AdditionalCustomerGroup1::A56"
              }
            ],
            "keys": [
              {
                "discriminant": "AdditionalCustomerGroup1",
                "code": "A56"
              },
              {
                "uniqueText": "47ed026f-96e7-4b0e-abe4-95cd3d13cec3"
              }
            ],
            "label": "Flooring Other"
          }
        ],
        "uniqueText": "7916aabf-b753-4b11-9668-643a1407a59b"
      },
      {
        "@type": "AttributeField",
        "key": "AccountsReceivableCustomerGroup",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#36a3562f-fd27-4bae-9500-6d1cf6ac815c",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "AdditionalCustomerGroup2::D01"
              }
            ],
            "keys": [
              {
                "discriminant": "AdditionalCustomerGroup2",
                "code": "D01"
              },
              {
                "uniqueText": "36a3562f-fd27-4bae-9500-6d1cf6ac815c"
              }
            ],
            "label": "Other"
          }
        ],
        "uniqueText": "806c4d79-6e95-4772-89ad-bf9ddead0e5d"
      },
      {
        "@type": "AttributeField",
        "key": "ForecastingCustomerGroup",
        "attributeValue": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "AttributeValue",
            "iri": "https://schema.limbergraph.com/limber/AttributeValue#b5579ee2-4dd9-4692-b926-c30fce51a1d2",
            "externalIdentities": [
              {
                "integrationKey": "SapS4",
                "externalId": "AdditionalCustomerGroup4::I21"
              }
            ],
            "keys": [
              {
                "discriminant": "AdditionalCustomerGroup4",
                "code": "I21"
              },
              {
                "uniqueText": "b5579ee2-4dd9-4692-b926-c30fce51a1d2"
              }
            ],
            "label": "Flooring Other"
          }
        ],
        "uniqueText": "58c995f5-2b96-4f5f-84d2-620c80ba0540"
      }
    ],
    "sourceSystemCode": "SapS4",
    "sourceSystemId": "1000058::6900::10::00",
    "recordedBy": [
      {
        "@type": "RecordedByUser",
        "externalSystemCode": "SapS4",
        "createdByUserCode": "CB9980000170",
        "modifiedByUserCode": "CB9980003692",
        "createdOn": "2020-01-29T14:50:51Z",
        "modifiedOn": "2023-04-26T16:09:42Z",
        "uniqueText": "110c90e4-8994-4467-803e-3c6bf97cccca"
      }
    ],
    "accountCode": "SapS4-1000058::6900::10::00",
    "seller": {
      "@type": "InternalReference",
      "id": "ab46952e-e1ec-4f1d-a1a0-0227ef87fb9a",
      "className": "BusinessPartner",
      "externalIdentities": [
        {
          "integrationKey": "SapS4",
          "externalId": "6900"
        }
      ],
      "keys": [
        {
          "uniqueText": "ab46952e-e1ec-4f1d-a1a0-0227ef87fb9a"
        }
      ]
    },
    "payer": {
      "@type": "InternalReference",
      "id": "8dec582b-b370-424f-88c8-bb7ba94d5dd4",
      "className": "BusinessPartner",
      "externalIdentities": [
        {
          "integrationKey": "SapS4",
          "externalId": "1000058"
        }
      ],
      "keys": [
        {
          "uniqueText": "8dec582b-b370-424f-88c8-bb7ba94d5dd4"
        }
      ]
    },
    "businessPartner": [
      {
        "@type": "BusinessPartner",
        "externalIdentity": [
          {
            "@type": "ExternalID",
            "internalType": "BusinessPartner",
            "externalSystemCode": "SapS4",
            "externalId": "1000058"
          }
        ],
        "extendedBy": [
          {
            "@type": "ExtensionField",
            "key": "isActive",
            "value": ["true"],
            "uniqueText": "88dd7259-62cb-4ed1-be1e-b02b76b53dd2"
          }
        ],
        "emailAddress": {
          "@type": "EmailAddress",
          "email": "[email protected]",
          "uniqueText": "2525da8b-de38-475a-9b2c-7ef01307574c"
        },
        "phoneAddress": {
          "@type": "PhoneAddress",
          "addressType": {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "PhoneAddressType",
            "iri": "https://schema.limbergraph.com/limber/PhoneAddressType#Landline",
            "keys": [
              {
                "code": "Landline"
              }
            ],
            "label": "Landline"
          },
          "phoneNumber": "021 123 4567",
          "uniqueText": "7c9e5066-6879-4214-988c-05f6edb17bb2"
        },
        "physicalAddress": {
          "@type": "PhysicalAddress",
          "line1": "1",
          "line2": "Some Road",
          "regionName": "CAN",
          "postalCode": "7400",
          "cityName": "Somewhere",
          "country": {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "Country",
            "iri": "https://schema.limbergraph.com/limber/Country#NZ",
            "keys": [
              {
                "uniqueText": "NZ"
              }
            ],
            "label": "New Zealand"
          },
          "uniqueText": "8d7e6756-0c40-41bd-92fc-54d6acd16872"
        },
        "primaryName": "Some Company Name on 26.04.20",
        "businessPartnerRole": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "BusinessPartnerRole",
            "iri": "https://schema.limbergraph.com/limber/BusinessPartnerRole#Receiver",
            "keys": [
              {
                "code": "Receiver"
              }
            ],
            "label": "Receiver"
          },
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "BusinessPartnerRole",
            "iri": "https://schema.limbergraph.com/limber/BusinessPartnerRole#Buyer",
            "keys": [
              {
                "code": "Buyer"
              }
            ],
            "label": "Buyer"
          },
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "BusinessPartnerRole",
            "iri": "https://schema.limbergraph.com/limber/BusinessPartnerRole#Payer",
            "keys": [
              {
                "code": "Payer"
              }
            ],
            "label": "Payer"
          }
        ],
        "uniqueText": "8dec582b-b370-424f-88c8-bb7ba94d5dd4"
      },
      {
        "@type": "BusinessPartner",
        "externalIdentity": [
          {
            "@type": "ExternalID",
            "internalType": "BusinessPartner",
            "externalSystemCode": "SapS4",
            "externalId": "6900"
          }
        ],
        "code": "6900",
        "primaryName": "NZ Sale Org",
        "businessPartnerRole": [
          {
            "@type": "DataReference",
            "schemaName": "limber",
            "shapeName": "BusinessPartnerRole",
            "iri": "https://schema.limbergraph.com/limber/BusinessPartnerRole#Seller",
            "keys": [
              {
                "code": "Seller"
              }
            ],
            "label": "Seller"
          }
        ],
        "uniqueText": "ab46952e-e1ec-4f1d-a1a0-0227ef87fb9a"
      }
    ],
    "uniqueText": "25679298-b31c-4090-94a8-1ed3d37e1637",
    "@version": 2,
    "salesRepName": "John Smith"
  },
  "storeKey": "limber",
  "stats": {
    "label": "getData",
    "time": 251,
    "minTime": 251,
    "maxTime": 251,
    "count": 1,
    "items": {
      "prepare": {
        "label": "prepare",
        "time": 181,
        "minTime": 181,
        "maxTime": 181,
        "count": 1
      },
      "retrieve": {
        "label": "retrieve",
        "time": 61,
        "minTime": 61,
        "maxTime": 61,
        "count": 1,
        "items": {
          "byPrimaryKey": {
            "label": "byPrimaryKey",
            "time": 61,
            "minTime": 61,
            "maxTime": 61,
            "count": 1
          }
        }
      },
      "provideReferences": {
        "label": "provideReferences",
        "time": 9,
        "minTime": 9,
        "maxTime": 9,
        "count": 1,
        "items": {
          "provideExternalReferences": {
            "label": "provideExternalReferences",
            "time": 9,
            "minTime": 9,
            "maxTime": 9,
            "count": 1
          },
          "filterInternalReferences": {
            "label": "filterInternalReferences",
            "time": 0,
            "minTime": 0,
            "maxTime": 0,
            "count": 1
          },
          "filterExternalReferences": {
            "label": "filterExternalReferences",
            "time": 0,
            "minTime": 0,
            "maxTime": 0,
            "count": 1
          }
        }
      }
    }
  }
}