AccountAdmin

URL

https://api.primaerp.com/v1/accountadmins

Properties

Name Type Access Required Description
account Account read write YES Determines which account is administered.
createdAt Date read only no Date of creation.
displayName String read only no Describes an object in human readable form.
id String read write no Unique object identifier.
trashItem TrashItem read write no Informs whether an object is in the trash. An object is in the trash if a trash item was specified.
updatedAt Date read only no Last modified date.
user User read write YES The user who is the account administrator.
version Long read write no Object version number.

Metadata

{
    "type" : "AccountAdmin",
    "path" : "/v1/accountadmins",
    "fields" : [
        {
            "type" : "Account",
            "path" : "/v1/accounts",
            "name" : "account",
            "description" : "Determines which account is administered.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "type" : "Date",
            "name" : "createdAt",
            "description" : "Date of creation.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "String",
            "name" : "displayName",
            "description" : "Describes an object in human readable form.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "String",
            "name" : "id",
            "description" : "Unique object identifier.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "Pattern",
                    "details" : "regexp [0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}"
                },
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "type" : "TrashItem",
            "path" : "/v1/trash",
            "name" : "trashItem",
            "description" : "Informs whether an object is in the trash. An object is in the trash if a trash item was specified.",
            "access" : "READ_WRITE"
        },
        {
            "type" : "Date",
            "name" : "updatedAt",
            "description" : "Last modified date.",
            "access" : "READ_ONLY"
        },
        {
            "type" : "User",
            "path" : "/v1/users",
            "name" : "user",
            "description" : "The user who is the account administrator.",
            "access" : "READ_WRITE",
            "constraints" : [
                {
                    "type" : "NotNull"
                }
            ]
        },
        {
            "type" : "Long",
            "name" : "version",
            "description" : "Object version number.",
            "access" : "READ_WRITE"
        }
    ],
    "cascades" : [
        {
            "cascadeType" : "REMOVE",
            "objectTypes" : [
                "TrashItem"
            ]
        }
    ]
}

Dummy data

{
    "id" : "381d217e-28e9-4260-a40b-9875b5d5f606",
    "createdAt" : "/Date(1489386733435)/",
    "updatedAt" : "/Date(1489416793435)/",
    "version" : 3,
    "account" : {
        "id" : "632ac459-d039-430e-afea-d03ebfabb133",
        "createdAt" : "/Date(1489386313435)/",
        "updatedAt" : "/Date(1489463593435)/",
        "version" : 9,
        "owner" : {
            "id" : "3f289a86-11b7-4e20-ac6c-24c6c595a871",
            "createdAt" : "/Date(1489385173435)/",
            "updatedAt" : "/Date(1489416793435)/",
            "version" : 6,
            "firstName" : "John",
            "lastName" : "Smith",
            "nickName" : "Smith, J.",
            "email" : "john.smith@example.com",
            "phone" : "55 123 444 567",
            "position" : "Chief developer",
            "timeZone" : "America/Sao_Paulo",
            "dateFormat" : "dd/MM/yyyy",
            "timeFormat" : "K:mm a",
            "weekStart" : 7,
            "language" : "en_US",
            "password" : "",
            "secretKey" : "userSecretKey",
            "confirmed" : false,
            "confirmedEmail" : false,
            "active" : false,
            "birthdayRemind" : "/Date(1490223600000)/",
            "workingTimeStart" : "/Date(1489388400000)/",
            "workingTimeEnd" : "/Date(1489420800000)/",
            "created" : "/Date(1489301593435)/",
            "admin" : false,
            "projectManager" : false,
            "displayName" : "Smith John"
        },
        "urlPrefix" : "example-ltd",
        "name" : "Example Ltd.",
        "streetAddress" : "Avenida General Vale 1234",
        "additionalAddressInfo" : "",
        "zipCode" : "78010-000",
        "city" : "Cuiaba",
        "state" : "Mato Grosso",
        "countryCode" : "Brasil",
        "phone" : "BRA",
        "website" : "+55 123 456 789",
        "vatId" : "http://www.example.com",
        "paymentInfo" : "2100 2527 33 1234567890",
        "timeZone" : "America/Cuiaba",
        "dateFormat" : "dd/MM/yyyy",
        "timeFormat" : "HH:mm",
        "weekStart" : 7,
        "language" : "en_US",
        "apiKey" : "0165e7d3-c99f-41b5-bf8c-03222edcf681",
        "confirmed" : true,
        "currency" : "USD",
        "workingTimeStart" : "/Date(1489388400000)/",
        "workingTimeEnd" : "/Date(1489420800000)/",
        "created" : "/Date(1489301593435)/",
        "source" : "LINKEDIN",
        "campaign" : "LINKEDIN-2013-C1",
        "deactivationRequestedAt" : "/Date(1489387993435)/",
        "affiliateId" : "6d1bb779-117f-4283-b071-6e62f5111d8d",
        "vatMode" : "DECLARE_VAT",
        "displayName" : "Example Ltd. (example-ltd)"
    },
    "user" : {
        "id" : "fc663e1d-d4a9-4983-86ef-06b634783ae7",
        "createdAt" : "/Date(1489387093435)/",
        "updatedAt" : "/Date(1489391593435)/",
        "version" : 1,
        "firstName" : "Charles",
        "lastName" : "Johnson",
        "nickName" : "Charlie",
        "email" : "charles.johnson@example.com",
        "phone" : "55 345 666 789",
        "position" : "Administrator",
        "timeZone" : "America/Sao_Paulo",
        "dateFormat" : "dd.MM.yyyy",
        "timeFormat" : "HH:mm:ss",
        "weekStart" : 1,
        "language" : "pt_BR",
        "password" : "",
        "secretKey" : "userSecretKey",
        "confirmed" : false,
        "confirmedEmail" : false,
        "active" : false,
        "birthdayRemind" : "/Date(1490652000000)/",
        "workingTimeStart" : "/Date(1489388400000)/",
        "workingTimeEnd" : "/Date(1489420800000)/",
        "created" : "/Date(1489301593435)/",
        "admin" : false,
        "projectManager" : false,
        "displayName" : "Johnson Charles"
    },
    "displayName" : "Johnson Charles"
}