Skip to content

Provider

FieldTypeIndexRequiredDescription
entityIdstringPKYThe Provider Id from the third-party system will be used in the Cloud to determine whether to update an existing Family record or create a new one.
namestringY
legalNamestring
firstNamestring
lastNamestring
middleInitialstring
dobstringThe date of birth, yyyyMMdd.
genderstringsuch as male, female,
emailstringY
phonestring
phone2string
addressobjectYaddress
mailAddressobjectaddress
sameAddressbool
ethnicitystringThe ethnicity of the family member is either hispanic-latino, no-hispanic-latino
racestringThe race of the family member is either caucasian, asian, american-indian, black, pacific-islander, other,
citizenInfostring
providerTypestringThe type of the provider is either licensed-center, infant-center, school,family,
isExemptbool
statusstringThe status of the provider is either new, pending, active, inactive, void,
ssnstring
taxIdstringY
languagestringlanguage Supported code is either en: English es: Spanish zh: Chinese.
limitedEnglishbool
licenselistsee license
ratelistsee rate
commentstring
dataobjectCustom data objects can include additional Provider attributes, with field definitions adhering to established guidelines.
disabledboolY
tagsarraystring array
categorystring
metadataobjectSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
FieldTypeIndexDescription
numberstringThe Provider license number
namestringprovider license name
capacitynumber
startDatestringformat yyyyMMdd
closeDatestringformat yyyyMMdd
statusstringlicensed, closed
insuranceAffidavitstring
minAgestring
maxAgestring
commentstring
dataobject
FieldTypeIndexDescription
namestring
childCategorystringprovider rate child category, such as infant,2-5, 6+
rateCategorystringsuch as full-time, part-time
startDatestring
endDatestring
hourlynumber
dailynumber
weeklynumber
monthlynumber
statusstringnew, pending, active, inactive, void
commentstring
dataobject
FieldTypeDescription
vendorNOstring
driversLicensestring
pvCountyIDstring
ftHoursnumber
payAbsencestring
prohibitbool
prohibitReasonstring
cellstring
communicationMethodstring
faxstring
providerAppbool
portalAccountstring
PaymentMethodstring
taxLegalFirstNamestring
taxLegalMIstring
taxLegalLastNamestring
transitionFlagstring
rcvMsgbool
rmrProviderTypestring
customerFieldsobjectSet of key-value pairs that you can attach to an object
{
"entityId": "prov123",
"name": "Provider Name",
"legalName": "Legal Provider Name",
"firstName": "John",
"lastName": "Doe",
"middleInitial": "A",
"dob": "19800101",
"gender": "male",
"email": "provider@example.com",
"phone": "123-456-7890",
"phone2": "098-765-4321",
"address": {
"zip": "12345",
"state": "CA",
"city": "Some City",
"address1": "123 Main St",
"address2": "Apt 4",
"county": "Some County",
"fullZipCode": "12345-6789",
"longitude": -120.0,
"latitude": 37.0,
"fips": "06075"
},
"mailAddress": {
"zip": "12345",
"state": "CA",
"city": "Other City",
"address1": "456 Another St",
"address2": "",
"county": "Other County",
"fullZipCode": "12345-6789",
"longitude": -121.0,
"latitude": 36.0
},
"sameAddress": false,
"ethnicity": "Ethnicity",
"race": "Race",
"citizenInfo": "Citizen Info",
"providerType": "family",
"isExempt": false,
"status": "active",
"ssn": "123-45-6789",
"taxId": "98-7654321",
"language": "en",
"limitedEnglish": false,
"comment": "Provider comment",
"data": {
"externalId": 1025,
"venderNO": "1025",
"driversLicense": "",
"reportLanguage": 1,
"pvCountyID": "",
"ftHours": 0,
"payAbsence": "3",
"prohibit": false,
"prohibitReason": "",
"cell": "(415) 599-9928",
"communicationMethod": "",
"fax": "",
"providerApp": false,
"PaymentMethod": "Check",
"taxLegalFirstName": "",
"taxLegalMI": "",
"transitionFlag": false,
"rcvMsg": false,
"rmrProviderType": "Licensed Center"
},
"disabled": false,
"tags": ["tag1", "tag2"],
"category": "Category A"
}