API docs by Redocly

Fred Silae Api (v1)

Download OpenAPI specification:

Introduction

L'API Silae fournit des points de terminaison pour la synchronisation des données de paie Silae avec la plateforme comptable Fred. Elle permet la gestion des connexions cabinet (Accounting Firm) et clients (Client Connection) avec leurs identifiants OAuth Silae, la configuration de la synchronisation par dossier (journal, période, mapping comptable), le déclenchement et le suivi des opérations de synchronisation (Operation), ainsi que la consultation des écritures de paie importées (SilaeEntryLine).

Authentication

Voir : Authentification API Inqom

SilaeConnection

Creates a Silae connection for an accounting firm.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Accounting firm enterprise identifier.

Request Body schema:
required

Connection payload (optionally including common Silae credentials).

UseAccountingFolderCommonCredentials
required
boolean
object (Credentials)

Responses

Request samples

Content type
{
  • "UseAccountingFolderCommonCredentials": true,
  • "AccountingFolderCommonCredentials": {
    }
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Gets the accounting firm connection summary attached to an enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise identifier (accounting firm dossier).

Responses

Response samples

Content type
{
  • "EnterpriseId": 0,
  • "AccountingFirmConnection": 0
}

Gets accounting firm connection details by accounting firm identifier.

Authorizations:
oauth2
path Parameters
accountingFirmId
required
integer <int32>

Accounting firm identifier.

Responses

Response samples

Content type
{
  • "AccountingFirmId": 0,
  • "AccountingFolderCommonCredentials": {
    },
  • "HasAccountingFolderCommonCredentials": true
}

Indicates whether the accounting firm declares common Silae credentials usable by its client dossiers.

Authorizations:
oauth2
path Parameters
accountingFirmId
required
integer <int32>

Accounting firm identifier.

Responses

Response samples

Content type
true

Creates a client Silae connection (client dossier) with its own credentials.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

Request Body schema:
required

Connection payload including the client-specific Silae credentials.

required
object (Credentials)

Responses

Request samples

Content type
{
  • "AppCredentials": {
    }
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Gets the client connection summary attached to an enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

Responses

Response samples

Content type
{
  • "EnterpriseId": 0,
  • "ClientConnectionId": 0,
  • "AccountingFirmConnection": 0
}

Creates a client Silae connection that inherits the common credentials of an accounting firm dossier.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier (also used as accounting folder identifier).

Request Body schema:
required

Payload identifying the accounting firm company providing the common credentials.

CompanyId
required
integer <int32>

Responses

Request samples

Content type
{
  • "CompanyId": 0
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Updates the synchronization configuration (start date, recurring day of month) of a client connection.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Request Body schema:
required

New synchronization configuration.

SyncStartDate
required
string <date-time>
SyncDayOfMonth
required
integer <int32>

Responses

Request samples

Content type
{
  • "SyncStartDate": "2019-08-24T14:15:22Z",
  • "SyncDayOfMonth": 0
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Returns the Silae pay files (dossiers) available for the given client connection's credentials.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Responses

Response samples

Content type
[
  • {
    }
]

Associates a Silae pay file (and its optional file key) with a client connection.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Request Body schema:
required

Silae file number and optional file key to associate.

SilaeFileNumber
string or null
SilaeFileKey
string or null

Responses

Request samples

Content type
{
  • "SilaeFileNumber": "string",
  • "SilaeFileKey": "string"
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Updates the Silae file key (encryption key) bound to a client connection.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Request Body schema:
required

New Silae file number and key.

SilaeFileNumber
string or null
SilaeFileKey
string or null

Responses

Request samples

Content type
{
  • "SilaeFileNumber": "string",
  • "SilaeFileKey": "string"
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Associates a Fred accounting journal with a client connection (used as the target of synchronized payroll entries).

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Request Body schema:
required

Target accounting journal identifier.

AccountingJournalId
required
integer <int32>

Responses

Request samples

Content type
{
  • "AccountingJournalId": 0
}

Response samples

Content type
{
  • "property1": null,
  • "property2": null
}

Starts the synchronization process for a single client connection (manual trigger).

Publishes a message on the synchronization queue; the run is then executed asynchronously by the WebJobs pipeline.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Responses

Deletes a client connection.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Client enterprise identifier.

clientConnectionId
required
integer <int32>

Client connection identifier.

Responses

Deletes an accounting firm connection.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise identifier (accounting firm dossier).

accountingFirmConnectionId
required
integer <int32>

Accounting firm connection identifier.

Responses