Add or change persons (UpdateConnector KnPerson)
UpdateConnector to add and change persons.
UpdateConnector name: KnPerson
Note:
You can retrieve a list of fields to be supplied for each UpdateConnector and generate an XML example. See the description for AFAS Online or for a local installation.
Contents |
Preparation
- Add a person (general comment)
Description
Actions that can be performed with the connector
Action |
Comment |
INSERT |
Add persons You can add addresses directly. |
UPDATE |
Change persons For an UPDATE, you deliver the key fields and the fields to be changed. You can also use an UPDATE to add bank account numbers and enter a relocation for the person. |
Not possible with the connector:
- Change contacts, delivery addresses or departments
- Delete persons
Points of attention:
- For an UPDATE, you use the 'MatchPer' field to determine how the UpdateConnector looks up the person. Use the code for the person, if it is known.
- Do not deliver the 'Bcld' field.
- When a new record is created, a response is returned. When a contact person is created, a response with the person number is returned. This applies to both SOAP (XML) and REST (JSON).
Employee code
Field: EmId
The employee code in Profit HR.
BcCo
When you add a record, this field is mandatory if 'Autonum' has the value 'False'.
P.O. Box address
Deliver the following fields for a P.O. Box address:
- PbAd (Postbus): 1
- NmNr (Huisnummer): The P.O. Box number
Deliver the postal code and city as well.
Addresses
- In an address, you must always enter the country code in the 'CoId' field.
- Deliver the fields that are needed for a complete address (this depends on the properties of the country code).
- For the first address (in practice, for a new record), you do not need to deliver a start date in the 'BeginDate' field. If an address already exists, use 'BeginDate' to indicate the effective date of the address change.
- If the 'ResZip' field has the value 'True', the system looks up the city for the postal code entered. In this case, you do in fact still need to enter a city in the 'Rs' field. If the system cannot find a city for the postal code entered, it uses the value entered in 'Rs' for the city.
Image
There are two ways to perform an UPDATE or an INSERT on an image: using a file or by converting the image to Base64 code and including the code in the XML.
- File
Field: FileName
Example: Download an XML example file
- Base64 Encoded Format
Field: FileStream
Example: Download an XML example file
Bank account number
You specify a bank account number for a person or organisation in the 'KnBankAccount' segment. You can provide an IBAN number or a bank account number (old style).
- IBAN number
Specify the following fields:
- CoId: country code
- Iban: IBAN number
- IbCk: IBAN number check
- Bank account number
Specify the following fields:
- CoId: country code
- BaAc: bank account number. The bank account number should have 10 positions. For a 9-position bank account number, you must add a leading zero.
If you supply an IBAN bank account number, Profit determines the BIC code automatically. This only happens if the following conditions are satisfied:
- The bank account number is a Dutch account number.
- The BIC code has not been entered in the XML or in Profit.
Enable OutSite portal access
For an INSERT or an UPDATE action, you provide the following fields in the 'KnPerson' node.
- AddToPortal
- EmailPortal
- AutRoleDs
Use the literal description of the authorisation role. For example, 'Beheerder klantportal'.
See also
Directly to |