xdm/docs/reference/datatypes/b2b-account.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
{
    "meta:license": [
        "Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/datatypes/b2b-account",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "B2B Account",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "description": "This Data Type is used to capture B2B Account properties. They are grouped functioanlly under separate definitions.",
    "definitions": {
        "b2b-account-segmentation": {
            "properties": {
                "xdm:accountName": {
                    "title": "Account Name",
                    "description": "name of company. Up to 255 characters are allowed in this field.",
                    "type": "string"
                },
                "xdm:accountTerritoryID": {
                    "title": "Account Territory Id",
                    "description": "The territory to which the account has been assigned.",
                    "type": "string"
                },
                "xdm:accountScore": {
                    "title": "Account Score",
                    "type": "number"
                },
                "xdm:accountBillingAddress": {
                    "title": "Account Billing Address",
                    "$ref": "https://ns.adobe.com/xdm/common/address"
                },
                "xdm:accountShippingAddress": {
                    "title": "Account Shipping Address",
                    "$ref": "https://ns.adobe.com/xdm/common/address"
                },
                "xdm:accountPhysicalAddress": {
                    "title": "Account Physical Address",
                    "description": "Actual physical address of the account. Could be the HQ address or any preffered business address for communication.",
                    "$ref": "https://ns.adobe.com/xdm/common/address"
                },
                "xdm:accountOrganization": {
                    "title": "Account Organization",
                    "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-account-organization"
                }
            }
        },
        "b2b-account": {
            "properties": {
                "xdm:accountParentID": {
                    "title": "Parent Account",
                    "description": "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.",
                    "type": "string"
                },
                "xdm:partnerAccountID": {
                    "title": "Partner Account Id",
                    "description": "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.",
                    "type": "string"
                },
                "xdm:accountOwnerID": {
                    "title": "Account Owner Id",
                    "description": "Account owner ID.",
                    "type": "string"
                },
                "xdm:accountNumber": {
                    "title": "Account Number",
                    "description": "Tracking or reference number for account. Up to 40 characters are allowed in this field.",
                    "type": "string"
                },
                "xdm:accountDescription": {
                    "title": "Account Description",
                    "description": "Text description of the account.",
                    "type": "string"
                },
                "xdm:accountSite": {
                    "title": "Account Site Details",
                    "description": "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.",
                    "type": "string"
                },
                "xdm:accountType": {
                    "title": "Account Type",
                    "description": "Account Type.",
                    "type": "string"
                },
                "xdm:accountSourceType": {
                    "title": "Account Source Type",
                    "description": "Source type for the account.",
                    "type": "string"
                },
                "xdm:defaultCurrencyCode": {
                    "title": "Default Currency Code",
                    "type": "string",
                    "examples": [
                        "USD",
                        "EUR"
                    ],
                    "pattern": "^[A-Z]{3}$",
                    "description": "The ISO 4217 currency code."
                },
                "xdm:accountOwnership": {
                    "title": "Ownership",
                    "description": "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.",
                    "type": "string"
                },
                "xdm:accountTradeStyle": {
                    "title": "Account Trade Style",
                    "description": "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).",
                    "type": "string"
                },
                "xdm:accountPhone": {
                    "title": "Account Phone Number",
                    "description": "Phone number for the account.",
                    "$ref": "https://ns.adobe.com/xdm/context/phonenumber"
                },
                "xdm:accountFax": {
                    "title": "Account Fax Number",
                    "description": "Fax number for the account.",
                    "$ref": "https://ns.adobe.com/xdm/context/phonenumber"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/b2b-account"
        },
        {
            "$ref": "#/definitions/b2b-account-segmentation"
        }
    ],
    "meta:status": "experimental",
    "examples": [
        {}
    ]
}