Import entitlements
Supported file formats:
- CSV
- ”UTF-8” encoding
- separator “;”
- XSLX
Columns to fill in:
| Column name | Description |
|---|---|
LegalEntityCode | Employee legal entity code. |
EmployeeNumber | Employee payroll number. |
LastName | Last name. |
FirstName | First name. |
| Account number or name (one column per account) | Value to import for the account defined in the header. |
Remark: A template file can be downloaded from the import page (Credit / Debit> A group of collaborators> File import).
In the event of a malformed (or unrecognized) file, no data will be imported; the problems detected will be specified in the globalErrors field.
If successful, the number of imported lines is indicated by the “successLinesCount” field; the lines in error are detailed in the lineErrors field.
Remarks: Any import made by the API is of course available in the import history. A simulation returns the same level of information, but does not trigger an import
List of errors handled
Here is the list of fatal errors, which can be returned in the globalErrors:
- Unauthorized
- FileEmpty,
- FileExtensionNotSupported,
- ColumnsFormatNotSupported,
- AccountColumnMissing,
- ColumnNamesDistinct,
- LineErrorForbiddenInStrictMode,
The list of line processing errors, which can be restored in the lineErrors:
- AccountNotFound,
- AccountsNotFound,
- AccountColumnsProcessing,
- LegalEntityCodesNotFound,
- MissingValuesForAccount,
- AccountNotAvailableForUser,
- LegalEntityCodeRequired,
- EmployeeNumberRequired,
- LoginRequired,
- LoginNotFound,
- AccountNumberRequired,
- LegalEntityNotFound,
- EmployeeNumberNotExist,
- EmployeeNumberNotInLegalEntity,
- FistNameAndLastNameNotMatching,
- FistNameNotMatching,
- LastLameNotMatching,
- FistNameAndLastNameNotMatchingEmployeeNumber,
- FistNameNotMatchingEmployeeNumber,
- LastLameNotMatchingEmployeeNumber,
- FistNameAndLastNameNotMatchingLogin,
- FistNameNotMatchingLogin,
- LastLameNotMatchingLogin,
- DuplicatedLine,
- AmbiguousLegalEntity,
- ColumnNotExists,
- LegalEntityNameNotAvailable,
- AccountNameNotUnique
The list of import generation errors:
- UnableToCreditAccount
Query Parameters
In strict mode, if the import has errors, nothing is imported. Without strict mode, the lines in error are ignored and those in success are imported.
Allows you to simulate the import. In this case, the response indicates the theoretical result of the import without any data being recorded.
Body
Description of the entries generated by the import (visible to users in the account details).
Reference date (text mode). Respect the format: yyyy-MM-ddThh: mm: ss
Response
Was this page helpful?