Skip to content

Provider Payment

FieldTypeIndexDescription
entityIdstringPKThe Provider EOP Id from the third-party system will be used in the Cloud to determine whether to update an existing record or create a new one.
refEntityTypestringFKwks_provider,
refDatasourceCodestringFKcc-provider,
refEntityIdstringFKprovider related entity Id
providerIdstring
providerNamestring
addressobjectAddress
emailstring
eopCodestring
payDatestringyyyyMMdd
amountnumber
statusstringThe status of the provider is either new, pending,active, processed, void,
itemslistlist of item
dataobjectCustom data objects can include additional attributes, with field definitions adhering to established guidelines.
disabledbool
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.
FieldTypeDescription
categorystring
pricenumber
quantitynumber
amountnumber
dataobject
descriptionstring
Field NameTypeDescription
contractCodestring
claimZeroCountstring
exportIdstring
exportDatestringyyyyMMdd
familyFeeAmountnumber
paymentAmountnumber
customerFieldsobjectSet of key-value pairs that you can attach to an object
Field NameTypeDescription
customerIdstringCCN CustomerId
customerNamestringCCN customerName
{
"entityId": "eop12345",
"providerId": "provider123",
"providerName": "Provider ABC",
"customerId": "customer456",
"customerName": "Customer XYZ",
"address": {
"zip": "90001",
"state": "CA",
"city": "City Name",
"address1": "1234 Street Lane",
"address2": "Suite 100",
"county": "County Name",
"fullZipCode": "90001-1234",
"longitude": -118.0,
"latitude": 34.0
},
"email": "provider@example.com",
"eopCode": "EOP789",
"payDate": "20230101",
"amount": 1500.0,
"items": [
{
"itemCode": "item001",
"description": "Item Description 1",
"quantity": 10,
"unitPrice": 100.0
},
{
"itemCode": "item002",
"description": "Item Description 2",
"quantity": 5,
"unitPrice": 200.0
}
],
"data": {
"additionalField1": "value1",
"additionalField2": "value2"
},
"disabled": false,
"tags": ["Tag1", "Tag2"],
"category": "Payment Category"
}