API docs by Redocly

Fred Api (v1)

Download OpenAPI specification:

Authentication

Voir : Authentification API Inqom

Resources

Base URL

AccessFeature

AccessFeature_HasAccess

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
resourceName
required
string

Responses

Response samples

Content type
application/json
true

Check if Access is denied on a resource for an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

resourceName
required
string^[A-Za-z]*$

Resource Name

Responses

Response samples

Content type
application/json
true

Grant access on a resource for an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

resourceName
required
string

Resource Name

Responses

Response samples

Content type
application/json
true

Remove access to a resource for an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

resourceName
required
string

Resource Name

Responses

Response samples

Content type
application/json
true

Deny access for a given enterprise and resource

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

resource
required
string

Resource Name

Responses

Enable or disable the steering feature for an enterprise (feature enabled by default, disabling denies the access and enabling removes the deny override)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
enabled
required
boolean

True to enable the feature, false to disable it

Responses

GetEnterprise Rights and disable for enterpriseId = 0

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Renvoie tous les dossiers vivants du cabinet ayant accès à la ressource, indépendamment de l'assignation de l'utilisateur courant à ces dossiers.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
resource
required
string

Responses

Response samples

Content type
application/json
[
  • 0
]

AccessFeature_GetAllExistingRights

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AccountFile

Retrieve a specific AccountFileViewModel

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountFileId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountNoteId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileUrl": "string"
}

Delete a AccountFile

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountFileId
required
integer <int32>

Responses

Retrieve a list of AccountFileViewModel related to one account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
integer <int32>
subAccountId
integer <int32>
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert AccountFile

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountNoteId
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

File

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountNoteId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileUrl": "string"
}

Detach the account files referencing GED files that were deleted: republishes Fred.Files.Domain.FileItemsDeletedDomainEvent in-process, exactly like the monolith deletion path does. Called by the SecureStore files-deleted consumer of Fred.Accounting.WebJobs (GED strangler migration) with its machine credentials. Despite its Revision-flavored name, this endpoint publishes a generic domain event with TWO downstream consumers (`IoCTestWebApi` guards both are resolvable): the Revision detachment above, and the frozen conversation-attachment tombstone (ADR 0038, D4) that marks `FileItemFrozenMetadata` rows deleted. A future rename, move, or restriction of the fileIds accepted here would silently decouple whichever consumer isn't Revision-shaped.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Associate an existing document to an account note.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
AccountNoteId
required
integer <int32>
FileId
required
integer <int32>

Responses

Request samples

Content type
{
  • "AccountNoteId": 0,
  • "FileId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountNoteId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileUrl": "string"
}

AccountingDocument

AccountingDocument_Upload

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Request Body schema: multipart/form-data
AccountingFileType
string or null
Enum: "Unknown" "ExpenseReport" "SupplierBill" "ClientBill" "Other"
Documents
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountingDocumentMapping

Retrieve Accounting Document mappings for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountingDocuments

AccountingDocuments_AttachDocument

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>
EntryId
integer or null <int32>
Date
string or null <date-time>
Reference
string or null
FileName
required
string

Responses

Response samples

Content type
application/json
0
0

AccountingDocuments_GetDocument

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
documentId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Url": "string"
}

AccountingEntryAnalytics

Get entry lines analytic for specific entryIds

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder Id

query Parameters
entryIds
Array of integers <int32> [ items <int32 > ]

The entry Ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upsert entry line analytics by entry ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array of objects (UpsertAnalyticsByEntryIdCommand)
SourceId
string or null
Source
required
string
Enum: "Unknown" "Manual" "ImportFec" "TaxReporting" "System" "PublicApi" "PermanentFileBuilding" "ANouveaux" "FixedAsset" "Grant" "Loan" "Lease" "CapPar" "CcaPca" "CurrentAccountInterest" "ImportTra" "ImportAnalytics"

Responses

Request samples

Content type
{
  • "Entries": [
    ],
  • "SourceId": "string",
  • "Source": "Unknown"
}

ADMIN ONLY

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • 0
]

AccountingEntryLinesAnalytics

Upsert entry line analytics by entry line ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers <int64> [ items <int64 > ]
required
Array of objects (UpsertAxisAnalyticsByEntryLineIdCommand)
SourceId
string or null
Source
required
string
Enum: "Unknown" "Manual" "ImportFec" "TaxReporting" "System" "PublicApi" "PermanentFileBuilding" "ANouveaux" "FixedAsset" "Grant" "Loan" "Lease" "CapPar" "CcaPca" "CurrentAccountInterest" "ImportTra" "ImportAnalytics"

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "Axises": [
    ],
  • "SourceId": "string",
  • "Source": "Unknown"
}

Post analytics on entry lines.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers <int64> unique [ items <int64 > ]
required
Array of objects (AddAxisAnalyticsCommand)
SourceId
string or null
Source
required
string
Enum: "Unknown" "Manual" "ImportFec" "TaxReporting" "System" "PublicApi" "PermanentFileBuilding" "ANouveaux" "FixedAsset" "Grant" "Loan" "Lease" "CapPar" "CcaPca" "CurrentAccountInterest" "ImportTra" "ImportAnalytics"

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "Axises": [
    ],
  • "SourceId": "string",
  • "Source": "Unknown"
}

Post analytics tags for entry lines by axis

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
axisId
required
integer <int32>
Request Body schema:
Array
EntryLineId
required
integer <int64>
required
Array of objects (TagAnalyticsByAmount)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get analytics untagged entry lines given a period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
0
0

Get outdated analytics entry lines given a period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
0
0

Outdate entry lines analytics on entry line

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Source
required
string
Enum: "Unknown" "AccountingDocument" "BankTransaction"
SourceId
required
integer <int32>
AxisIds
required
Array of integers <int32> [ items <int32 > ]
UpdatedAt
required
string <date-time>

Responses

Request samples

Content type
{
  • "Source": "Unknown",
  • "SourceId": 0,
  • "AxisIds": [
    ],
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Delete analytics from managed entry lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ]
}

Get axis and tags usages count

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Axis": [
    ]
}

AccountingFolder

Get accounting folder summary

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Siret": "string",
  • "CodeNafId": 0,
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "VatSystemId": 0,
  • "TaxSystemId": 0,
  • "ChartOfAccountId": 0,
  • "ExtendedChartOfAccountsId": 0,
  • "VatTaxObligationReference": "string",
  • "CseType": "None",
  • "AccountingType": "Engagement",
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "ContractType": "Normal",
  • "StateMode": "Active",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z",
  • "CompanyId": 0,
  • "Addresses": [
    ],
  • "TradeName": "string",
  • "UrlLogo": "string",
  • "Container": "string",
  • "AcceptProviderEmails": true,
  • "IsEligibleToAi": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "TaxSystem": {
    },
  • "Email": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Id": 0,
  • "Name": "string"
}

Create folder with roles in company Required : Email, FirstName, LastName, Roles

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
Ape
string or null [ 3 .. 6 ] characters
Deprecated
CodeNafId
integer <int32>
Siren
required
string [ 0 .. 9 ] characters
Nic
string or null [ 0 .. 5 ] characters
Name
required
string non-empty
Telephone
string or null
object (LocationCommand)
LegalFormId
integer <int32>
LegalFormDisplayName
string or null [ 0 .. 150 ] characters
TaxSystemId
integer <int32>
VatSystemId
integer <int32>
CountryCodeId
integer <int32>
AccountingType
string or null <Enumeration>
Enum: "Engagement" "Trésorerie"
ExerciseBeginDate
required
string <date-time>
ExerciseEndDate
required
string <date-time>
MissionLetterDate
string or null <date-time>
VatDeadlineDay
integer <int32>
VatTaxObligationReference
string or null
VatRateOnTaxableSales
Array of numbers or null <decimal> [ items <decimal > ]
VatRateOnTaxablePurchases
number or null <decimal>
SalesExigibilite
string or null
Enum: "Unknown" "OnReceipts" "OnDebits" "VatOptionOnDebits" "Mixed"
OwnerFirstName
required
string non-empty
OwnerLastName
required
string non-empty
ExternalId
string or null
ExternalSystemId
string or null <= 50 characters
ChartOfAccountsType
string or null
Enum: "InqomPcg" "PCAAssociatif" "PCGeneral" "PCCSE" "PCNotary" "PCAgricole"
ExtendedChartOfAccountsId
integer <int32>
AccountingFolderTypology
required
string
Enum: "BookKeeping" "RevisionClosing"
SpecificTreatmentType
string or null
Enum: "None" "Agricultural"
CseType
string or null
Enum: "None" "Small" "Medium" "Large"
IsEligibleForReducedRate
required
boolean
TaxIntracommunityNumber
string or null
HasCfeLiability
boolean
IsAgriculturalCA12Applicable
boolean
Rof
string or null
RegistrationCity
string or null
RegistrationType
string or null
Enum: "None" "A" "B"
RegistrationDate
string or null <date-time>
Activity
string or null
CreationDate
string or null <date-time>
AccountingSoftwareName
string or null
WebSite
string or null
Email
string or null
Array of objects or null (ValueTupleDateTimeDateTime)
StateMode
string or null
Enum: "Active" "Closing" "Archived" "Migration"
IsListedOnTradeDirectory
required
boolean
ShareCapital
number or null <decimal>
ParValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
HasProductionLegalAnnexesAnnualAccounts
required
boolean
HasVatKeeping
required
boolean
HasAccountingSoftware
required
boolean
IsSubjectToCvae
required
boolean
IsCvaeAdvanceDeposit
required
boolean
RofCVAE
string or null
IsMonoEstablishment
required
boolean
IsSubjectTo1330Cvae
required
boolean
AverageStaffCount
integer <int32>
ExerciceEndStaffCount
integer <int32>
PayrollManagedByCabinet
boolean
WithDepositeISTax
required
boolean
TradeName
string or null
IsAppelALaGenerositeDuPublic
boolean
IsMedicoSocial
required
boolean
ContractDistribution
required
boolean
Array of objects or null (CreateAccountingFolderStakeholderCommand)
Array of objects or null (CreateAccountingFolderAddressCommand)
object (CreateAccountingFolderLegalRepresentativeCommand)
AccountingMode
string or null
Enum: "Manual" "Auto"
ManagementMode
string or null
Enum: "TotalProduction" "PreAccounting"
ManageQuantities
boolean
ManageSellingPrice
boolean

Responses

Request samples

Content type
{
  • "Ape": "string",
  • "CodeNafId": 0,
  • "Siren": "string",
  • "Nic": "strin",
  • "Name": "string",
  • "Telephone": "string",
  • "Location": {
    },
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "TaxSystemId": 0,
  • "VatSystemId": 0,
  • "CountryCodeId": 0,
  • "AccountingType": "Engagement",
  • "ExerciseBeginDate": "2019-08-24T14:15:22Z",
  • "ExerciseEndDate": "2019-08-24T14:15:22Z",
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "VatRateOnTaxableSales": [
    ],
  • "VatRateOnTaxablePurchases": 0,
  • "SalesExigibilite": "Unknown",
  • "OwnerFirstName": "string",
  • "OwnerLastName": "string",
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "ChartOfAccountsType": "InqomPcg",
  • "ExtendedChartOfAccountsId": 0,
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "CseType": "None",
  • "IsEligibleForReducedRate": true,
  • "TaxIntracommunityNumber": "string",
  • "HasCfeLiability": true,
  • "IsAgriculturalCA12Applicable": true,
  • "Rof": "string",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "Activity": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "AccountingSoftwareName": "string",
  • "WebSite": "string",
  • "Email": "string",
  • "Exercises": [
    ],
  • "StateMode": "Active",
  • "IsListedOnTradeDirectory": true,
  • "ShareCapital": 0,
  • "ParValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "HasProductionLegalAnnexesAnnualAccounts": true,
  • "HasVatKeeping": true,
  • "HasAccountingSoftware": true,
  • "IsSubjectToCvae": true,
  • "IsCvaeAdvanceDeposit": true,
  • "RofCVAE": "string",
  • "IsMonoEstablishment": true,
  • "IsSubjectTo1330Cvae": true,
  • "AverageStaffCount": 0,
  • "ExerciceEndStaffCount": 0,
  • "PayrollManagedByCabinet": true,
  • "WithDepositeISTax": true,
  • "TradeName": "string",
  • "IsAppelALaGenerositeDuPublic": true,
  • "IsMedicoSocial": true,
  • "ContractDistribution": true,
  • "Stakeholders": [
    ],
  • "Addresses": [
    ],
  • "LegalRepresentative": {
    },
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "ManageQuantities": true,
  • "ManageSellingPrice": true
}

Response samples

Content type
application/json
0
0

Récupération des dossiers, bornée par companyId, page et size quand ils sont fournis.

Authorizations:
oauth2
query Parameters
companyId
integer <int32>
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get general information of accounting folder Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "CodeApe": "string",
  • "CodeNafId": 0,
  • "LegalFormCode": "string",
  • "LegalFormId": 0,
  • "VatSystemCode": "string",
  • "VatSystemId": 0,
  • "TaxSystemId": 0,
  • "AccountingType": "Engagement",
  • "SalesExigibilite": "Unknown",
  • "Nic": "string",
  • "Id": 0,
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "Name": "string",
  • "Street": "string",
  • "City": "string",
  • "ZipCode": "string",
  • "Siren": "string",
  • "UrlLogo": "string",
  • "ContractType": "Normal"
}

Get legal information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "ShareCapital": 0,
  • "ParValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "NaturalPersonShareholdersTotalCount": 0,
  • "NaturalPersonShareholdersTotalShareCount": 0,
  • "LegalPersonShareholdersTotalCount": 0,
  • "LegalPersonShareholdersTotalShareCount": 0,
  • "MinorShareholdersCount": 0,
  • "MinorShareholdersShareCount": 0,
  • "ShareholderPartsCompletion": {
    },
  • "MajorShareholders": [
    ],
  • "MinorShareholders": [
    ],
  • "Subsidiaries": [
    ]
}

Change capital information of accounting folder in company

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema: multipart/form-data
ShareCapital
number or null <decimal>
ParValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer or null <int64>
NaturalPersonShareholdersTotalCount
integer or null <int32>
NaturalPersonShareholdersTotalShareCount
integer or null <int32>
LegalPersonShareholdersTotalCount
integer or null <int32>
LegalPersonShareholdersTotalShareCount
integer or null <int32>
MinorShareholdersCount
integer or null <int32>
MinorShareholdersShareCount
integer or null <int32>

Responses

Get social information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "StaffCountAverage": 0,
  • "StaffCountFinal": 0,
  • "PayrollManagedByAccountingFirm": true
}

Change social information of accounting folder

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
folderId
required
integer <int32>
Request Body schema: multipart/form-data
StaffCountAverage
integer or null <int32>
StaffCountFinal
integer or null <int32>
PayrollManagedByCabinet
boolean or null

Responses

Get if accounting folder exist

Authorizations:
oauth2
path Parameters
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

Get if accounting folder container

Authorizations:
oauth2
path Parameters
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Get accounting firms related to the enterprise Deprecated

Authorizations:
oauth2
path Parameters
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get company related to the accountingFolder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get accounting folder fiscal integration informartions

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountingFolderId": 0,
  • "IsGroupHead": true,
  • "FiscalIntegratedSubsidiaries": [
    ],
  • "IsFiscalIntegrated": true,
  • "GroupHeadLegalPersonId": 0,
  • "FiscalIntegrationDateBegin": "2019-08-24T14:15:22Z",
  • "FiscalIntegrationDateEnd": "2019-08-24T14:15:22Z",
  • "OwnerFiscalIntegrationDateBegin": "2019-08-24T14:15:22Z",
  • "OwnerFiscalIntegrationDateEnd": "2019-08-24T14:15:22Z",
  • "IsFiscalGroupEligibleForReducedRate": true
}

Set fiscal integration for accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
GroupHeadLegalPersonId
integer <int32>
OwnerFiscalIntegrationDateBegin
string or null <date-time>
OwnerFiscalIntegrationDateEnd
string or null <date-time>
FiscalIntegrationDateBegin
string or null <date-time>
FiscalIntegrationDateEnd
string or null <date-time>
IsFiscalGroupEligibleForReducedRate
required
boolean
Array of objects or null (FiscalIntegratedSubsidiaryCommand)

Responses

Request samples

Content type
{
  • "GroupHeadLegalPersonId": 0,
  • "OwnerFiscalIntegrationDateBegin": "2019-08-24T14:15:22Z",
  • "OwnerFiscalIntegrationDateEnd": "2019-08-24T14:15:22Z",
  • "FiscalIntegrationDateBegin": "2019-08-24T14:15:22Z",
  • "FiscalIntegrationDateEnd": "2019-08-24T14:15:22Z",
  • "IsFiscalGroupEligibleForReducedRate": true,
  • "FiscalIntegratedSubsidiaryCommands": [
    ]
}

Assign chart of accounts to accounting folder, or link an extension of its chart of accounts to a folder that has none

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
ChartOfAccountsId
required
integer <int32>
ExtendedChartOfAccountsId
integer <int32>

Responses

Request samples

Content type
{
  • "ChartOfAccountsId": 0,
  • "ExtendedChartOfAccountsId": 0
}

Response samples

Content type
application/json
{
  • "AccountingFolderId": 0,
  • "ChartOfAccountsId": 0,
  • "ExtendedChartOfAccountsId": 0
}

Active accountingFolder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Id dossier

Responses

Admin - Get accounting folder configuration for document

Authorizations:
oauth2
query Parameters
accountingFolderId
integer <int32>
accountingFolderName
string

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "TradeName": "string",
  • "Name": "string",
  • "UrlLogo": "string",
  • "Container": "string",
  • "Siren": "string",
  • "IsEligibleToAi": true,
  • "AcceptProviderEmails": true,
  • "TaxSystem": {
    },
  • "Addresses": [
    ],
  • "AccountingType": "Engagement",
  • "ContractType": "Normal",
  • "StateMode": "Active",
  • "CompanyId": 0,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "TaxSystemId": 0,
  • "SpecificTreatmentType": "None"
}

AccountingFolderAccountingSettings

Get accounting folder settings

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0,
  • "ManageQuantities": true,
  • "ManageSellingPrice": true,
  • "ManageDueDate": true,
  • "ManagePaymentMethod": true
}

Set accounting folder settings

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
AccountLabelUpperCase
boolean
AccountNameAligned
boolean
AccountNameAlignmentMinChars
integer <int32>
ManageQuantities
boolean
ManageSellingPrice
boolean
ManageDueDate
boolean
ManagePaymentMethod
boolean

Responses

Request samples

Content type
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0,
  • "ManageQuantities": true,
  • "ManageSellingPrice": true,
  • "ManageDueDate": true,
  • "ManagePaymentMethod": true
}

Response samples

Content type
application/json
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0,
  • "ManageQuantities": true,
  • "ManageSellingPrice": true,
  • "ManageDueDate": true,
  • "ManagePaymentMethod": true
}

AccountingFolderAccountsCategories

Get accounts from categories given an accounting folder id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
startDate
string <date-time>
categoryIds
Array of strings
withoutAuxiliaryAccounts
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Move unitary an account from one heading to another given a folderId

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
Accounts
required
Array of strings unique
CategoryIdOrigin
required
string non-empty
CategoryIdDestination
required
string non-empty

Responses

Request samples

Content type
{
  • "Accounts": [
    ],
  • "CategoryIdOrigin": "string",
  • "CategoryIdDestination": "string"
}

AccountingFolderExtendedChartOfAccounts

Get the chart of accounts extension assigned to an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Get the accounting settings of the chart of accounts extension assigned to an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0
}

AccountingFolderFiscal

Get general information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "ChartOfAccountId": 0,
  • "ExtendedChartOfAccountsId": 0,
  • "CompanyId": 0,
  • "TaxSystemId": 0,
  • "TaxSystemCode": "string",
  • "TaxSystemSubCode": "string",
  • "TaxSystemDescription": "string",
  • "TaxSystemCountryCodeId": 0,
  • "TaxSystemIsBalance": true,
  • "TaxSystemWithDepositeISTax": true,
  • "TaxSystemIsEligibleForReducedRate": true,
  • "TaxSystemRof": "string",
  • "VatSystemId": 0,
  • "IsAgriculturalCA12Applicable": true,
  • "VatSystemCode": "string",
  • "VatSystemDescription": "string",
  • "VatSystemCountryCodeId": 0,
  • "VatSystemWithDeposit": true,
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "TaxIntracommunityNumber": "string",
  • "VatRateOnTaxablePurchases": 0,
  • "VatRateOnTaxableSales": [
    ],
  • "SalesExigibilite": "Unknown",
  • "IsCvaeAdvanceDeposit": true,
  • "IsSubjectToCvae": true,
  • "IsSubjectTo1330Cvae": true,
  • "IsMonoEstablishment": true,
  • "RofCVAE": "string",
  • "IsSubjectToCbCR": true,
  • "IsOverHeadCosts": true,
  • "IsTransferPricing": true,
  • "HasPayrollTaxLiability": true,
  • "HasCfeLiability": true,
  • "TaxReporterGender": "string",
  • "TaxReporterName": "string",
  • "TaxReporterTitle": "string"
}

Get Advisors information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get tax regimes for all accounting folders

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountingFoldersData

Update accounting folders data

Authorizations:
oauth2
Request Body schema:
FolderIds
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "FolderIds": [
    ]
}

Get accounting folders data

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets unprocessed accounting folders for mendatory empty accounts

Authorizations:
oauth2
query Parameters
MinExerciseBeginDate
string <date-time>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
[
  • 0
]

AccountingImportAdmin

Map accounting documents

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
string or null <binary>

Responses

Fix entries labels

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
operationId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Responses

AccountMapping

Retrieve account mapping for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve account mapping for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve line in file for this account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
mappingId
required
integer <int32>
query Parameters
pageSize
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve account mapping without template

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Soft delete the live account mappings of the accounting folder, templates and user mappings alike, by batches of 4000: call again until it returns 0

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
0
0

Retrieve the account mapping templates of the accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an account mapping template in the accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
SourceAccount
required
string or null
TargetAccount
required
string or null
RuleOrder
required
integer <int32>

Responses

Request samples

Content type
{
  • "SourceAccount": "string",
  • "TargetAccount": "string",
  • "RuleOrder": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "SourceAccount": "string",
  • "TargetAccount": "string",
  • "RuleOrder": 0,
  • "CompareType": "Exact",
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Soft delete an account mapping template of the accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
templateId
required
integer <int32>

Responses

Update destination account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
accountMappingId
required
integer <int32>
Request Body schema:
required
AccountId
required
integer <int32>
SubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0
}

Generate account mappings

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
Request Body schema:
required
Array of objects or null (AccountMappingCommand)

Responses

Request samples

Content type
{
  • "Mappings": [
    ]
}

Response samples

Content type
application/json
0
0

Soft delete the sub-accounts created by this operation that no live account mapping of the accounting folder targets

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Import initial mappings

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Initial Mapping File

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountNote

Retrieve a specific AccountNoteViewModel

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountNoteId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "ExerciseId": 0,
  • "Text": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "IsRepeatable": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    },
  • "AccountFiles": [
    ]
}

Update AccountNote

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountNoteId
required
integer <int32>
Request Body schema:
Text
string or null <= 400 characters
StartDate
string or null <date-time>
EndDate
string or null <date-time>
IsRepeatable
boolean

Responses

Request samples

Content type
{
  • "Text": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "IsRepeatable": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "ExerciseId": 0,
  • "Text": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "IsRepeatable": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    },
  • "AccountFiles": [
    ]
}

Delete a AccountNote

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountNoteId
required
integer <int32>

Responses

Retrieve a list of AccountNoteViewModel related to one account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
integer <int32>
subAccountId
integer <int32>
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert AccountNote

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
AccountId
required
integer <int32>
SubAccountId
integer <int32>
ExerciseId
integer <int32>
Text
string or null <= 400 characters
StartDate
string or null <date-time>
EndDate
string or null <date-time>
IsRepeatable
boolean

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "ExerciseId": 0,
  • "Text": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "IsRepeatable": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "ExerciseId": 0,
  • "Text": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "IsRepeatable": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    },
  • "AccountFiles": [
    ]
}

AccountRevision

Get revision of an account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
integer <int32>
subAccountId
integer <int32>
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": {
    },
  • "Tasks": [
    ],
  • "Notes": [
    ]
}

Get all account notes on a given period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get remaining work for a revision and a list of account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array of objects (AccountKeyRequest)
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "AccountIds": [
    ],
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get revision informations

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

Create accounts in an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
OperationId
integer <int32>
AtDate
string or null <date-time>
required
Array of objects (CreateSingleAccount)

Responses

Request samples

Content type
{
  • "OperationId": 0,
  • "AtDate": "2019-08-24T14:15:22Z",
  • "Accounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get accounts of PCG given an accounting folder id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
withStatus
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get accounts based on an accounting folder id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
withDeleted
required
boolean
Default: false
withStatus
boolean
Default: true
withoutAuxiliaryAccounts
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get accounts list untagged analytically

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
object (GetAccountsUntaggedAnalyticallyQueryPeriod)

Responses

Request samples

Content type
{
  • "Period": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get accounts list by system category

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Array
string
Enum: "CompteDeCharge" "CompteDeProduit" "CompteDeBilan" "CompteImmobilisation" "CompteDeCapitaux" "CompteDeBanque" "CompteAuxiliaire" "CompteDeStock" "CompteDeTiers" "CompteDeTVA" "CompteSurDebit" "CompteSurEncaissement" "CompteDAchat" "CompteDeVente" "CompteDeTVARegularisation" "CompteDeTVACollectee" "CompteDeTVADeductible" "CompteDeTVAIntraCommunautaire" "CompteDeTiersClients" "CompteDeTiersFournisseurs" "CompteDeTiersClientsParametrageTva" "CompteDeTiersFournisseursParametrageTva" "ComptesDeResultatANouveaux" "ComptesDeReportANouveaux" "ComptesSpeciaux" "ComptesScopeFournisseurs" "ComptesScopeClients" "ComptesScopeBanques" "ComptesScopeExploitations" "ComptesScopeImmo" "CompteDeTiersFournisseursImmoParametrageTva" "ComptedeTVAAutoLiquidation" "CompteDeTiersFournisseursAvancesAcomptes" "CompteDeTiersClientsAvancesAcomptes" "ComptesStockFarmeo" "CompteDeResultatANouveauxCredit" "CompteDeResultatANouveauxDebit" "ComptesDeReportANouveauxFamille" "ComptesDeResultatANouveauxFamille"

Responses

Request samples

Content type
[
  • "CompteDeCharge"
]

Response samples

Content type
application/json
[
  • {
    }
]

Get account keys list by system category

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Array
string
Enum: "CompteDeCharge" "CompteDeProduit" "CompteDeBilan" "CompteImmobilisation" "CompteDeCapitaux" "CompteDeBanque" "CompteAuxiliaire" "CompteDeStock" "CompteDeTiers" "CompteDeTVA" "CompteSurDebit" "CompteSurEncaissement" "CompteDAchat" "CompteDeVente" "CompteDeTVARegularisation" "CompteDeTVACollectee" "CompteDeTVADeductible" "CompteDeTVAIntraCommunautaire" "CompteDeTiersClients" "CompteDeTiersFournisseurs" "CompteDeTiersClientsParametrageTva" "CompteDeTiersFournisseursParametrageTva" "ComptesDeResultatANouveaux" "ComptesDeReportANouveaux" "ComptesSpeciaux" "ComptesScopeFournisseurs" "ComptesScopeClients" "ComptesScopeBanques" "ComptesScopeExploitations" "ComptesScopeImmo" "CompteDeTiersFournisseursImmoParametrageTva" "ComptedeTVAAutoLiquidation" "CompteDeTiersFournisseursAvancesAcomptes" "CompteDeTiersClientsAvancesAcomptes" "ComptesStockFarmeo" "CompteDeResultatANouveauxCredit" "CompteDeResultatANouveauxDebit" "ComptesDeReportANouveauxFamille" "ComptesDeResultatANouveauxFamille"

Responses

Request samples

Content type
[
  • "CompteDeCharge"
]

Response samples

Content type
application/json
[
  • {
    }
]

Get destination account suggestions for a transfer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
accountId
required
integer <int32>
query Parameters
subAccountId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transfer accounts to a different account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
IsAggregator
required
boolean
required
Array of objects (AccountKey)
BeginDate
required
string <date-time>
EndDate
required
string <date-time>
required
object (DestinationEntryCommand)

Responses

Request samples

Content type
{
  • "IsAggregator": true,
  • "AccountsSource": [
    ],
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "DestinationEntry": {
    }
}

Response samples

Content type
application/json
{
  • "CreatedEntryIds": [
    ],
  • "IsPartial": true,
  • "NotTransferredAccounts": [
    ]
}

Revert the overridden account label

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Update an account belonging to the chart of account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
required
Label
required
string non-empty
Dividable
boolean
Impactable
boolean

Responses

Request samples

Content type
{
  • "Label": "string",
  • "Dividable": true,
  • "Impactable": true
}

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": 0,
  • "AccountClass": 0,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "AccountDescription": "string",
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Optional": true,
  • "StatusByPeriod": [
    ],
  • "MappingAccount": 0,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "IsAux": true,
  • "IsCentralizer": true,
  • "CentralizerId": 0,
  • "Divided": "None",
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "BookOperationId": 0
}

Set a list of accounts/sub accounts as processed

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
Array of objects (AccountKey)

Responses

Request samples

Content type
{
  • "AccountKeys": [
    ]
}

Trace processed mendatory account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
ErrorMessage
string or null
Array of objects or null (AccountKey)

Responses

Request samples

Content type
{
  • "ErrorMessage": "string",
  • "AccountKeys": [
    ]
}

Add overridden accounts to an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
Array of objects (AddOverriddenAccountCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

fix accounts ADMIN

Authorizations:
oauth2

Responses

Reallocate to an account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
object (AccountKey)
required
object (AccountKey)

Responses

Request samples

Content type
{
  • "OriginAccount": {
    },
  • "DestinationAccount": {
    }
}

Response samples

Content type
application/json
0
0

AccountsCategories

Get accounts-categories given a chart Of Accounts Id

Authorizations:
oauth2
path Parameters
chartOfAccountsId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set accounts-categories given a chart Of Accounts Id

Authorizations:
oauth2
path Parameters
chartOfAccountsId
required
integer <int32>
Request Body schema:
required
Array
Id
required
string non-empty
Label
required
string non-empty
Definition
required
string non-empty
ValidFrom
string or null <date-time>
ValidTo
string or null <date-time>

Responses

Request samples

Content type
[
  • {
    }
]

Remove accounts-categories given a chart Of Accounts Id

Authorizations:
oauth2
path Parameters
chartOfAccountsId
required
integer <int32>
Request Body schema:
required
Array
Id
string or null
ValidFrom
string or null <date-time>
ValidTo
string or null <date-time>

Responses

Request samples

Content type
[
  • {
    }
]

Get accounts-categories given a accounting folder id Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountTask

Retrieve a specific AccountTaskViewModel

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountTaskId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Done": true,
  • "Description": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    }
}

Update AccountTask

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountTaskId
required
integer <int32>
Request Body schema:
Done
required
boolean
Description
required
string [ 1 .. 200 ] characters

Responses

Request samples

Content type
{
  • "Done": true,
  • "Description": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Done": true,
  • "Description": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    }
}

Delete an AccountTask

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountTaskId
required
integer <int32>

Responses

Retrieve a list of AccountTaskViewModel related to one account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
integer <int32>
subAccountId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert AccountTask

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
AccountId
required
integer <int32>
SubAccountId
integer <int32>
Done
required
boolean
Description
required
string [ 1 .. 200 ] characters

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Done": true,
  • "Description": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Done": true,
  • "Description": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    }
}

Advisors

Get advisors of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create advisor/stakeholder relation with an accounting folder Deprecated

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>
Request Body schema:
required
LegalPersonId
integer <int32>
NaturalPersonId
integer <int32>
StakeholderType
required
string
Enum: "AuditorOfAccountsTitular" "AuditorOfAccountsSubstitute" "PropertyAdministrator" "CorporateOfficer" "ProfessionalAccountant" "Advisor" "TaxReporter" "LegalRepresentative"

Responses

Request samples

Content type
{
  • "LegalPersonId": 0,
  • "NaturalPersonId": 0,
  • "StakeholderType": "AuditorOfAccountsTitular"
}

Agricultural

Add agricultural operator info for an accounting folder and a person (legal or natural)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
AccountingFolderId
required
integer <int32>
LegalPersonId
integer <int32>
NaturalPersonId
integer <int32>
MsaNumber
integer <int64>
PacageNumber
integer <int32>
BndiNumber
string or null
IsOwnerOperator
boolean

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalPersonId": 0,
  • "NaturalPersonId": 0,
  • "MsaNumber": 0,
  • "PacageNumber": 0,
  • "BndiNumber": "string",
  • "IsOwnerOperator": true
}

Response samples

Content type
application/json
0
0

Get agricultural operator info for an accounting folder and a person (legal or natural)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
personId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PacageNumber": 0,
  • "MsaNumber": 0,
  • "BndiNumber": "string",
  • "IsOwnerOperator": true
}

Update agricultural operator info for an accounting folder and a person (legal or natural)

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
agriculturalOperatorInfoId
required
integer <int32>
Request Body schema:
AccountingFolderId
required
integer <int32>
Id
required
integer <int32>
MsaNumber
integer <int64>
PacageNumber
integer <int32>
BndiNumber
string or null
IsOwnerOperator
boolean

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "Id": 0,
  • "MsaNumber": 0,
  • "PacageNumber": 0,
  • "BndiNumber": "string",
  • "IsOwnerOperator": true
}

AnalyticBalances

Get analytic balances by tag ids.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query

required
object (GetAnalyticBalancesQueryPeriod)
object (GetAnalyticBalancesQueryPeriod)
object (GetAnalyticBalancesQueryPeriod)
ANouveauFilter
required
string
Enum: "Normal" "Without" "Only" "DontCare"
Aggregation
required
string
Enum: "AuxAggregated" "AuxDetailed" "AuxAggregatedAndDetailed" "Pcg" "WithoutAux" "AggregationOnPcAccountWithDetails" "AggregationOnPcAccountWithoutDetails"
BalanceScope
required
string
Enum: "Impacted" "Created" "UnBalanced" "UnReviewed" "BalancedWithUnlettered" "Abnormal" "AllAccount" "AllImpactableAccounts" "Optional" "Mandatory"
TagIds
Array of integers or null <int32> [ items <int32 > ]
AccountFilterIncludesPreviousRange
required
boolean
AuxAccountId
integer <int32>
AccountIds
Array of integers or null <int32> [ items <int32 > ]
WithTotalAccount
boolean

Responses

Request samples

Content type
{
  • "Current": {
    },
  • "Previous": {
    },
  • "PreviousN2": {
    },
  • "ANouveauFilter": "Normal",
  • "Aggregation": "AuxAggregated",
  • "BalanceScope": "Impacted",
  • "TagIds": [
    ],
  • "AccountFilterIncludesPreviousRange": true,
  • "AuxAccountId": 0,
  • "AccountIds": [
    ],
  • "WithTotalAccount": true
}

Response samples

Content type
application/json
{
  • "Balances": [
    ]
}

Get analytic balances for each provided tag id.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query

required
object (GetAnalyticBalancesByTagIdQueryPeriod)
object (GetAnalyticBalancesByTagIdQueryPeriod)
ANouveauFilter
required
string
Enum: "Normal" "Without" "Only" "DontCare"
Aggregation
required
string
Enum: "AuxAggregated" "AuxDetailed" "AuxAggregatedAndDetailed" "Pcg" "WithoutAux" "AggregationOnPcAccountWithDetails" "AggregationOnPcAccountWithoutDetails"
BalanceScope
required
string
Enum: "Impacted" "Created" "UnBalanced" "UnReviewed" "BalancedWithUnlettered" "Abnormal" "AllAccount" "AllImpactableAccounts" "Optional" "Mandatory"
TagIds
Array of integers or null <int32> [ items <int32 > ]
AccountFilterIncludesPreviousRange
required
boolean
AuxAccountId
integer <int32>
AccountIds
Array of integers or null <int32> [ items <int32 > ]
WithTotalAccount
boolean

Responses

Request samples

Content type
{
  • "Current": {
    },
  • "Previous": {
    },
  • "ANouveauFilter": "Normal",
  • "Aggregation": "AuxAggregated",
  • "BalanceScope": "Impacted",
  • "TagIds": [
    ],
  • "AccountFilterIncludesPreviousRange": true,
  • "AuxAccountId": 0,
  • "AccountIds": [
    ],
  • "WithTotalAccount": true
}

Response samples

Content type
application/json
{
  • "BalancesByTagId": [
    ]
}

Get analytic balance summarize by axis Id.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query

required
object (GetAnalyticBalancesSummaryByAxisIdsQueryPeriod)
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"

Responses

Request samples

Content type
{
  • "Period": {
    },
  • "AccountScope": "General"
}

Response samples

Content type
application/json
{
  • "Summaries": [
    ]
}

Get analytic balance by axis Id.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
axisId
required
integer <int32>
Request Body schema:
required

query

required
object (GetAnalyticBalanceByAxisIdQueryPeriod)
object (GetAnalyticBalanceByAxisIdQueryPeriod)
object (GetAnalyticBalanceByAxisIdQueryPeriod)
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
Aggregation
required
string
Enum: "AuxAggregated" "AuxDetailed" "AuxAggregatedAndDetailed" "Pcg" "WithoutAux" "AggregationOnPcAccountWithDetails" "AggregationOnPcAccountWithoutDetails"
AuxAccountId
integer <int32>
WithTags
string or null
Enum: "Untagged" "Tagged" "All"

Responses

Request samples

Content type
{
  • "Period": {
    },
  • "PeriodNMinusOne": {
    },
  • "PeriodNMinusTwo": {
    },
  • "AccountScope": "General",
  • "Aggregation": "AuxAggregated",
  • "AuxAccountId": 0,
  • "WithTags": "Untagged"
}

Response samples

Content type
application/json
{
  • "AxisId": 0,
  • "Tags": [
    ]
}

Get analytic balance crossed on two axes.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
axisId1
required
integer <int32>
axisId2
required
integer <int32>
Request Body schema:
required
required
object (GetAnalyticBalanceByAxisIdQueryPeriod)
object (GetAnalyticBalanceByAxisIdQueryPeriod)
object (GetAnalyticBalanceByAxisIdQueryPeriod)
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
Aggregation
required
string
Enum: "AuxAggregated" "AuxDetailed" "AuxAggregatedAndDetailed" "Pcg" "WithoutAux" "AggregationOnPcAccountWithDetails" "AggregationOnPcAccountWithoutDetails"
AuxAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "Period": {
    },
  • "PeriodNMinusOne": {
    },
  • "PeriodNMinusTwo": {
    },
  • "AccountScope": "General",
  • "Aggregation": "AuxAggregated",
  • "AuxAccountId": 0
}

Response samples

Content type
application/json
{
  • "AxisId1": 0,
  • "AxisId2": 0,
  • "Tags": [
    ],
  • "Table": {
    }
}

Export analytic balances.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
exportType
string
Value: "Xlsx"
Request Body schema:
required

query

AxisId
required
integer <int32>
required
object (ExportAnalyticBalancesQueryPeriod)
object (ExportAnalyticBalancesQueryPeriod)
object (ExportAnalyticBalancesQueryPeriod)
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
WithTags
string or null
Enum: "Untagged" "Tagged" "All"

Responses

Request samples

Content type
{
  • "AxisId": 0,
  • "Period": {
    },
  • "PeriodNMinusOne": {
    },
  • "PeriodNMinusTwo": {
    },
  • "AccountScope": "General",
  • "WithTags": "Untagged"
}

Response samples

Content type
application/json
"string"

AnalyticsMapping

Retrieve analytics mappings for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update destination analytics mapping

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
analyticsMappingId
required
integer <int32>
Request Body schema:
required
AxisId
required
integer <int32>
TagId
required
integer <int32>

Responses

Request samples

Content type
{
  • "AxisId": 0,
  • "TagId": 0
}

ANouveau

Detail an A-Nouveau for an account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
anEntryId
required
integer <int32>
Request Body schema:
required
required
Array of objects (AccountKey)

Responses

Request samples

Content type
{
  • "Accounts": [
    ]
}

Generate "A Nouveau" based from previous exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise id to search

query Parameters
previousClosedExerciseId
required
integer <int32>

id of previous exercise on which the AN is based

journalId
integer <int32>

Optionnal journalId

forceIfEvenLetteringsNotBalanced
boolean
ignoreWarnings
boolean

Responses

Delete A-Nouveau Entry Starting From

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
start
required
string <date-time>

Responses

Checks wether accounting folder contain AN entries over some period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
true

Deletes A-Nouveau entries not in Operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
operationId
required
integer <int32>

Responses

Audit

Retrieve all documents from DocumentDb for given enterprise

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>
userId
integer <int32>
entityChangeType
string
Enum: "Technical" "BookEntry" "BookBalance" "User" "Ticket" "Planning" "BankinItem" "AccountingFiles" "FileItem" "Email" "Comment" "Invite" "Enterprise" "SupportAction" "AssignUserRole" "BookEntryLine" "BookAccountState" "InboundMail" "AssignationConfirmation" "NotificationToSale" "DownloadFiles" "NewMessage" "FeatureAccess" "Unknown"
entityAction
string
Enum: "CreateBookEntry" "UpdateBookEntry" "Match" "Unmatch" "ImportedBookEntry" "ValidatedBookEntry" "CreateBookLedger" "UpdateBookLedger" "CreateUser" "UpdateUser" "ActivateUser" "DeactivateUser" "ResetPassword" "CreateTicket" "CreateComment" "ResolveTicket" "ReopenTicket" "PersonalNotifyTicket" "CreateTicketEmergency" "CreateCommentEmergency" "DeleteAbsence" "DeleteVacation" "CreateAbsence" "CreateVacation" "CountDoublonAccountingFiles" "AccountingFileUploaded" "VacationValidated" "CreateAccountingFile" "CreateAdministratifFile" "VacationRejected" "UpdateAccountingFile" "UpdateAdministratifFile" "UpdateFileType" "UpdateThumbUrl" "UpdatedByCheckSumJobs" "UpdatedByDropBoxJobs" "UpdatedByMagasJobs" "SoftDeleteFile" "RealDeleteFile" "SoftDeletedByMagasJobs" "BankinStateNeedHumanAction" "BankinStateInvalidCredentials" "UpdatedByOcrJobs" "CreatePrivateNote" "MessagingReplyTo" "ReceivedEmailError" "FileIsAttachedToTicket" "TicketWithoutAnswerAfter24H" "MentionPrivate" "MentionPublic" "CreateNote" "FileIsAttachedToRevision" "NewUserInFred" "ExistedUserInvitation" "NewCollaboratorEmploye" "ExistedCollaboratorEmploye" "NewCollaboratorDaf" "ExistedCollaboratorDaf" "NewCollaboratorFreelancer" "ExistedCollaboratorFreelancer" "NewCollaboratorCeo" "ExistedCollaboratorCeo" "NewCollaboratorCabinet" "ExistedCollaboratorCabinet" "EnterpriseArchive" "EnterpriseClose" "EnterpriseActivate" "EnterpriseInactivate" "EnterpriseCreate" "EnterpriseNameUpdate" "EnterpriseSoftDelete" "EnterpriseUndelete" "EnterpriseAccountingModeUpdate" "EnterpriseTypeToDemo" "EnterpriseTypeToFake" "EnterpriseTypeToTrial" "EnterpriseTypeToNormal" "EnterpriseToIa" "EnterpriseToManual" "EnterpriseToMaga" "EnterpriseToMagaToIa" "EnterpriseToPreAccounting" "EnterpriseToTotalProduction" "ChangeAccountingType" "AssignmentToAccountant" "AssignmentToCeoDaf" "DeassignmentToAccountant" "Move" "Remove" "DeassignmentToClient" "PublishTickets" "UpdateBookAccountStateStatusAnomaly" "UpdateBookAccountStateStatusValidate" "UpdateBookAccountStateComment" "ReviseEntryLine" "UnreviseEntryLine" "NewCollaborator" "WelcomeEmail" "InviteForRegister" "UnsupportedMultipleRecipients" "UnsupportedReceivedEmailFormat" "UnAuthorizedEmail" "ReceiveMailReport" "NoAttachmentFound" "ForwardEmail" "MailToPdfReport" "ConfirmationToClient" "ConfirmationToChiefAccountant" "ConfirmationToChiefMission" "Declined" "Voided" "Completed" "Confirmed" "DownloadFiles" "NewMessage" "GrantFeatureAccess" "RemoveFeatureAccess" "DenyFeatureAccess"
entityId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all documents from DocumentDb for given enterprise

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all documents from DocumentDb for given user

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>
userId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve documents for specific entity type for specified enterprise Deprecated

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>
userId
integer <int32>
entityChangeType
string
Enum: "Technical" "BookEntry" "BookBalance" "User" "Ticket" "Planning" "BankinItem" "AccountingFiles" "FileItem" "Email" "Comment" "Invite" "Enterprise" "SupportAction" "AssignUserRole" "BookEntryLine" "BookAccountState" "InboundMail" "AssignationConfirmation" "NotificationToSale" "DownloadFiles" "NewMessage" "FeatureAccess" "Unknown"
entityAction
string
Enum: "CreateBookEntry" "UpdateBookEntry" "Match" "Unmatch" "ImportedBookEntry" "ValidatedBookEntry" "CreateBookLedger" "UpdateBookLedger" "CreateUser" "UpdateUser" "ActivateUser" "DeactivateUser" "ResetPassword" "CreateTicket" "CreateComment" "ResolveTicket" "ReopenTicket" "PersonalNotifyTicket" "CreateTicketEmergency" "CreateCommentEmergency" "DeleteAbsence" "DeleteVacation" "CreateAbsence" "CreateVacation" "CountDoublonAccountingFiles" "AccountingFileUploaded" "VacationValidated" "CreateAccountingFile" "CreateAdministratifFile" "VacationRejected" "UpdateAccountingFile" "UpdateAdministratifFile" "UpdateFileType" "UpdateThumbUrl" "UpdatedByCheckSumJobs" "UpdatedByDropBoxJobs" "UpdatedByMagasJobs" "SoftDeleteFile" "RealDeleteFile" "SoftDeletedByMagasJobs" "BankinStateNeedHumanAction" "BankinStateInvalidCredentials" "UpdatedByOcrJobs" "CreatePrivateNote" "MessagingReplyTo" "ReceivedEmailError" "FileIsAttachedToTicket" "TicketWithoutAnswerAfter24H" "MentionPrivate" "MentionPublic" "CreateNote" "FileIsAttachedToRevision" "NewUserInFred" "ExistedUserInvitation" "NewCollaboratorEmploye" "ExistedCollaboratorEmploye" "NewCollaboratorDaf" "ExistedCollaboratorDaf" "NewCollaboratorFreelancer" "ExistedCollaboratorFreelancer" "NewCollaboratorCeo" "ExistedCollaboratorCeo" "NewCollaboratorCabinet" "ExistedCollaboratorCabinet" "EnterpriseArchive" "EnterpriseClose" "EnterpriseActivate" "EnterpriseInactivate" "EnterpriseCreate" "EnterpriseNameUpdate" "EnterpriseSoftDelete" "EnterpriseUndelete" "EnterpriseAccountingModeUpdate" "EnterpriseTypeToDemo" "EnterpriseTypeToFake" "EnterpriseTypeToTrial" "EnterpriseTypeToNormal" "EnterpriseToIa" "EnterpriseToManual" "EnterpriseToMaga" "EnterpriseToMagaToIa" "EnterpriseToPreAccounting" "EnterpriseToTotalProduction" "ChangeAccountingType" "AssignmentToAccountant" "AssignmentToCeoDaf" "DeassignmentToAccountant" "Move" "Remove" "DeassignmentToClient" "PublishTickets" "UpdateBookAccountStateStatusAnomaly" "UpdateBookAccountStateStatusValidate" "UpdateBookAccountStateComment" "ReviseEntryLine" "UnreviseEntryLine" "NewCollaborator" "WelcomeEmail" "InviteForRegister" "UnsupportedMultipleRecipients" "UnsupportedReceivedEmailFormat" "UnAuthorizedEmail" "ReceiveMailReport" "NoAttachmentFound" "ForwardEmail" "MailToPdfReport" "ConfirmationToClient" "ConfirmationToChiefAccountant" "ConfirmationToChiefMission" "Declined" "Voided" "Completed" "Confirmed" "DownloadFiles" "NewMessage" "GrantFeatureAccess" "RemoveFeatureAccess" "DenyFeatureAccess"
entityId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve specific document from DocumentDb for given enterprise and fileId

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>
fileId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "enterpriseId": 0,
  • "userId": 0,
  • "userName": "string",
  • "urlAvatar": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entities": [
    ],
  • "message": "string"
}

Retrieve documents for specific entity type for specified enterprise

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
entityChangeType
string
Enum: "Technical" "BookEntry" "BookBalance" "User" "Ticket" "Planning" "BankinItem" "AccountingFiles" "FileItem" "Email" "Comment" "Invite" "Enterprise" "SupportAction" "AssignUserRole" "BookEntryLine" "BookAccountState" "InboundMail" "AssignationConfirmation" "NotificationToSale" "DownloadFiles" "NewMessage" "FeatureAccess" "Unknown"
entityId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Balances

Get balance of an Accounting Folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:

query

BalanceSnapshotId
integer <int32>
required
object (GetBalancesQueryPeriod)
object (GetBalancesQueryPeriod)
object (GetBalancesQueryPeriod)
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
Filter
required
string
Enum: "Impacted" "Created" "UnBalanced" "UnReviewed" "BalancedWithUnlettered" "Abnormal" "AllAccount" "AllImpactableAccounts" "Optional" "Mandatory"
FilterIncludePrevious
required
boolean
ANouveauFilter
required
string
Enum: "Normal" "Without" "Only" "DontCare"
Aggregation
required
string
Enum: "AuxAggregated" "AuxDetailed" "AuxAggregatedAndDetailed" "Pcg" "WithoutAux" "AggregationOnPcAccountWithDetails" "AggregationOnPcAccountWithoutDetails"
AuxAccountId
integer <int32>
WithRevision
required
boolean
WithAccount
boolean
WithQuantities
boolean
WithTotalAccount
boolean
AccountIds
Array of integers or null <int32> [ items <int32 > ]
ExcludeJournalIds
Array of integers or null <int32> [ items <int32 > ]
OnlyJournalIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "BalanceSnapshotId": 0,
  • "Current": {
    },
  • "Previous": {
    },
  • "PreviousN2": {
    },
  • "AccountScope": "General",
  • "Filter": "Impacted",
  • "FilterIncludePrevious": true,
  • "ANouveauFilter": "Normal",
  • "Aggregation": "AuxAggregated",
  • "AuxAccountId": 0,
  • "WithRevision": true,
  • "WithAccount": true,
  • "WithQuantities": true,
  • "WithTotalAccount": true,
  • "AccountIds": [
    ],
  • "ExcludeJournalIds": [
    ],
  • "OnlyJournalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "Balances": [
    ]
}

Export Balance with all auxiliary

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
string <date-time>

YYYY-MM-DD (renamed beginDate for unknown reason)

endDate
string <date-time>

YYYY-MM-DD

previousStartDate
string <date-time>
previousEndDate
string <date-time>
previousN2StartDate
string <date-time>
previousN2EndDate
string <date-time>
balanceSnapshotId
integer <int32>
balanceScope
string
Default: "Impacted"
Enum: "Impacted" "Created" "UnBalanced" "UnReviewed" "BalancedWithUnlettered" "Abnormal" "AllAccount" "AllImpactableAccounts" "Optional" "Mandatory"
accountFilterIncludesPreviousRange
boolean
Default: false
output
string
Default: "Xlsx"
Enum: "Csv" "Xlsx" "Pdf"
separator
string
Default: ";"
ids
Array of integers <int32> [ items <int32 > ]
withTotals
boolean
Default: false

Affiche ou non (défaut) les totaux intermédiaires : sous-totaux par classe, TOTAL GÉNÉRAL, RÉSULTAT COMPTABLE. Sans effet sur l'export PDF.

Responses

Response samples

Content type
application/json
"string"

Export Balance with all auxiliary using post to avoid large ids list

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
EndDate
required
string <date-time>
PreviousStartDate
string or null <date-time>
PreviousEndDate
string or null <date-time>
PreviousN2StartDate
string or null <date-time>
PreviousN2EndDate
string or null <date-time>
BalanceSnapshotId
integer <int32>
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
BalanceScope
required
string
Enum: "Impacted" "Created" "UnBalanced" "UnReviewed" "BalancedWithUnlettered" "Abnormal" "AllAccount" "AllImpactableAccounts" "Optional" "Mandatory"
AccountFilterIncludesPreviousRange
required
boolean
OutputFormat
required
string
Enum: "Csv" "Xlsx" "Pdf"
Separator
string or null
BookAccountIds
Array of integers or null <int32> [ items <int32 > ]
AccountFilter
string or null
WithTotals
boolean

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "PreviousStartDate": "2019-08-24T14:15:22Z",
  • "PreviousEndDate": "2019-08-24T14:15:22Z",
  • "PreviousN2StartDate": "2019-08-24T14:15:22Z",
  • "PreviousN2EndDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotId": 0,
  • "AccountScope": "General",
  • "BalanceScope": "Impacted",
  • "AccountFilterIncludesPreviousRange": true,
  • "OutputFormat": "Csv",
  • "Separator": "string",
  • "BookAccountIds": [
    ],
  • "AccountFilter": "string",
  • "WithTotals": true
}

Response samples

Content type
application/json
"string"

Get balance of account by Id of period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
required
integer <int32>
subAccountId
integer <int32>
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "Balance": 0,
  • "DebitAmount": 0,
  • "CreditAmount": 0,
  • "NbLine": 0,
  • "FirstEntryDate": "2019-08-24T14:15:22Z",
  • "LastEntryDate": "2019-08-24T14:15:22Z",
  • "AccountId": 0,
  • "SubAccountId": 0
}

Export Balance with all auxiliaries balances in other pages

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>
prevBeginDate
string <date-time>
prevEndDate
string <date-time>
prevN2BeginDate
string <date-time>
prevN2EndDate
string <date-time>
balanceSnapshotId
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Return Profit-Loss

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>
previousBeginDate
string <date-time>
previousEndDate
string <date-time>
previousN2BeginDate
string <date-time>
previousN2EndDate
string <date-time>
balanceSnapshotId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Current": 0,
  • "Previous": 0,
  • "PreviousN2": 0
}

BalanceSnapshots

Get list of balances snapshots

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new balance snapshot

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Name
required
string non-empty
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Period": {
    }
}

Update balance snapshot title

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
required
Name
required
string non-empty

Responses

Request samples

Content type
{
  • "Name": "string"
}

Delete a balance snapshot

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Create a new balance snapshot from an import

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Name
required
string or null
BeginDate
required
string <date-time>
EndDate
required
string <date-time>
required
Array of objects or null (CreateBalanceSnapshotContentFromImportCommand)

Responses

Request samples

Content type
{
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "ContentCommands": [
    ]
}

BankAssociation

Get banks / bank accounts and their association by enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get banks / bank accounts and their association by enterprise and accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

query Parameters
accountIds
Array of integers <int32> [ items <int32 > ]

The list of bank account Ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get banks / bank accounts and their association by enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

bankAccountId
required
integer <int32>

The bank account Id

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "JournalId": 0,
  • "SourceId": 0,
  • "Type": "None",
  • "IsSynchronizing": true,
  • "MergeDate": "2019-08-24T14:15:22Z",
  • "LastSynchronizationDate": "2019-08-24T14:15:22Z",
  • "LastReconciliationDate": "2019-08-24T14:15:22Z",
  • "IsProtected": true,
  • "IsActive": true,
  • "SyncStartDate": "2019-08-24T14:15:22Z"
}

Associate the bank account to a new sub account Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

bankAccountId
required
integer <int32>

bank account id

Responses

Response samples

Content type
application/json
{
  • "SourceId": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "BankinBankId": 0,
  • "Name": "string",
  • "Balance": 0.1,
  • "CurrencyCode": "string",
  • "Type": "string",
  • "AccountUpdatedAt": "2019-08-24T14:15:22Z",
  • "Description": "string",
  • "IsActive": true,
  • "Association": {
    }
}

Associate the bank account to a selected sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

bankAccountId
required
integer <int32>

bank account id

Request Body schema:
EnterpriseId
required
integer <int32>
BankAccountId
required
integer <int32>
AccountId
required
integer <int32>
SubAccountId
integer <int32>
JournalId
integer <int32>
SyncStartDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "BankAccountId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "JournalId": 0,
  • "SyncStartDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "SourceId": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "BankinBankId": 0,
  • "Name": "string",
  • "Balance": 0.1,
  • "CurrencyCode": "string",
  • "Type": "string",
  • "AccountUpdatedAt": "2019-08-24T14:15:22Z",
  • "Description": "string",
  • "IsActive": true,
  • "Association": {
    }
}

Dissociate sub account and bank account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

bankAccountId
required
integer <int32>

The bank account Id

Responses

Validate the new bank association with selected sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

bankAccountId
required
integer <int32>

bank account id

Request Body schema:
EnterpriseId
required
integer <int32>
BankAccountId
required
integer <int32>
AccountId
required
integer <int32>
SubAccountId
integer <int32>
JournalId
integer <int32>
SyncStartDate
string or null <date-time>
AssociationId
integer <int32>

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "BankAccountId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "JournalId": 0,
  • "SyncStartDate": "2019-08-24T14:15:22Z",
  • "AssociationId": 0
}

Response samples

Content type
application/json
{
  • "AccountBalance": 0,
  • "BankBalance": 0,
  • "StartDateMinimum": "2019-08-24T14:15:22Z",
  • "BookEntryEndDate": "2019-08-24T14:15:22Z",
  • "BankBalanceDate": "2019-08-24T14:15:22Z"
}

Dissociate sub account and bank account Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

subAccountId
required
integer <int32>

The sub account id

query Parameters
accountId
integer <int32>

Account Id

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "JournalId": 0,
  • "SourceId": 0,
  • "Type": "None",
  • "IsSynchronizing": true,
  • "MergeDate": "2019-08-24T14:15:22Z",
  • "LastSynchronizationDate": "2019-08-24T14:15:22Z",
  • "LastReconciliationDate": "2019-08-24T14:15:22Z",
  • "IsProtected": true,
  • "IsActive": true,
  • "SyncStartDate": "2019-08-24T14:15:22Z"
}

Get associated bank account for the sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

subAccountId
required
integer <int32>

The sub account id

query Parameters
accountId
integer <int32>

Account Id

Responses

Response samples

Content type
application/json
{
  • "IsConnected": true,
  • "BankName": "string",
  • "BankId": 0,
  • "Description": "string",
  • "Name": "string",
  • "Id": 0,
  • "SynchronizationStatus": "Synchronizing",
  • "DisplayName": "string"
}

Update merge date for an association

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

subAccountId
required
integer <int32>

SubAccount Id

Request Body schema: multipart/form-data
accountId
integer or null <int32>

Account Id

newMergeDate
string or null <date-time>

New merge date

Responses

BankAssociation_GetOrCreateBankJournal

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Type": "Buy",
  • "TypeDescription": "string",
  • "Name": "string",
  • "Description": "string",
  • "EnterpriseId": 0
}

BankAssociation_GetOrCreateCounterPartyDisbursementAccount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Code": "string",
  • "Label": "string",
  • "AccountId": 0,
  • "AccountNumber": 0,
  • "Id": 0,
  • "Name": "string"
}

BankAssociation_GetOrCreateCounterPartyReceiptAccount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Code": "string",
  • "Label": "string",
  • "AccountId": 0,
  • "AccountNumber": 0,
  • "Id": 0,
  • "Name": "string"
}

Set Association Sync Status To Start

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
associationId
required
integer <int32>

Responses

Set Association Sync Status To End

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
associationId
required
integer <int32>

Responses

Update flag IsProtected for an association given an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting folder Id

query Parameters
isProtected
boolean

Set whether the account should be protected or not.

Responses

Update flag IsProtected for an association given a cabinet

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>

Cabinet Id

query Parameters
isProtected
boolean

Set whether the account should be protected or not.

Responses

Bankin

Get All Banks

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a bank connection Url Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

id
required
integer <int32>

Bank id

query Parameters
returnUrl
string

Optionnal string to manually redirect to a Url after bankin login

Responses

Response samples

Content type
application/json
{
  • "Url": "string",
  • "RequestConnectionId": "string"
}

Get a bank connection Url

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Responses

Response samples

Content type
application/json
{
  • "Url": "string",
  • "RequestConnectionId": "string"
}

Receives a redirect callback from the Bridge banking service after user authentication.

Authorizations:
oauth2
query Parameters
user_uuid
string

User uuid from redirect

item_id
integer <int64>

Item id from redirect

success
boolean
step
string

Responses

Get a bank connection with its optional accounts and states

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
bankId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "BankId": 0,
  • "Name": "string",
  • "Status": "string"
}

Delete a bank connection

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

bankConnectionId
required
integer <int32>

Bank id

Responses

Change a Bankin account state

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Array
Id
required
integer <int32>
IsActive
required
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
0
0

Get Account by id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "SourceId": 0,
  • "EnterpriseId": 0,
  • "BankId": 0,
  • "Name": "string",
  • "Balance": 0.1,
  • "CurrencyCode": "string",
  • "Type": "string",
  • "State": "string",
  • "Description": "string",
  • "IsVisible": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Provider": "string",
  • "Iban": "string",
  • "IsValidIban": true,
  • "Bic": "string"
}

Change bankin account(s) description

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Array
Id
required
integer <int32>
Description
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Get Transactions

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
integer <int32>
beginDate
string <date-time>
endDate
string <date-time>
searchTextOrAmount
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Transactions balance

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
string <date-time>
endDate
string <date-time>
accountId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "IncomesAmount": 0.1,
  • "ExpensesAmount": 0.1,
  • "Amount": 0.1,
  • "Items": [
    ]
}

BankMerge

Get the information about if it's possible to merge the two account directly or need to move some lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the id of the concerned enterprise

bankingSubAccountId
required
integer <int32>

The managed sub account id

accountingSubAccountId
required
integer <int32>

The sub account id

query Parameters
accountId
integer <int32>

Accounting Account Id

Responses

Response samples

Content type
application/json
{
  • "MergeDate": "2019-08-24T14:15:22Z",
  • "IsOk": true,
  • "Balance": 0
}

Get the result of the comparison between the banking sub account and the sub account at the merge date

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the id of the concerned enterprise

bankingSubAccountId
required
integer <int32>

The managed sub account id

accountingSubAccountId
required
integer <int32>

The sub account id

query Parameters
accountId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "MergeDate": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "MergedEntryLinesBalance": 0,
  • "Gap": 0
}

Final step to merge a bank account with a sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the id of the concerned enterprise

bankingSubAccountId
required
integer <int32>

The managed sub account id

accountingSubAccountId
required
integer <int32>

The sub account id

query Parameters
sourceAccountId
integer <int32>
destinationAccountId
integer <int32>
Request Body schema:

Array of line ids which needs to be moved around the merge date

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "JournalId": 0,
  • "SourceId": 0,
  • "Type": "None",
  • "IsSynchronizing": true,
  • "MergeDate": "2019-08-24T14:15:22Z",
  • "LastSynchronizationDate": "2019-08-24T14:15:22Z",
  • "LastReconciliationDate": "2019-08-24T14:15:22Z",
  • "IsProtected": true,
  • "IsActive": true,
  • "SyncStartDate": "2019-08-24T14:15:22Z"
}

BankMerge_CheckDateBeforeMerge

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
bankingSubAccountId
required
integer <int32>
accountingSubAccountId
required
integer <int32>

Responses

BankReconciliation

Get matched bank reconciliation information by source

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
sourceType
string
Enum: "Unknown" "WaitingLine" "Sellsy" "CapPar" "CcaPca" "Loan" "Lease" "QuickBooks" "PublicApi" "VatDeclaration" "ANouveau" "FixedAsset" "Grant" "Meg" "Silae" "Billing" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Reverse" "ViDA" "EdiFlux"
sourceId
string
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get unmatched bank reconciliation information by source

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
sourceType
string
Enum: "Unknown" "WaitingLine" "Sellsy" "CapPar" "CcaPca" "Loan" "Lease" "QuickBooks" "PublicApi" "VatDeclaration" "ANouveau" "FixedAsset" "Grant" "Meg" "Silae" "Billing" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Reverse" "ViDA" "EdiFlux"
sourceIds
Array of strings
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get entry lines by account number

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
account
required
integer <int32>
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BankSynchronization

Get Entry by Transaction Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

transactionId
required
integer <int32>

The transaction Id

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TransactionId": 0,
  • "Label": "string",
  • "EnterpriseId": 0,
  • "UpdateByUserId": 0,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Lines": [
    ],
  • "Date": "2019-08-24T14:15:22Z",
  • "JournalId": 0,
  • "ValidationDate": "2019-08-24T14:15:22Z"
}

Get Entries by transactions id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:

Transactions

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

Synchronize banking transactions with entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:

Create Entry Command

TransactionId
required
integer <int32>
FileId
integer <int32>
EnterpriseId
required
integer <int32>
Date
required
string <date-time>
DocRef
string or null
Label
string or null <= 256 characters
Source
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
SourceId
string or null
JournalId
required
integer <int32>
required
Array of objects (CreateEntryLineCommand)
DueDate
string or null <date-time>
PaymentMethod
string or null <= 200 characters

Responses

Request samples

Content type
{
  • "TransactionId": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "DocRef": "string",
  • "Label": "string",
  • "Source": "ByUser",
  • "SourceId": "string",
  • "JournalId": 0,
  • "Lines": [
    ],
  • "DueDate": "2019-08-24T14:15:22Z",
  • "PaymentMethod": "string"
}

Synchronize banking transactions with entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:
Id
required
integer <int32>
Date
required
string <date-time>
Label
required
string [ 1 .. 256 ] characters
required
Array of objects (UpdateBankEntryLineCommand)
DeletedAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "Label": "string",
  • "Lines": [
    ],
  • "DeletedAt": "2019-08-24T14:15:22Z"
}

Synchronize banking transactions with entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:
required
Array of objects (CreateBankEntryCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Synchronize banking transactions with entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:
Array
Id
required
integer <int32>
Date
required
string <date-time>
Label
required
string [ 1 .. 256 ] characters
required
Array of objects (UpdateBankEntryLineCommand)
DeletedAt
string or null <date-time>

Responses

Request samples

Content type
[
  • {
    }
]

Link existing entries to banking transactions, after a FEC import

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

Request Body schema:
required

The links to create

Array of objects or null (TransactionEntryLinkCommand)

Responses

Request samples

Content type
{
  • "Links": [
    ]
}

Response samples

Content type
application/json
0
0

Unlink Entry and Transaction

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

entryId
required
integer <int32>

The entry Id

Responses

Unlink Entry and Transaction

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The enterprise Id

query Parameters
entriesId
Array of integers <int32> [ items <int32 > ]

Entries id

Responses

Synchronize banking transactions with entries during a new account association

Authorizations:
oauth2

Responses

BookAccounts

Get accounts of an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
scope
string
Default: "All"
Enum: "Impacted" "All" "Eligible" "Referential" "Balance" "Journal"

All(default): all possible accounts of enterprise. Impacted: only accounts having entries. Eligible: all eligible accounts to create entry or divide account. Referential: common account accross all enterprises. Balance: impacted accounts with parents. Journal: impacted accounts with parents. JournalAux: list of auxiliarized accounts

beginDate
string <date-time>

YYYY-MM-DD

endDate
string <date-time>

YYYY-MM-DD

journalId
integer <int32>
bookAccountId
integer <int32>
bookSubAccountId
integer <int32>
bookAccountTextSearch
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert an enterpise account (only sub accounts allowed)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EnterpriseId
required
integer <int32>
AccountId
required
integer <int32>
IsAux
boolean
IsImpactable
boolean
SubAccountLabel
string or null <= 100 characters
SubAccountCode
string or null <= 32 characters
BookOperationId
integer <int32>
AtDate
string or null <date-time>
ReturnAccountIfAlreadyExists
boolean
CentralizerId
integer <int32>
CentralizedSubAccountIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "IsAux": true,
  • "IsImpactable": true,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "BookOperationId": 0,
  • "AtDate": "2019-08-24T14:15:22Z",
  • "ReturnAccountIfAlreadyExists": true,
  • "CentralizerId": 0,
  • "CentralizedSubAccountIds": [
    ]
}

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": 0,
  • "AccountClass": 0,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "AccountDescription": "string",
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Optional": true,
  • "StatusByPeriod": [
    ],
  • "MappingAccount": 0,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "IsAux": true,
  • "IsCentralizer": true,
  • "CentralizerId": 0,
  • "Divided": "None",
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "BookOperationId": 0
}

Get public url of accounts map in pdf file

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
"string"

Get all accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The id of enterprise

query Parameters
withoutAuxiliaryAccounts
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all accounts included in fixed asset category (class : 2) Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The id of enterprise

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get BookAccountDto by its Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
bookAccountId
required
integer <int32>
query Parameters
bookSubAccountId
integer <int32>
classicMode
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": 0,
  • "AccountClass": 0,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "AccountDescription": "string",
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Optional": true,
  • "StatusByPeriod": [
    ],
  • "MappingAccount": 0,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "IsAux": true,
  • "IsCentralizer": true,
  • "CentralizerId": 0,
  • "Divided": "None",
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "BookOperationId": 0
}

Get CounterParty accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CounterParty accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Bank accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an error message if the account can't be deleted because it has lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
bookAccountId
required
integer <int32>
query Parameters
bookSubAccountId
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Returns an error message if any accounts can't be deleted because it has lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
bookAccountsId
Array of integers <int32> [ items <int32 > ]
bookSubAccountsId
Array of integers or null <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
"string"

Get bank sub accounts for association

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get impactable accounts by class

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
accountClass
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get accounts by class

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The id of enterprise

accountClass
required
integer <int32>

Account class

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get impactable accounts by number

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The id of enterprise

accountNumber
required
integer <int32>

Account number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BookEntries

Get Entry line by sourceId including deleted line

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

enterpriseId

query Parameters
sourceId
required
string

the source Id

Responses

Response samples

Content type
application/json
{
  • "EnterpriseId": 0,
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "EntryId": 0,
  • "Label": "string",
  • "BookAccountDto": {
    },
  • "DebitAmount": 0,
  • "CreditAmount": 0,
  • "Amount": 0,
  • "CurrencyId": 0,
  • "Currency": "string",
  • "MatchedId": 0,
  • "MatchedLetter": "string",
  • "MatchedDate": "2019-08-24T14:15:22Z",
  • "MatchedLetterOrientation": "PreviousExercise",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "RuleId": "string",
  • "Warning": "string",
  • "Type": "None",
  • "CutOffType": "None",
  • "BookEntryLineAssociations": [
    ],
  • "FxCurrencyId": 0,
  • "FxDate": "2019-08-24T14:15:22Z",
  • "FxRate": 0,
  • "BankManaged": true,
  • "Revision": "Unrevised",
  • "ReAllocated": true,
  • "ReAllocatedAt": "2019-08-24T14:15:22Z",
  • "ReAllocatedByUserId": 0,
  • "SourceId": "string",
  • "SourceType": "Unknown",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "MatchedType": "Unknown",
  • "Analytics": [
    ],
  • "Quantities": [
    ],
  • "SellingPrice": 0,
  • "IsPartialLettering": true
}

Get all source Id from sellsy for a given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

enterprise Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

recover writing with at least one lettering line equal letterId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

ids of entries

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one by Id Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "JournalName": "string",
  • "EntryRef": "string",
  • "Date": "2019-08-24T14:15:22Z",
  • "ExerciseId": 0,
  • "Label": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "ValidateDate": "2019-08-24T14:15:22Z",
  • "ValidationNumber": 0,
  • "DocRef": "string",
  • "FileId": 0,
  • "DocDate": "2019-08-24T14:15:22Z",
  • "TransactionId": 0,
  • "Source": "ByUser",
  • "SourceId": "string",
  • "Conf": 0.1,
  • "Warning": "string",
  • "BankManaged": true,
  • "OperationId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "PaymentMethod": "string",
  • "LastUpdateDate": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    },
  • "Lines": [
    ]
}

Create multiple entries in one transaction (all or nothing) Entry Mandatory : EnterpriseId, JournalId, Status(default Pending), Date, Lines. Optional: Label, FileId, DocRef EntryLine mandatory : AccountId, CurrencyId, Debit/Credit amount. Optional: SubAccountId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Array
Id
required
integer <int32>
EnterpriseId
required
integer <int32>
Date
required
string <date-time>
JournalId
required
integer <int32>
JournalName
string or null
EntryRef
string or null
ExerciseId
integer <int32>
Label
string or null
ValidationDate
string or null <date-time>
ValidationDateImported
string or null <date-time>
ValidationNumberImported
string or null
DocRef
string or null
FileId
integer <int32>
DocDate
string or null <date-time>
TransactionId
integer <int32>
Source
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
Conf
number or null <double>
Warning
string or null
OperationId
integer <int32>
LastUpdateDate
required
string <date-time>
object (UserInfoViewModel)
SourceId
string or null
DueDate
string or null <date-time>
PaymentMethod
string or null <= 200 characters
Array of objects or null (CreateEntryLineOldCommand)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Match (Lettering) entry lines. Must be same Account. Will return a compensation entry if sum is different from 0 Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
validate
boolean
Default: true

Accept match impacts (like unmatch, compensation entry...) or pass impacts as parameters

compensationEntryDiffType
string
Default: "Exchange"
Enum: "Exchange" "Settlement" "Offsetting"

Set type of compensation if needed

Request Body schema:

Send entry line Ids to match entry lines. if impacts is empty, will return new letter dto, if impact is not empty, either resend with validate to false or resend with known impacts

Id
integer <int32>
AccountId
required
integer <int32>
SubAccountId
integer <int32>
Letter
string or null
LetterType
required
string
Enum: "Unknown" "Manual" "Auto" "Fec" "Reverse" "PublicApi"
LetterDate
required
string <date-time>
DeletedAt
string or null <date-time>
EntryLineIds
Array of integers or null <int64> [ items <int64 > ]
object (ImpactOldCommand)

Responses

Request samples

Content type
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Letter": "string",
  • "LetterType": "Unknown",
  • "LetterDate": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "EntryLineIds": [
    ],
  • "OperationImpacts": {
    }
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Letter": "string",
  • "LetterDate": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "EntryLineIds": [
    ],
  • "OperationImpacts": {
    }
}

BookEntries_GetCompensationEntryAccount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entryAmount
number <decimal>
compensationEntryDiffType
string
Enum: "Exchange" "Settlement" "Offsetting"
entryDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": 0,
  • "AccountClass": 0,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "AccountDescription": "string",
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Optional": true,
  • "StatusByPeriod": [
    ],
  • "MappingAccount": 0,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "IsAux": true,
  • "IsCentralizer": true,
  • "CentralizerId": 0,
  • "Divided": "None",
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "BookOperationId": 0
}

Match (Letterings) for FEC

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
OperationId
required
integer <int32>
required
Array of objects (CreateLetterForFecCommand)

Responses

Request samples

Content type
{
  • "OperationId": 0,
  • "Letters": [
    ]
}

Move entry lines to a different account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

Command that is executed in 2 steps: first we retrieve impacted lines ids by the unlettering, then we apply the move by flagging IsConfirmed to true.

EntryLineIds
Array of integers or null <int64> [ items <int64 > ]
object (AccountKey)
IsConfirmed
required
boolean

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "Destination": {
    },
  • "IsConfirmed": true
}

Response samples

Content type
application/json
{
  • "UnmatchedEntryLineIds": [
    ],
  • "IsCommitted": true,
  • "EntryValidationState": "None"
}

Move entry lines to a different book account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:

Command that is executed in 2 steps: first we retrieve impacted lines ids by the unlettering, then we apply the move by flagging IsConfirmed to true.

StartDate
required
string <date-time>
EndDate
required
string <date-time>
object (AccountKey)
Array of objects or null (AccountKey)
IsConfirmed
required
boolean
UnmatchedEntryLineIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "Destination": {
    },
  • "AccountsSource": [
    ],
  • "IsConfirmed": true,
  • "UnmatchedEntryLineIds": [
    ]
}

Response samples

Content type
application/json
{
  • "UnmatchedEntryLineIds": [
    ],
  • "IsCommitted": true,
  • "EntryValidationState": "None"
}

Update Revision Status

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
BookEntryLineIds
required
Array of integers <int64> non-empty [ items <int64 > ]
NewRevision
required
string <Enumeration>
Enum: "Unrevised" "Revised"

Responses

Request samples

Content type
{
  • "BookEntryLineIds": [
    ],
  • "NewRevision": "Unrevised"
}

Get Entries for FEC export

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
EndDate
required
string <date-time>
CreatedAfter
string or null <date-time>
UpdatedAfter
string or null <date-time>
IncludeOnlyValidatedEntries
boolean
ValidatedAfter
string or null <date-time>
ValidatedBefore
string or null <date-time>
WithAnalytic
required
boolean
WithQuantities
required
boolean
WithSellingPrice
required
boolean
WithPaymentInformations
required
boolean
ExcludeOnSitJournal
required
boolean
Deprecated
ExcludeJournalTypes
Array of strings or null <= 10 items
Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"
ExcludeSourceTypes
Array of strings or null <= 10 items
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
Page
required
integer <int32>
Size
required
integer <int32>
JournalAN
required
boolean

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "CreatedAfter": "2019-08-24T14:15:22Z",
  • "UpdatedAfter": "2019-08-24T14:15:22Z",
  • "IncludeOnlyValidatedEntries": true,
  • "ValidatedAfter": "2019-08-24T14:15:22Z",
  • "ValidatedBefore": "2019-08-24T14:15:22Z",
  • "WithAnalytic": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "WithPaymentInformations": true,
  • "ExcludeOnSitJournal": true,
  • "ExcludeJournalTypes": [
    ],
  • "ExcludeSourceTypes": [
    ],
  • "Page": 0,
  • "Size": 0,
  • "JournalAN": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Get virtual entry for FEC export

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Date
required
string <date-time>

Responses

Request samples

Content type
{
  • "Date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "JournalId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "ValidationNumber": 0,
  • "FileId": 0,
  • "DocDate": "2019-08-24T14:15:22Z",
  • "DocRef": "string",
  • "EntryRef": "string",
  • "Lines": [
    ],
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "PaymentMode": "string",
  • "NatureOperation": "string",
  • "ClientId": "string",
  • "DueDate": "2019-08-24T14:15:22Z"
}

Restore deleted entries and their associated letterings by querying audit events. Use PreviewOnly=true to see what would be rolled back without making changes.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
DateMin
required
string <date-time>
DateMax
required
string <date-time>
PreviewOnly
required
boolean

Responses

Request samples

Content type
{
  • "DateMin": "2019-08-24T14:15:22Z",
  • "DateMax": "2019-08-24T14:15:22Z",
  • "PreviewOnly": true
}

Response samples

Content type
application/json
{
  • "IsPreview": true,
  • "AccountingFolderId": 0,
  • "DateMin": "2019-08-24T14:15:22Z",
  • "DateMax": "2019-08-24T14:15:22Z",
  • "ExecutedAt": "2019-08-24T14:15:22Z",
  • "Success": true,
  • "ErrorMessage": "string",
  • "EntriesSummary": {
    },
  • "LetteringsSummary": {
    }
}

BookEntryExports

Get FEC export formats

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Responses

Response samples

Content type
application/json
[
  • "string"
]

Check FEC export data

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

exportType
required
string
Enum: "None" "Coala" "Quadra" "QuadraAscii" "StandardAnalytic" "AcdIn" "Gestfr" "Hyper"

Type of export

createdAfter
string <date-time>
excludeJournalTypes
Array of strings <= 10 items
Items Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"

Journal types whose entries must be excluded from the export.

excludeEntriesOnSitJournal
boolean

Deprecated, use excludeJournalTypes. Indicates whether the export must exclude (or not) entries on SIT journal.

Responses

Response samples

Content type
application/json
{
  • "Checks": [
    ],
  • "EntryLinesCount": 0,
  • "MaxUpdatedEntryDate": "2019-08-24T14:15:22Z"
}

Get FEC exports.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
generatePublicUrl
boolean
Default: true

Generate the public file URL

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get FEC export by id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

bookExportId
required
integer <int32>

Book export Id

query Parameters
generatePublicUrl
required
boolean
Default: false

Define if the public url of the file will be generate or not

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileUrl": "string",
  • "UserId": 0,
  • "BookExportType": "None",
  • "EntryLinesCount": 0,
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "BookMaxUpdatedAt": "2019-08-24T14:15:22Z",
  • "BookMaxValueDate": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "EntriesCreatedAfter": "2019-08-24T14:15:22Z",
  • "Status": "Pending",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "WithDueDate": true,
  • "ExcludeEntriesOnSitJournal": true,
  • "ExcludeJournalTypes": [
    ],
  • "KeepDetailedEntryLinesLabels": true,
  • "ExportFileAttachmentType": "None",
  • "EntriesUpdatedAfter": "2019-08-24T14:15:22Z",
  • "IncludeOnlyValidatedEntries": true,
  • "ValidatedAfter": "2019-08-24T14:15:22Z",
  • "ValidatedBefore": "2019-08-24T14:15:22Z",
  • "ExcludeSourceTypes": [
    ]
}

Export FEC file from UI async

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
exerciseId
integer <int32>

Exercice id to export

beginDate
string <date-time>

The begin date

endDate
string <date-time>

The end date

createdAfter
string <date-time>
exportType
required
string
Enum: "None" "Coala" "Quadra" "QuadraAscii" "StandardAnalytic" "AcdIn" "Gestfr" "Hyper"

export type

excludeJournalTypes
Array of strings <= 10 items
Items Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"

Journal types whose entries must be excluded from the export.

excludeEntriesOnSitJournal
boolean

Deprecated, use excludeJournalTypes. Indicates whether the export must exclude (or not) entries on SIT journal.

withAnalytics
boolean

Indicates whether the export must include analytics

withQuantities
boolean

Indicates whether the export must include quantities/units

withSellingPrice
boolean

Indicates whether the export must include selling price

withDueDate
boolean

Indicates whether the export must include Due Date

keepDetailedEntryLinesLabels
boolean
Default: true

Defines if entry lines labels from the same entry are gathered or not.

exportFileAttachmentType
string
Enum: "None" "NomFichier" "PieceRef"

ADMIN ONLY

updatedAfter
string <date-time>

Only return entries modified after this date

includeOnlyValidatedEntries
boolean

Only return validated entries

validatedAfter
string <date-time>

Only return entries validated at or after this UTC date. Requires includeOnlyValidatedEntries=true.

validatedBefore
string <date-time>

Only return entries validated strictly before this UTC date. Requires includeOnlyValidatedEntries=true.

excludeSourceTypes
Array of strings <= 10 items
Items Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"

Entry sources whose entries must be excluded from the export.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileUrl": "string",
  • "UserId": 0,
  • "BookExportType": "None",
  • "EntryLinesCount": 0,
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "BookMaxUpdatedAt": "2019-08-24T14:15:22Z",
  • "BookMaxValueDate": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "EntriesCreatedAfter": "2019-08-24T14:15:22Z",
  • "Status": "Pending",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "WithDueDate": true,
  • "ExcludeEntriesOnSitJournal": true,
  • "ExcludeJournalTypes": [
    ],
  • "KeepDetailedEntryLinesLabels": true,
  • "ExportFileAttachmentType": "None",
  • "EntriesUpdatedAfter": "2019-08-24T14:15:22Z",
  • "IncludeOnlyValidatedEntries": true,
  • "ValidatedAfter": "2019-08-24T14:15:22Z",
  • "ValidatedBefore": "2019-08-24T14:15:22Z",
  • "ExcludeSourceTypes": [
    ]
}

BookEntryExports_FixConsistencyFecExport

Authorizations:
oauth2

Responses

Update BookExport

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Request Body schema:
EnterpriseId
required
integer <int32>
BookExportId
required
integer <int32>
FileId
integer <int32>
Status
required
string
Enum: "Pending" "InProgress" "Success" "Error"
EntryLinesCount
integer <int32>

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "BookExportId": 0,
  • "FileId": 0,
  • "Status": "Pending",
  • "EntryLinesCount": 0
}

Export Entries Description

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
exerciseId
required
integer <int32>

Exercise id to export

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Url": "string"
}

BookVats

Get All BookVats Deprecated

Authorizations:
oauth2
query Parameters
countryId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a new BookVat Deprecated

Authorizations:
oauth2
Request Body schema:
CountryCodeId
required
integer <int32>
Name
required
string [ 1 .. 200 ] characters
Rate
required
number <decimal>
Date
required
string <date-time>
IsDefault
required
boolean
Id
required
integer <int32>

Responses

Request samples

Content type
{
  • "CountryCodeId": 0,
  • "Name": "string",
  • "Rate": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "IsDefault": true,
  • "Id": 0
}

Get BookVat by its Id Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CountryCodeId": 0,
  • "Name": "string",
  • "Rate": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "IsDefault": true,
  • "Id": 0
}

Update an existing BookVat Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
CountryCodeId
required
integer <int32>
Name
required
string [ 1 .. 200 ] characters
Rate
required
number <decimal>
Date
required
string <date-time>
IsDefault
required
boolean
Id
required
integer <int32>

Responses

Request samples

Content type
{
  • "CountryCodeId": 0,
  • "Name": "string",
  • "Rate": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "IsDefault": true,
  • "Id": 0
}

Response samples

Content type
application/json
"string"

Delete a existing BookVat Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CountryCodeId": 0,
  • "Name": "string",
  • "Rate": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "IsDefault": true,
  • "Id": 0
}

CashManager

Post file data

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Fec File

Responses

Get many CashManagerOperations

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one CashManagerOperation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cashManagerOperationId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Status": "Pending",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "FailureReason": "ImportedFileNotFound",
  • "NumberOfProcessedDocuments": 0,
  • "NumberOfDocumentsToProcess": 0,
  • "FecResultFileId": 0,
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "SubmissionDate": "2019-08-24T14:15:22Z"
}

Change state of CashManagerOperation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cashManagerOperationId
required
integer <int32>
Request Body schema:
required
NewStatus
required
string
Enum: "Pending" "InProgress" "Success" "Failed"
FecResultFileId
integer <int32>
FailureReason
string or null
Enum: "ImportedFileNotFound" "InvalidFileFormat" "InvalidCashManagerFile" "DownloadFailed"
NumberOfProcessedDocuments
integer <int32>
NumberOfDocumentsToProcess
integer <int32>

Responses

Request samples

Content type
{
  • "NewStatus": "Pending",
  • "FecResultFileId": 0,
  • "FailureReason": "ImportedFileNotFound",
  • "NumberOfProcessedDocuments": 0,
  • "NumberOfDocumentsToProcess": 0
}

Clean CashManagerOperations

Authorizations:
oauth2

Responses

Retry failed CashManagerOperation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cashManagerOperationId
required
integer <int32>

Responses

ChartOfAccounts

Get all Charts of accounts

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get charts of accounts by company id

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a chart of accounts by accounting folder id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Description": "string",
  • "Type": "InqomPcg"
}

ChartOfAccountsAccounts

Get accounts of PCG given a chart Of Accounts Id

Authorizations:
oauth2
query Parameters
chartOfAccountsId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export a chart of accounts as a CSV file with the columns of the chart of accounts extension export, every non archived and non obsolete vintage with its validity dates

Authorizations:
oauth2
query Parameters
chartOfAccountsId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

ClientState

Get all Clients States infos (for admin)

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Change information of Client State. When a secret rotation is requested, the new secret is returned once — it cannot be retrieved afterwards.

Authorizations:
oauth2
Request Body schema:
required
ClientId
required
string or null
RedirectUris
string or null
ResourceAuthorizations
string or null
AllowedScopes
Array of strings or null
AccessTokenLifetimeSeconds
integer <int32>
RotateSecret
required
boolean
PublicKeyPem
string or null
FilterCompanyGroupId
integer <int32>

Responses

Request samples

Content type
{
  • "ClientId": "string",
  • "RedirectUris": "string",
  • "ResourceAuthorizations": "string",
  • "AllowedScopes": [
    ],
  • "AccessTokenLifetimeSeconds": 0,
  • "RotateSecret": true,
  • "PublicKeyPem": "string",
  • "FilterCompanyGroupId": 0
}

Response samples

Content type
application/json
{
  • "NewClientSecret": "string"
}

Create new Client State ResourceOwner

Authorizations:
oauth2
query Parameters
clientId
required
string

Responses

Create new Client State AuthorizationCode

Authorizations:
oauth2
Request Body schema:
required
ClientId
string or null
RedirectUris
string or null
ResourceAuthorizations
string or null
PublicKeyPem
string or null
FilterCompanyGroupId
integer <int32>

Responses

Request samples

Content type
{
  • "ClientId": "string",
  • "RedirectUris": "string",
  • "ResourceAuthorizations": "string",
  • "PublicKeyPem": "string",
  • "FilterCompanyGroupId": 0
}

Create new Client State ClientCredentials. The client secret is returned once at creation time only — it cannot be retrieved afterwards.

Authorizations:
oauth2
Request Body schema:
required
ClientId
string or null
AllowedScopes
Array of strings or null
AccessTokenLifetimeSeconds
integer <int32>
PublicKeyPem
string or null
FilterCompanyGroupId
integer <int32>

Responses

Request samples

Content type
{
  • "ClientId": "string",
  • "AllowedScopes": [
    ],
  • "AccessTokenLifetimeSeconds": 0,
  • "PublicKeyPem": "string",
  • "FilterCompanyGroupId": 0
}

Response samples

Content type
application/json
{
  • "ClientId": "string",
  • "ClientSecret": "string"
}

Collaborators

Get collaborators for any enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
rolenames
string

List of roles separated by ',', if empty, it will be ignored

withExternals
boolean
Default: false

if true, it will return in addition the list of external collaborators

activeOnly
boolean
Default: true

if true it will return only active users

onlyAccounting
boolean
Default: false

true if get only accounting person of enterprise

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get collaborator. must have enterpriseId and collaboratorId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
collaboratorId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "EmploymentContractId": 0,
  • "Position": "string",
  • "IsInterne": true,
  • "ActifEnterpriseRoles": [
    ],
  • "Id": 0,
  • "Email": "string",
  • "UserName": "string",
  • "PhoneNumber": "string",
  • "ActifEnterpriseId": 0,
  • "ActifEnterpriseName": "string",
  • "ActifEnterpriseType": "None",
  • "FolderId": 0,
  • "Gender": "Mrs",
  • "FirstName": "string",
  • "LastName": "string",
  • "FullName": "string",
  • "City": "string",
  • "Street": "string",
  • "ZipCode": "string",
  • "SocialSecurityNumber": "string",
  • "AvatarId": 0,
  • "UrlAvatar": "string",
  • "Activated": true,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "CreadtedAt": "2019-08-24T14:15:22Z",
  • "TwoFactorEnabled": true,
  • "Affected": [
    ]
}

Company

Get all companies

Authorizations:
oauth2
query Parameters
searchText
string
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get admin details of company by id

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Récupération des utilisateurs du cabinet/PME

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Cabinet/PME Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Company summary

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyGroupId": 0,
  • "UniqueName": "string",
  • "Name": "string",
  • "CompanyType": "None",
  • "ContractType": "Normal",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExternalId": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Provider": "string",
  • "UrlLogo": "string",
  • "Street": "string",
  • "PostalCode": "string",
  • "City": "string",
  • "Supplement": "string",
  • "Telephone": "string",
  • "SiteWeb": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Segment": "LAF"
}

Get general information of company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Name": "string",
  • "TradeName": "string",
  • "UniqueName": "string",
  • "LegalFormId": 0,
  • "Siren": "string",
  • "Nic": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "UrlLogo": "string",
  • "Activity": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "Street": "string",
  • "City": "string",
  • "ZipCode": "string",
  • "AdditionalAddress": "string",
  • "Hamlet": "string",
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "CompanyGroupId": 0,
  • "ContractType": "Normal",
  • "CompanyType": "None",
  • "OwnerLastname": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Segment": "LAF",
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

Search accounting folders by ExternalSystemId within a given company.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Cabinet identifier the dossiers belong to.

query Parameters
externalSystemId
required
string

External system identifier of the dossier to look up.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new company

Authorizations:
oauth2
Request Body schema:
required
CompanyName
required
string non-empty
PhoneNumber
required
string non-empty
LastName
required
string non-empty
CompanyType
required
string
Enum: "None" "Accounting" "Pme"
Siren
string or null [ 0 .. 9 ] characters
Nic
string or null [ 0 .. 5 ] characters
ExternalId
string or null
ExternalSystemId
string or null <= 50 characters
CompanyGroupId
integer <int32>
object (LocationCommand)
ContractType
required
string
Enum: "Normal" "Fake" "Demo" "Trial" "Ghost"
Segment
string or null
Enum: "LAF" "MAF" "SAF"

Responses

Request samples

Content type
{
  • "CompanyName": "string",
  • "PhoneNumber": "string",
  • "LastName": "string",
  • "CompanyType": "None",
  • "Siren": "string",
  • "Nic": "strin",
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "CompanyGroupId": 0,
  • "Location": {
    },
  • "ContractType": "Normal",
  • "Segment": "LAF"
}

Response samples

Content type
application/json
0
0

Change general information of company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
ExternalId
string or null <= 50 characters
ExternalSystemId
string or null <= 50 characters
Name
required
string non-empty
TradeName
string or null
LegalFormId
required
integer <int32>
CompanyGroupId
integer <int32>
Siren
string or null [ 0 .. 9 ] characters
Nic
string or null [ 0 .. 5 ] characters
Ape
string or null [ 3 .. 6 ] characters
Deprecated
CodeNafId
integer <int32>
Activity
string or null <= 50 characters
CreationDate
required
string <date-time>
Telephone
string or null
Email
string or null
WebSite
string or null
object (LocationCommand)

Responses

Request samples

Content type
{
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Name": "string",
  • "TradeName": "string",
  • "LegalFormId": 0,
  • "CompanyGroupId": 0,
  • "Siren": "string",
  • "Nic": "strin",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "Activity": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "Location": {
    }
}

Assign user to accounting folder

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>

UserId

RoleName
required
string non-empty

RoleName

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "RoleName": "string"
}

Assign user of company to many accounting folders

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
AccountingFoldersId
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "AccountingFoldersId": [
    ]
}

Unassign users of company of accounting folders

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
AccountingFoldersId
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "AccountingFoldersId": [
    ]
}

Remove access to free assignation feature

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Deny access to free assignation feature

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Update accounting firm main information

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
required
AccountingFirmId
required
integer <int32>
Name
required
string or null
Phone
required
string or null
OwnerLastname
required
string or null
Siren
string or null
Nic
string or null
CompanyGroupId
required
integer <int32>
ContractType
required
string
Enum: "Normal" "Fake" "Demo" "Trial" "Ghost"
ThemeId
integer <int32>
WhiteLabelId
integer <int32>
Segment
string or null
Enum: "LAF" "MAF" "SAF"

Responses

Request samples

Content type
{
  • "AccountingFirmId": 0,
  • "Name": "string",
  • "Phone": "string",
  • "OwnerLastname": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "CompanyGroupId": 0,
  • "ContractType": "Normal",
  • "ThemeId": 0,
  • "WhiteLabelId": 0,
  • "Segment": "LAF"
}

Get a company with all its accounting folders and the state of information completion for AP mandate

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Siren": "string",
  • "Name": "string",
  • "Address": {
    },
  • "AccountingFolders": [
    ],
  • "IsComplete": true
}

CompanyAccounts

Get all accounts from an extended chart of accounts.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
query Parameters
chartOfAccountsId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an account for a chart of account.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
Request Body schema:
required

The Create Account command, containing the number and name of the account to create.

AccountNumber
required
integer <int32>
Description
string or null <= 200 characters
Dividable
required
boolean
Impactable
required
boolean
Configurable
required
boolean

Responses

Request samples

Content type
{
  • "AccountNumber": 0,
  • "Description": "string",
  • "Dividable": true,
  • "Impactable": true,
  • "Configurable": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Account": 0,
  • "Description": "string",
  • "Level1": 0,
  • "Level2": 0,
  • "Level3": 0,
  • "Level4": 0,
  • "Level5": 0,
  • "Level6": 0,
  • "Level7": 0,
  • "MappingAccount": 0,
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Obsolete": true,
  • "Optional": true,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "StatusByPeriod": [
    ],
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "IsCentralizer": true,
  • "CentralizerId": 0
}

Get an account from an extended chart of accounts.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Account": 0,
  • "Description": "string",
  • "Level1": 0,
  • "Level2": 0,
  • "Level3": 0,
  • "Level4": 0,
  • "Level5": 0,
  • "Level6": 0,
  • "Level7": 0,
  • "MappingAccount": 0,
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Obsolete": true,
  • "Optional": true,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "StatusByPeriod": [
    ],
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "IsCentralizer": true,
  • "CentralizerId": 0
}

Update a company account belonging to the chart of account

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
accountId
required
integer <int32>
Request Body schema:
required
AccountNumber
integer <int32>
Description
string or null <= 200 characters
Dividable
required
boolean
Impactable
required
boolean
Configurable
required
boolean

Responses

Request samples

Content type
{
  • "AccountNumber": 0,
  • "Description": "string",
  • "Dividable": true,
  • "Impactable": true,
  • "Configurable": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Account": 0,
  • "Description": "string",
  • "Level1": 0,
  • "Level2": 0,
  • "Level3": 0,
  • "Level4": 0,
  • "Level5": 0,
  • "Level6": 0,
  • "Level7": 0,
  • "MappingAccount": 0,
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Obsolete": true,
  • "Optional": true,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "StatusByPeriod": [
    ],
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "IsCentralizer": true,
  • "CentralizerId": 0
}

Get account keys list by system category

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
Request Body schema:
Array
string
Enum: "CompteDeCharge" "CompteDeProduit" "CompteDeBilan" "CompteImmobilisation" "CompteDeCapitaux" "CompteDeBanque" "CompteAuxiliaire" "CompteDeStock" "CompteDeTiers" "CompteDeTVA" "CompteSurDebit" "CompteSurEncaissement" "CompteDAchat" "CompteDeVente" "CompteDeTVARegularisation" "CompteDeTVACollectee" "CompteDeTVADeductible" "CompteDeTVAIntraCommunautaire" "CompteDeTiersClients" "CompteDeTiersFournisseurs" "CompteDeTiersClientsParametrageTva" "CompteDeTiersFournisseursParametrageTva" "ComptesDeResultatANouveaux" "ComptesDeReportANouveaux" "ComptesSpeciaux" "ComptesScopeFournisseurs" "ComptesScopeClients" "ComptesScopeBanques" "ComptesScopeExploitations" "ComptesScopeImmo" "CompteDeTiersFournisseursImmoParametrageTva" "ComptedeTVAAutoLiquidation" "CompteDeTiersFournisseursAvancesAcomptes" "CompteDeTiersClientsAvancesAcomptes" "ComptesStockFarmeo" "CompteDeResultatANouveauxCredit" "CompteDeResultatANouveauxDebit" "ComptesDeReportANouveauxFamille" "ComptesDeResultatANouveauxFamille"

Responses

Request samples

Content type
[
  • "CompteDeCharge"
]

Response samples

Content type
application/json
[
  • {
    }
]

Update dividable, impactable and locked on several accounts of an extended chart of accounts

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
Request Body schema:
required
AccountIds
required
Array of integers <int32> [ items <int32 > ]
Dividable
boolean
Impactable
boolean
Locked
boolean

Responses

Request samples

Content type
{
  • "AccountIds": [
    ],
  • "Dividable": true,
  • "Impactable": true,
  • "Locked": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Revert the overridden account label

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Archive a company account

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Account": 0,
  • "Description": "string",
  • "Level1": 0,
  • "Level2": 0,
  • "Level3": 0,
  • "Level4": 0,
  • "Level5": 0,
  • "Level6": 0,
  • "Level7": 0,
  • "MappingAccount": 0,
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Obsolete": true,
  • "Optional": true,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "StatusByPeriod": [
    ],
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "IsCentralizer": true,
  • "CentralizerId": 0
}

Soft delete a company account if it is no longer used.

Un compte non supprimé n'est pas une erreur : la réponse porte les raisons.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
extendedChartOfAccountsId
required
integer <int32>
accountId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "Deleted": true,
  • "Reasons": [
    ]
}

CompanyGroup

Get all companyGroups

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create companyGroups

Authorizations:
oauth2
Request Body schema:
ReferenceCompanyId
integer <int32>
Name
string or null

Responses

Request samples

Content type
{
  • "ReferenceCompanyId": 0,
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ReferenceCompanyId": 0,
  • "Name": "string",
  • "MailingInfoFromEmail": "string",
  • "MailingInfoFromName": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Companies": [
    ],
  • "Office365Credentials": {
    },
  • "Provisioning": {
    }
}

Get the company groups within the caller's scope

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one companyGroup

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ReferenceCompanyId": 0,
  • "Name": "string",
  • "MailingInfoFromEmail": "string",
  • "MailingInfoFromName": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Companies": [
    ],
  • "Office365Credentials": {
    },
  • "Provisioning": {
    }
}

Get companyGroup by company id

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ReferenceCompanyId": 0,
  • "Name": "string",
  • "MailingInfoFromEmail": "string",
  • "MailingInfoFromName": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Companies": [
    ],
  • "Office365Credentials": {
    },
  • "Provisioning": {
    }
}

Whether the reference company of the company's group has full access to the resource; false without a group.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
resourceName
required
string

Responses

Response samples

Content type
application/json
true

Whether the reference company of the folder's owner cabinet group has full access to the resource; false without a group.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
resourceName
required
string

Responses

Response samples

Content type
application/json
true

set MailingInfo to companyGroup

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
FromEmail
string or null
FromName
string or null

Responses

Request samples

Content type
{
  • "FromEmail": "string",
  • "FromName": "string"
}

Create or update company group Office365 credentials

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
ClientId
required
string non-empty
ClientSecret
required
string non-empty
TenantId
required
string non-empty
SiteId
required
string non-empty

Responses

Request samples

Content type
{
  • "ClientId": "string",
  • "ClientSecret": "string",
  • "TenantId": "string",
  • "SiteId": "string"
}

Get company group Office365 credentials

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "ClientId": "string",
  • "ClientSecret": "string",
  • "TenantId": "string",
  • "SiteId": "string"
}

Create or update company group Google Drive config

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
DriveId
required
string [ 1 .. 128 ] characters
Enabled
required
boolean

Responses

Request samples

Content type
{
  • "DriveId": "string",
  • "Enabled": true
}

Get company group Google Drive config

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "DriveId": "string",
  • "ServiceAccountKeySecretName": "string",
  • "Enabled": true
}

Delete company group Google Drive config

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Set the allowed company type for creation by the SCIM provider (for example, 'Accounting' or 'Pme').

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
required
ClientId
required
string or null
CanCreateCompanyType
required
string
Enum: "None" "Accounting" "Pme"

Responses

Request samples

Content type
{
  • "ClientId": "string",
  • "CanCreateCompanyType": "None"
}

Create or Update provisioning SCIM config

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
CompanyId
required
integer <int32>
UserRole
required
string or null

Responses

Request samples

Content type
{
  • "CompanyId": 0,
  • "UserRole": "string"
}

Assign accounting firms to a companies group

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
required
Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Set a leading company to the company group

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
required
LeadingCompanyId
integer <int32>

Responses

Request samples

Content type
{
  • "LeadingCompanyId": 0
}

Get companies of a company group, optionally filtered by ExternalSystemIds, ExternalIds or Siren/Nic (OR logic)

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
ExternalSystemIds
Array of strings

ExternalSystemIds filters on multiple external system identifiers (OR logic)

ExternalId
Array of strings

ExternalId filters on multiple external identifiers (OR logic)

Siren
string

SIREN number of the enterprise

Nic
string

NIC part of the SIRET number

page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 50

Responses

Response samples

Content type
application/json
{
  • "Items": [
    ],
  • "TotalCount": 0,
  • "Page": 0,
  • "PageSize": 0
}

Get accounting folders of a company group, optionally filtered by ExternalSystemIds, ExternalIds or Siren/Nic (OR logic)

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
ExternalSystemIds
Array of strings

ExternalSystemIds filters on multiple external system identifiers (OR logic)

ExternalId
Array of strings

ExternalId filters on multiple external identifiers (OR logic)

Siren
string

SIREN number of the enterprise

Nic
string

NIC part of the SIRET number

page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 50

Responses

Response samples

Content type
application/json
{
  • "Items": [
    ],
  • "TotalCount": 0,
  • "Page": 0,
  • "PageSize": 0
}

KPI counters of a company group.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CompanyCount": 0,
  • "AccountingFolderCount": 0,
  • "CollaboratorCount": 0,
  • "UnassignedAccountingFolderCount": 0,
  • "InheritedCollaboratorCount": 0
}

Search, filter, sort and page the accounting folders of a company group.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
CompanyIds
Array of integers <int32> [ items <int32 > ]

Restricts the search to these company identifiers (OR logic).

States
Array of strings

StateMode names to keep (case-insensitive); null or empty means every state.

Types
Array of strings

AccountingType names to keep (case-insensitive); null or empty means every type.

ChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these charts of accounts.

ExtendedChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these chart of accounts extensions.

NoExtensionChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these charts of accounts without an extension.

Search
string

Free text searched on name and identifiers.

SortBy
string

Sort key; null means the default folder id order.

SortDirection
string

Sort direction, "asc" or "desc".

Page
integer <int32>

1-based page number.

PageSize
integer <int32>

Number of items per page.

Responses

Response samples

Content type
application/json
{
  • "Items": [
    ],
  • "FilteredCount": 0,
  • "TotalCount": 0,
  • "Page": 0,
  • "PageSize": 0
}

Export the accounting folders of a company group as a CSV file, with the filters, search and sort of the listing.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
CompanyIds
Array of integers <int32> [ items <int32 > ]

Restricts the export to these company identifiers (OR logic).

States
Array of strings

StateMode names to keep (case-insensitive); null or empty means every state.

Types
Array of strings

AccountingType names to keep (case-insensitive); null or empty means every type.

ChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these charts of accounts.

ExtendedChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these chart of accounts extensions.

NoExtensionChartOfAccountsIds
Array of integers <int32> [ items <int32 > ]

Keeps the folders using any of these charts of accounts without an extension.

Search
string

Free text searched on name and identifiers.

SortBy
string

Sort key; null means the default folder id order.

SortDirection
string

Sort direction, "asc" or "desc".

Responses

Response samples

Content type
application/json
"string"

Charts of accounts and extensions used by the folders of a company group, feeding the listing filters.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Charts": [
    ]
}

Collaborators of the folder's owning company, with their assignment status on the folder.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
folderId
required
integer <int32>
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign a collaborator of the folder's owning company to the accounting folder.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
folderId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "UserId": 0
}

Assign and/or unassign collaborators on a batch of accounting folders, one report line per folder.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
FolderIds
Array of integers or null <int32> [ items <int32 > ]
AssignUserIds
Array of integers or null <int32> [ items <int32 > ]
UnassignUserIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "FolderIds": [
    ],
  • "AssignUserIds": [
    ],
  • "UnassignUserIds": [
    ]
}

Response samples

Content type
application/json
{
  • "SucceededCount": 0,
  • "FailedCount": 0,
  • "Results": [
    ]
}

Unassign a collaborator from the accounting folder (closes the assignment, no physical delete).

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
folderId
required
integer <int32>
userId
required
integer <int32>

Responses

Distribution of a company group's active accounting folders by chart of accounts and extension.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
companyIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "Lines": [
    ],
  • "TotalAccountingFolderCount": 0
}

Distribution of a company group's collaborators by accounting role.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
query Parameters
companyIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "Lines": [
    ],
  • "TotalCollaboratorCount": 0,
  • "TotalInheritedCollaboratorCount": 0
}

Active administrators of the company group, with the date they were assigned.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign a collaborator of the group as one of its administrators.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "UserId": 0
}

Revoke an administrator of the company group (closes the assignment, no physical delete).

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>
userId
required
integer <int32>

Responses

CorporateOfficers

Get corporate officers of an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Countries

Get All CountryCode

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a new CountryCode

Authorizations:
oauth2
Request Body schema:
Id
required
integer <int32>
ISO2LetterCode
required
string [ 1 .. 2 ] characters
ISO3LetterCode
required
string [ 1 .. 3 ] characters
PhoneCode
required
integer <int32>
Name
string or null <= 50 characters
PhoneRegexs
string or null <= 100 characters
ZipCodeRegexs
string or null <= 100 characters
LanguagesIETFTag
string or null <= 100 characters
LanguageIRTFTagId
required
integer <int32>
object (Language)
CurrencyId
required
integer <int32>
InEurope
required
boolean
Available
required
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "ISO2LetterCode": "st",
  • "ISO3LetterCode": "str",
  • "PhoneCode": 0,
  • "Name": "string",
  • "PhoneRegexs": "string",
  • "ZipCodeRegexs": "string",
  • "LanguagesIETFTag": "string",
  • "LanguageIRTFTagId": 0,
  • "LanguageIRTFTag": {
    },
  • "CurrencyId": 0,
  • "InEurope": true,
  • "Available": true
}

Get CountryCode by its Id

Authorizations:
oauth2
query Parameters
ids
Array of integers <int32> [ items <int32 > ]
names
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CountryCode by its Id

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ISO2LetterCode": "st",
  • "ISO3LetterCode": "str",
  • "PhoneCode": 0,
  • "Name": "string",
  • "PhoneRegexs": "string",
  • "ZipCodeRegexs": "string",
  • "LanguagesIETFTag": "string",
  • "LanguageIRTFTagId": 0,
  • "LanguageIRTFTag": {
    },
  • "CurrencyId": 0,
  • "InEurope": true,
  • "Available": true
}

Update an existing CountryCode

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
ISO2LetterCode
required
string [ 1 .. 2 ] characters
ISO3LetterCode
required
string [ 1 .. 3 ] characters
PhoneCode
required
integer <int32>
Name
string or null <= 50 characters
PhoneRegexs
string or null <= 100 characters
ZipCodeRegexs
string or null <= 100 characters
LanguagesIETFTag
string or null <= 100 characters
LanguageIRTFTagId
required
integer <int32>
object (Language)
CurrencyId
required
integer <int32>
InEurope
required
boolean
Available
required
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "ISO2LetterCode": "st",
  • "ISO3LetterCode": "str",
  • "PhoneCode": 0,
  • "Name": "string",
  • "PhoneRegexs": "string",
  • "ZipCodeRegexs": "string",
  • "LanguagesIETFTag": "string",
  • "LanguageIRTFTagId": 0,
  • "LanguageIRTFTag": {
    },
  • "CurrencyId": 0,
  • "InEurope": true,
  • "Available": true
}

Response samples

Content type
application/json
"string"

Delete a existing CountryCode

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ISO2LetterCode": "st",
  • "ISO3LetterCode": "str",
  • "PhoneCode": 0,
  • "Name": "string",
  • "PhoneRegexs": "string",
  • "ZipCodeRegexs": "string",
  • "LanguagesIETFTag": "string",
  • "LanguageIRTFTagId": 0,
  • "LanguageIRTFTag": {
    },
  • "CurrencyId": 0,
  • "InEurope": true,
  • "Available": true
}

Currencies

Get All Currencies

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a new Currency

Authorizations:
oauth2
Request Body schema:
Name
string or null <= 50 characters
UnitSymbol
string or null <= 15 characters
UnitISOCode
string or null <= 5 characters
UnitISONumber
required
integer <int32>
FractionName
string or null <= 20 characters
FractionSymbol
string or null <= 10 characters
FractionToUnit
required
integer <int32>
UnitsToSuperUnit
required
integer <int32>
Exponent
required
integer <int32>
UniqueSymbol
required
boolean
Major
required
boolean
Virtual
required
boolean
Id
required
integer <int32>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "UnitSymbol": "string",
  • "UnitISOCode": "strin",
  • "UnitISONumber": 0,
  • "FractionName": "string",
  • "FractionSymbol": "string",
  • "FractionToUnit": 0,
  • "UnitsToSuperUnit": 0,
  • "Exponent": 0,
  • "UniqueSymbol": true,
  • "Major": true,
  • "Virtual": true,
  • "Id": 0
}

Get Currencies by its Id

Authorizations:
oauth2
query Parameters
ids
Array of integers <int32> [ items <int32 > ]
names
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Currency by its IsoName

Authorizations:
oauth2
query Parameters
currencyIsoCode
string

EUR,USD

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "UnitSymbol": "string",
  • "UnitISOCode": "strin",
  • "UnitISONumber": 0,
  • "FractionName": "string",
  • "FractionSymbol": "string",
  • "FractionToUnit": 0,
  • "UnitsToSuperUnit": 0,
  • "Exponent": 0,
  • "UniqueSymbol": true,
  • "Major": true,
  • "Virtual": true,
  • "Id": 0
}

Get Currency by its Id

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "UnitSymbol": "string",
  • "UnitISOCode": "strin",
  • "UnitISONumber": 0,
  • "FractionName": "string",
  • "FractionSymbol": "string",
  • "FractionToUnit": 0,
  • "UnitsToSuperUnit": 0,
  • "Exponent": 0,
  • "UniqueSymbol": true,
  • "Major": true,
  • "Virtual": true,
  • "Id": 0
}

Update an existing Currency

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Name
string or null <= 50 characters
UnitSymbol
string or null <= 15 characters
UnitISOCode
string or null <= 5 characters
UnitISONumber
required
integer <int32>
FractionName
string or null <= 20 characters
FractionSymbol
string or null <= 10 characters
FractionToUnit
required
integer <int32>
UnitsToSuperUnit
required
integer <int32>
Exponent
required
integer <int32>
UniqueSymbol
required
boolean
Major
required
boolean
Virtual
required
boolean
Id
required
integer <int32>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "UnitSymbol": "string",
  • "UnitISOCode": "strin",
  • "UnitISONumber": 0,
  • "FractionName": "string",
  • "FractionSymbol": "string",
  • "FractionToUnit": 0,
  • "UnitsToSuperUnit": 0,
  • "Exponent": 0,
  • "UniqueSymbol": true,
  • "Major": true,
  • "Virtual": true,
  • "Id": 0
}

Response samples

Content type
application/json
"string"

Delete a existing Currency

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "UnitSymbol": "string",
  • "UnitISOCode": "strin",
  • "UnitISONumber": 0,
  • "FractionName": "string",
  • "FractionSymbol": "string",
  • "FractionToUnit": 0,
  • "UnitsToSuperUnit": 0,
  • "Exponent": 0,
  • "UniqueSymbol": true,
  • "Major": true,
  • "Virtual": true,
  • "Id": 0
}

CustomViews

Get the custom views for a page type

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

query Parameters
pageType
required
string
Enum: "Journal" "Ledger"

the page type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a custom view

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

Request Body schema:
required

the custom view to create

Name
required
string non-empty
PageType
required
string
Enum: "Journal" "Ledger"
View
required
string
Enum: "Standard" "Analytic"
required
object (LedgerByAccountSearch)
EntryScope
string or null
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
SortBy
string or null
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"
SortDesc
boolean
Size
integer <int32>
HiddenColumns
Array of strings or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "PageType": "Journal",
  • "View": "Standard",
  • "Search": {
    },
  • "EntryScope": "All",
  • "AccountScope": "General",
  • "SortBy": "None",
  • "SortDesc": true,
  • "Size": 0,
  • "HiddenColumns": [
    ]
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "PageType": "Journal",
  • "View": "Standard",
  • "Search": {
    },
  • "EntryScope": "All",
  • "AccountScope": "General",
  • "SortBy": "None",
  • "SortDesc": true,
  • "Size": 0,
  • "HiddenColumns": [
    ],
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Get a custom view by id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

customViewId
required
integer <int32>

the custom view Id

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "PageType": "Journal",
  • "View": "Standard",
  • "Search": {
    },
  • "EntryScope": "All",
  • "AccountScope": "General",
  • "SortBy": "None",
  • "SortDesc": true,
  • "Size": 0,
  • "HiddenColumns": [
    ],
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Update a custom view

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

customViewId
required
integer <int32>

the custom view Id

Request Body schema:
required

the custom view update

Name
required
string non-empty
required
object (LedgerByAccountSearch)
EntryScope
string or null
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"
AccountScope
string or null
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
SortBy
string or null
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"
SortDesc
boolean
Size
integer <int32>
HiddenColumns
Array of strings or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Search": {
    },
  • "EntryScope": "All",
  • "AccountScope": "General",
  • "SortBy": "None",
  • "SortDesc": true,
  • "Size": 0,
  • "HiddenColumns": [
    ]
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "PageType": "Journal",
  • "View": "Standard",
  • "Search": {
    },
  • "EntryScope": "All",
  • "AccountScope": "General",
  • "SortBy": "None",
  • "SortDesc": true,
  • "Size": 0,
  • "HiddenColumns": [
    ],
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Delete a custom view

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

customViewId
required
integer <int32>

the custom view Id

Responses

Dashboard

Get short term (12 months) debt

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>

Default value : Today

endDate
string <date-time>

Default value : Today

withInterest
boolean

Compute debt with interests

withFees
boolean

Compute debt with fees (insurance, commission, ...)

Responses

Response samples

Content type
application/json
{
  • "Values": [
    ],
  • "Total": 0
}

Get remaining debt (164)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Amount": 0
}

Get sale of goods (707 - 7097)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Amount": 0,
  • "DifferencePercentage": 0
}

Get service provision (706)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Amount": 0,
  • "DifferencePercentage": 0
}

Get turnover

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

periodicity
string
Enum: "Monthly" "Quarterly" "Biannually" "Annual"

0 = Monthly, 1 = Quarterly, 2 = Biannually, 3 = Annual

compareWithPreviousExercise
boolean

Compare within same period but previous exercise

Responses

Response samples

Content type
application/json
{
  • "YearToDate": 0,
  • "Values": [
    ]
}

Get the amount of the suppliers debt

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Amount": 0
}

Get the amount of the clients debt

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Amount": 0
}

Get the distribution of the staff costs and compare it with previous exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

includeHeadCompany
boolean

Include or not the top management

Responses

Response samples

Content type
application/json
{
  • "Variation": 0,
  • "Global": 0,
  • "Values": [
    ]
}

Get the distribution of the expenses and compare it with previous exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Variation": 0,
  • "Amount": 0,
  • "Values": [
    ]
}

Get the distribution of the top clients

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

maxResult
integer <int32>

Max result returned. Default value: 10

Responses

Response samples

Content type
application/json
{
  • "TopClients": [
    ]
}

Get the distribution of the staff costs through exercise and compare it with previous exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

includeHeadCompany
boolean

Include or not the top management

includeCumulative
boolean

Include cumulative amount during period

Responses

Response samples

Content type
application/json
{
  • "Variation": 0,
  • "Global": 0,
  • "Values": [
    ]
}

Get the distribution of the payment evolution through exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

withInterest
boolean

Include interest or not

withFees
boolean

Include fees or not

Responses

Response samples

Content type
application/json
{
  • "Total": 0,
  • "Values": [
    ]
}

Get the bank balance summary

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

Responses

Response samples

Content type
application/json
{
  • "Banks": [
    ],
  • "Total": 0
}

Get the distribution of the bank balances through exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Identifier of the enterprise

query Parameters
startDate
string <date-time>

Default value: Today

endDate
string <date-time>

Default value: Today

subAccountId
integer <int32>

Filter by bank. By default, all banks are taken.

showCumulative
boolean

Include cumulative amount during period

Responses

Response samples

Content type
application/json
{
  • "Values": [
    ],
  • "Balance": 0
}

GetFiscalSummary for an accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "TaxSystemSummary": "string",
  • "VatSystemSummary": "string"
}

Get the distribution of the main expense items through exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>
accounts
Array of strings unique

Responses

Response samples

Content type
application/json
{
  • "MainExpenseItems": [
    ]
}

Get suspense account info with lines in bank account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "TotalLines": 0,
  • "BankLines": 0
}

Get internal wire balance info

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "UnbalancedAccountsCount": 0,
  • "BalancedAccountsCount": 0
}

Get entry lines info

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "EntriesLinesUnrevisedCount": 0
}

Get accounts amount

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>
accounts
Array of strings

Responses

Response samples

Content type
application/json
{
  • "AccountsAmount": [
    ]
}

Get all journals progress on a defined interval for a given accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "MonthsInPeriod": [
    ],
  • "Journals": [
    ],
  • "TotalEntriesCountInPeriod": 0,
  • "TotalEntryLinesCountInPeriod": 0
}

DeclarationTax

Get the company information

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Enterprise": {
    },
  • "AccountTax": [
    ]
}

DocDatas

Get many DocData Deprecated

Authorizations:
oauth2
query Parameters
ids
Array of integers <int32> [ items <int32 > ]
fileIds
Array of integers <int32> [ items <int32 > ]
enterpriseId
integer <int32>
type
string
size
integer <int32>

Default null. Size by page

page
integer <int32>

Default null. Page number, starting by 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a new DocData Deprecated

Authorizations:
oauth2
Request Body schema:
Id
required
integer <int32>
FileId
required
integer <int32>
EnterpriseId
required
integer <int32>
Type
string or null
Category
string or null
CountryClass
string or null
ValueDate
string or null <date-time>
TargetDate
string or null <date-time>
ExpDateBegin
string or null <date-time>
ExpDateEnd
string or null <date-time>
Mixed
required
boolean
DocRef
string or null
VatAmount
number or null <double>
HtAmount
number or null <double>
TtcAmount
number or null <double>
CurrencyId
integer <int32>
CurrencyIsoCode
string or null
CurrencyName
string or null
CountryId
integer <int32>
CountryName
string or null
LanguageId
integer <int32>
LanguageIETFTag
string or null
LanguageLabel
string or null
ContactId
integer <int32>
object (DocContact)
NatureId
integer <int32>
object (DocNature)
Array of objects or null (DocPrice)
CurrencyConf
number or null <double>
CountryConf
number or null <double>
LanguageConf
number or null <double>
NatureConf
number or null <double>
PriceConf
number or null <double>
DocRefConf
number or null <double>
ValueDateConf
number or null <double>
CategoryConf
number or null <double>
GenerateEntry
required
boolean
AiModelName
string or null
PageCount
integer <int32>
EnterpriseSynonymId
integer <int32>
EnterpriseSynonymName
string or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Get DocData by Id Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Update an existing DocData Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
FileId
required
integer <int32>
EnterpriseId
required
integer <int32>
Type
string or null
Category
string or null
CountryClass
string or null
ValueDate
string or null <date-time>
TargetDate
string or null <date-time>
ExpDateBegin
string or null <date-time>
ExpDateEnd
string or null <date-time>
Mixed
required
boolean
DocRef
string or null
VatAmount
number or null <double>
HtAmount
number or null <double>
TtcAmount
number or null <double>
CurrencyId
integer <int32>
CurrencyIsoCode
string or null
CurrencyName
string or null
CountryId
integer <int32>
CountryName
string or null
LanguageId
integer <int32>
LanguageIETFTag
string or null
LanguageLabel
string or null
ContactId
integer <int32>
object (DocContact)
NatureId
integer <int32>
object (DocNature)
Array of objects or null (DocPrice)
CurrencyConf
number or null <double>
CountryConf
number or null <double>
LanguageConf
number or null <double>
NatureConf
number or null <double>
PriceConf
number or null <double>
DocRefConf
number or null <double>
ValueDateConf
number or null <double>
CategoryConf
number or null <double>
GenerateEntry
required
boolean
AiModelName
string or null
PageCount
integer <int32>
EnterpriseSynonymId
integer <int32>
EnterpriseSynonymName
string or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Delete a existing DocData Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Update an existing DocData by AI Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
FileId
required
integer <int32>
EnterpriseId
required
integer <int32>
Type
string or null
Category
string or null
CountryClass
string or null
ValueDate
string or null <date-time>
TargetDate
string or null <date-time>
ExpDateBegin
string or null <date-time>
ExpDateEnd
string or null <date-time>
Mixed
required
boolean
DocRef
string or null
VatAmount
number or null <double>
HtAmount
number or null <double>
TtcAmount
number or null <double>
CurrencyId
integer <int32>
CurrencyIsoCode
string or null
CurrencyName
string or null
CountryId
integer <int32>
CountryName
string or null
LanguageId
integer <int32>
LanguageIETFTag
string or null
LanguageLabel
string or null
ContactId
integer <int32>
object (DocContact)
NatureId
integer <int32>
object (DocNature)
Array of objects or null (DocPrice)
CurrencyConf
number or null <double>
CountryConf
number or null <double>
LanguageConf
number or null <double>
NatureConf
number or null <double>
PriceConf
number or null <double>
DocRefConf
number or null <double>
ValueDateConf
number or null <double>
CategoryConf
number or null <double>
GenerateEntry
required
boolean
AiModelName
string or null
PageCount
integer <int32>
EnterpriseSynonymId
integer <int32>
EnterpriseSynonymName
string or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "EnterpriseId": 0,
  • "Type": "string",
  • "Category": "string",
  • "CountryClass": "string",
  • "ValueDate": "2019-08-24T14:15:22Z",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "ExpDateBegin": "2019-08-24T14:15:22Z",
  • "ExpDateEnd": "2019-08-24T14:15:22Z",
  • "Mixed": true,
  • "DocRef": "string",
  • "VatAmount": 0.1,
  • "HtAmount": 0.1,
  • "TtcAmount": 0.1,
  • "CurrencyId": 0,
  • "CurrencyIsoCode": "string",
  • "CurrencyName": "string",
  • "CountryId": 0,
  • "CountryName": "string",
  • "LanguageId": 0,
  • "LanguageIETFTag": "string",
  • "LanguageLabel": "string",
  • "ContactId": 0,
  • "Contact": {
    },
  • "NatureId": 0,
  • "Nature": {
    },
  • "Prices": [
    ],
  • "CurrencyConf": 0.1,
  • "CountryConf": 0.1,
  • "LanguageConf": 0.1,
  • "NatureConf": 0.1,
  • "PriceConf": 0.1,
  • "DocRefConf": 0.1,
  • "ValueDateConf": 0.1,
  • "CategoryConf": 0.1,
  • "GenerateEntry": true,
  • "AiModelName": "string",
  • "PageCount": 0,
  • "EnterpriseSynonymId": 0,
  • "EnterpriseSynonymName": "string"
}

DocDatas_GetInvoiceTypes Deprecated

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DocDatas_GetInvoiceCategories Deprecated

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DocEntries

Add Document entry

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects (CreateDocEntryCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Attach document to an entry

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryId
required
integer <int32>
AccountingDocumentId
required
integer <int32>
Date
string or null <date-time>
Reference
string or null

Responses

Request samples

Content type
{
  • "EntryId": 0,
  • "AccountingDocumentId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "Reference": "string"
}

Attach document to entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryIds
required
Array of integers <int32> [ items <int32 > ]
AccountingDocumentId
required
integer <int32>
Date
string or null <date-time>
Reference
string or null

Responses

Request samples

Content type
{
  • "EntryIds": [
    ],
  • "AccountingDocumentId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "Reference": "string"
}

Detach documents from entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
AccountingDocumentIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "AccountingDocumentIds": [
    ]
}

ElectronicDocuments

Get the full recursive folder hierarchy (folders only) accessible to the current user in the EDM. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get user main folders with details for the home page of the electronic document management system (EDM). Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "RecentFiles": 0,
  • "ValidationState": {
    },
  • "Folders": [
    ],
  • "SharedFoldersCount": 0
}

Get the permanents folders Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the folders of a given exercise Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
exerciseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the list of folders shared to the current user via explicit FolderUserAccess on the given tenant. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the folders in a given folder Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a folder with its content Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "UserAuthorizations": [
    ],
  • "Folders": [
    ],
  • "Files": [
    ],
  • "OwnerId": 0,
  • "IsHidden": true,
  • "Path": [
    ],
  • "IsSharedWithClient": true
}

Move a folder from a folder to another Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
OriginFolderId
required
integer <int32>
DestinationFolderId
required
integer <int32>
FolderId
required
integer <int32>

Responses

Request samples

Content type
{
  • "OriginFolderId": 0,
  • "DestinationFolderId": 0,
  • "FolderId": 0
}

Move multiple files from a folder to another Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
OriginFolderId
required
integer <int32>
DestinationFolderId
required
integer <int32>
FileIds
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "OriginFolderId": 0,
  • "DestinationFolderId": 0,
  • "FileIds": [
    ]
}

Delete multiple files from a given folder Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
FolderId
required
integer <int32>
FileIds
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "FolderId": 0,
  • "FileIds": [
    ]
}

Uploads multiple files to a specific folder within the given accounting folder. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The identifier of the accounting folder associated with the operation.

query Parameters
folderId
integer <int32>

The identifier of the target folder where files will be uploaded.

Request Body schema: multipart/form-data
files
Array of strings or null <binary> [ items <binary > ]

The list of files to be uploaded.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload files while detecting those whose content is identical to a file already in the recycle bin (US #65401). Returns the created files plus the detected recycle-bin duplicates (not created), so the front can offer to restore the existing file. To create a new file anyway, call the regular `files` endpoint. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The identifier of the accounting folder associated with the operation.

query Parameters
folderId
integer <int32>

The identifier of the target folder where files will be uploaded.

Request Body schema: multipart/form-data
files
Array of strings or null <binary> [ items <binary > ]

The list of files to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "Created": [
    ],
  • "RecycleBinDuplicates": [
    ]
}

Upload a file to an account storage and return its public URL

Authorizations:
oauth2
Request Body schema: multipart/form-data
EntityName
string or null
File
string or null <binary>

Responses

Response samples

Content type
application/json
"string"

Enable and initialize Delta synchronization for the specified accounting folder. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder.

Responses

Uploads a file to the Delta container associated with the specified accounting folder Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fileItemId
required
integer <int32>
Request Body schema:
SimpleUserToken
string or null
UserId
integer <int32>

Responses

Request samples

Content type
{
  • "SimpleUserToken": "string",
  • "UserId": 0
}

Shares selected files from the specified accounting folder by sending them to the provided email addresses. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder.

Request Body schema:
required

The command containing details about the files to be shared, recipients, and optional validation duration.

Title
required
string or null
Text
required
string or null
Email
required
string or null

Responses

Request samples

Content type
{
  • "Title": "string",
  • "Text": "string",
  • "Email": "string"
}

Disables the delta mode for the specified accounting folder. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder.

Responses

Get all the files updating in the last 30 days Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the recycle bin root entries (soft-deleted files and folders) of an accounting folder, readable by the current user. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
page
integer <int32>
Default: 1

1-based page number.

pageSize
integer <int32>
Default: 50

Number of items per page.

Responses

Response samples

Content type
application/json
{
  • "Items": [
    ],
  • "TotalCount": 0,
  • "Page": 0,
  • "PageSize": 0
}

Content of a deleted folder opened from the recycle bin (RG-09 / AC-03): its direct deleted subfolders and files, navigable recursively through this same endpoint. 404 when the folder is not in the recycle bin (living, permanently deleted, or not visible to the caller). Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "DeletedByUserId": 0,
  • "Folders": [
    ],
  • "Files": [
    ]
}

Restore a soft-deleted file or folder from the recycle bin back to its original location. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
ItemId
required
integer <int32>
Type
required
string
Enum: "File" "Folder"
TargetFolderId
integer <int32>

Responses

Request samples

Content type
{
  • "ItemId": 0,
  • "Type": "File",
  • "TargetFolderId": 0
}

Permanently delete a single file or folder from the recycle bin. The item leaves the recycle bin and cannot be restored. Requires the same write right as deletion in the main GED (Document/Delete on the location). Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
ItemId
required
integer <int32>
Type
required
string
Enum: "File" "Folder"

Responses

Request samples

Content type
{
  • "ItemId": 0,
  • "Type": "File"
}

Empty the recycle bin: permanently delete every item the current user sees in it (and is allowed to delete). Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Get the list of enterprise collaborators eligible to receive an access on a folder, with their current right if any. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upsert access rights for a batch of collaborators on a folder and all its sub-folders. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>
Request Body schema:
required
Array of objects or null (FolderCollaboratorAccessDto)

Responses

Request samples

Content type
{
  • "Accesses": [
    ]
}

Remove access rights for a batch of collaborators from a folder and all its sub-folders. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
folderId
required
integer <int32>
Request Body schema:
required
UserIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "UserIds": [
    ]
}

Get a file stream from Delta by file id. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier.

fileItemId
required
integer <int32>

The file item identifier.

Responses

Response samples

Content type
application/json
"string"

ElectronicDocumentsAdmin

Lists direct non-hidden subfolders of a given parent folder. No role filter is applied: all folders scoped to accountingFolderId are visible. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier.

parentFolderId
required
integer <int32>

The parent folder whose children to list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a custom subfolder under an existing parent folder. Idempotent: returns the existing folder when a folder with the same name already exists. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier.

parentFolderId
required
integer <int32>

The parent folder in which to create the subfolder.

Request Body schema:
required

The create command containing the subfolder name.

ParentFolderId
required
integer <int32>
Name
required
string or null

Responses

Request samples

Content type
{
  • "ParentFolderId": 0,
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "FoldersCount": 0,
  • "FilesCount": 0,
  • "UserAuthorizations": [
    ],
  • "OwnerId": 0,
  • "IsHidden": true,
  • "IsSharedWithClient": true
}

Copies a file to a destination folder within the same accounting folder. Both the source file and the destination folder must belong to the given accountingFolderId (C1-bis). Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier.

Request Body schema:
required

The copy command containing the file id and destination folder id.

FileId
required
integer <int32>
DestinationFolderId
required
integer <int32>

Responses

Request samples

Content type
{
  • "FileId": 0,
  • "DestinationFolderId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "FolderId": 0,
  • "SynchronizationStatus": "None",
  • "UserAuthorizations": [
    ],
  • "Validation": {
    },
  • "Path": [
    ]
}

Returns the id of the EnterprisePermanentFolder root for admin (machine-to-machine) callers. No role filter is applied: all folders scoped to accountingFolderId are visible. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier.

Responses

Response samples

Content type
application/json
{
  • "Id": 0
}

Creates the base personal folder tree for a user within an accounting folder. Idempotent: safe to call multiple times — folders are created only if absent. Intended for the personal-folders WebJob that consumes UserAssignedToAccountingFolderEvent from Service Bus. Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder identifier (== enterpriseId in GED).

userId
required
integer <int32>

The user identifier.

Responses

EnterpriseAggregateOperations

Update enterprises aggregate data

Authorizations:
oauth2
Request Body schema:

List of enterprise aggregate ids to update

required
Array of objects or null (EnterpriseAggregate)

Responses

Request samples

Content type
{
  • "EnterpriseAggregates": [
    ]
}

EnterpriseEmailProviders

Get EnterpriseEmailProviders

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obsolete - Create a EnterpriseEmailProvider Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EnterpriseId
required
integer <int32>
Email
string or null

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Email": "string"
}

Delete a EnterpriseEmailProvider

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "UserId": 0,
  • "User": {
    },
  • "EnterpriseId": 0,
  • "Enterprise": {
    },
  • "Email": "string",
  • "Id": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0
}

Get EnterpriseEmailProvider

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "UserId": 0,
  • "User": {
    },
  • "EnterpriseId": 0,
  • "Enterprise": {
    },
  • "Email": "string",
  • "Id": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0
}

Get accountingFolderEmailProvider

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a EnterpriseEmailProvider

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UserId": 0,
  • "EnterpriseId": 0,
  • "Email": "string"
}

Edit AcceptProviderEmails value of Enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
acceptProviderEmails
boolean

Responses

EnterprisePdp

Update pdp infos to an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Status
string or null
UpdatedAt
required
string <date-time>

Responses

Request samples

Content type
{
  • "Status": "string",
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Enterprises

Get current state Create = -1,Inactive = 0,Active = 1,

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "StateMode": "Active"
}

Get by Id

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "IsAccounting": true,
  • "CompanyType": "None",
  • "Name": "string",
  • "Container": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Siret": "string",
  • "Street": "string",
  • "City": "string",
  • "ZipCode": "string",
  • "Telephone": "string",
  • "UrlLogo": "string",
  • "UrlLogoMini": "string",
  • "Description": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "CountryCodeId": 0,
  • "EnterpriseInfoGreffeId": 0,
  • "UniqueName": "string",
  • "ExternalId": "string",
  • "AcceptProviderEmails": true,
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "DateInFred": "2019-08-24T14:15:22Z",
  • "LegalFormId": 0,
  • "TaxSystemId": 0,
  • "WithDepositeISTax": true,
  • "VatSystemId": 0,
  • "VatDeadlineDay": 0,
  • "OwnerLastName": "string",
  • "AccountingMode": "Manual",
  • "Type": "Normal",
  • "StateMode": "Active",
  • "AccountingModeChangeDate": "2019-08-24T14:15:22Z",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z",
  • "ChartOfAccountsId": 0,
  • "AccountingFolderTypology": "BookKeeping",
  • "AccountingType": "Engagement",
  • "CseType": "None",
  • "ManagementMode": "TotalProduction"
}

Delete a existing enterprise

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
query Parameters
permanentDelete
boolean
Default: false
deletedAt
string <date-time>

Responses

Client Header text

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "EnterpriseId": 0,
  • "UrlEnterpriseLogo": "string",
  • "EnterpriseName": "string",
  • "LegalForm": "string",
  • "Activity": "string",
  • "Description": "string"
}

Get enterprise general information

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "IsAccounting": true,
  • "CompanyId": 0,
  • "CompanyType": "None",
  • "LegalFormId": 0,
  • "LegalForm": {
    },
  • "Siren": "string",
  • "Nic": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "LetterMissionDate": "2019-08-24T14:15:22Z",
  • "IsListedOnTradeDirectory": true,
  • "Street": "string",
  • "AdditionalAddress": "string",
  • "Hamlet": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "CountryCodeId": 0,
  • "Telephone": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "VatSystemId": 0,
  • "UrlLogo": "string",
  • "Email": "string",
  • "Website": "string",
  • "Activity": "string",
  • "ExternalId": "string",
  • "ChartOfAccountsId": 0,
  • "AccountingFolderTypology": "BookKeeping",
  • "AccountingType": "Engagement",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "HasAccountingSoftware": true,
  • "AccountingSoftwareName": "string",
  • "HasProductionLegalAnnexesAnnualAccounts": true,
  • "HasVatKeeping": true,
  • "IsMedicoSocial": true,
  • "VatDeadlineDay": 0,
  • "OwnerLastName": "string"
}

Get Enterprise basic infomration from SIREN

Authorizations:
oauth2
query Parameters
siren
string

Siren number that needs to be looked for in our db (no spaces)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Enterprise Fiscal Information

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "TaxSystemId": 0,
  • "TaxSystem": {
    },
  • "WithDepositeISTax": true,
  • "VatSystemId": 0,
  • "VatSystem": {
    },
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "VatRateOnTaxableSales": [
    ],
  • "VatRateOnTaxablePurchases": 0,
  • "SalesExigibilite": "Unknown",
  • "Rof": "string",
  • "RofCVAE": "string",
  • "TaxReporterGender": "string",
  • "TaxReporterName": "string",
  • "TaxReporterTitle": "string",
  • "IsSubjectToCbCR": true,
  • "IsOverHeadCosts": true,
  • "IsTransferPricing": true,
  • "IsCvaeAdvanceDeposit": true,
  • "IsBalance": true,
  • "IsSubjectToCvae": true,
  • "IsSubjectTo1330Cvae": true,
  • "IsMonoEstablishment": true,
  • "IsEligibleForReducedRate": true,
  • "TaxIntracommunityNumber": "string",
  • "EnterpriseAdvisors": [
    ],
  • "HasPayrollTaxLiability": true,
  • "HasCfeLiability": true,
  • "IsAgriculturalCA12Applicable": true
}

Update Enterprise Fiscal Information

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
TaxSystemId
integer <int32>
WithDepositeISTax
required
boolean
VatSystemId
integer <int32>
IsAgriculturalCA12Applicable
boolean
VatDeadlineDay
integer <int32>
VatTaxObligationReference
string or null
VatRateOnTaxableSales
Array of numbers or null <decimal> [ items <decimal > ]
VatRateOnTaxablePurchases
number or null <decimal>
SalesExigibilite
string or null
Enum: "Unknown" "OnReceipts" "OnDebits" "VatOptionOnDebits" "Mixed"
Rof
string or null
RofCVAE
string or null
TaxReporterGender
string or null
TaxReporterName
string or null
TaxReporterTitle
string or null
IsSubjectToCbCR
required
boolean
IsOverHeadCosts
required
boolean
IsTransferPricing
required
boolean
IsCvaeAdvanceDeposit
required
boolean
IsBalance
required
boolean
IsSubjectToCvae
required
boolean
IsSubjectTo1330Cvae
required
boolean
IsMonoEstablishment
required
boolean
IsEligibleForReducedRate
required
boolean
TaxIntracommunityNumber
string or null
Array of objects or null (EnterpriseAdvisorCommand)
HasPayrollTaxLiability
boolean
HasCfeLiability
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "TaxSystemId": 0,
  • "WithDepositeISTax": true,
  • "VatSystemId": 0,
  • "IsAgriculturalCA12Applicable": true,
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "VatRateOnTaxableSales": [
    ],
  • "VatRateOnTaxablePurchases": 0,
  • "SalesExigibilite": "Unknown",
  • "Rof": "string",
  • "RofCVAE": "string",
  • "TaxReporterGender": "string",
  • "TaxReporterName": "string",
  • "TaxReporterTitle": "string",
  • "IsSubjectToCbCR": true,
  • "IsOverHeadCosts": true,
  • "IsTransferPricing": true,
  • "IsCvaeAdvanceDeposit": true,
  • "IsBalance": true,
  • "IsSubjectToCvae": true,
  • "IsSubjectTo1330Cvae": true,
  • "IsMonoEstablishment": true,
  • "IsEligibleForReducedRate": true,
  • "TaxIntracommunityNumber": "string",
  • "EnterpriseAdvisors": [
    ],
  • "HasPayrollTaxLiability": true,
  • "HasCfeLiability": true
}

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

Get Enterprise Legal Information

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "HasLegalAssistanceMission": true,
  • "JuristUserId": 0,
  • "JuristUser": {
    }
}

Get Clients of an enterprise or of a user of the enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

enterpriseId (of user)

Request Body schema:

Search parameters

object or null
object or null
Page
integer <int32>
Size
integer <int32>

Responses

Request samples

Content type
{
  • "SearchFields": {
    },
  • "SortFields": {
    },
  • "Page": 0,
  • "Size": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Clients of an enterprise or of a user of the enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

enterpriseId (of user)

query Parameters
userId
integer <int32>

If null, get all clients of enteprise, if non null, get only clients of user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add enterprise to favorite

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise identifier

query Parameters
userId
integer <int32>

Responses

Remove enterprise from favorites

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise identifier

query Parameters
userId
integer <int32>

Responses

Switch enterprise mode

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StateMode
required
string
Enum: "Active" "Closing" "Archived" "Migration"
StateModeChangeDateTime
string or null <date-time>
Note
required
string non-empty

Responses

Request samples

Content type
{
  • "StateMode": "Active",
  • "StateModeChangeDateTime": "2019-08-24T14:15:22Z",
  • "Note": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UserId": 0,
  • "User": {
    },
  • "ActionAt": "2019-08-24T14:15:22Z",
  • "StateMode": "Active",
  • "AccountingMode": "Manual",
  • "Type": "Normal",
  • "Note": "string",
  • "AuditVersion": 0,
  • "AccountingModeChangeDate": "2019-08-24T14:15:22Z",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z"
}

Update AccountingMode

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
AccountingMode
required
string
Enum: "Manual" "Auto"
AccountingChangeModeDateTime
string or null <date-time>
Note
required
string non-empty

Responses

Request samples

Content type
{
  • "AccountingMode": "Manual",
  • "AccountingChangeModeDateTime": "2019-08-24T14:15:22Z",
  • "Note": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UserId": 0,
  • "User": {
    },
  • "ActionAt": "2019-08-24T14:15:22Z",
  • "Action": "Active",
  • "AccountingMode": "Manual",
  • "Type": "Normal",
  • "Note": "string",
  • "AuditVersion": 0,
  • "AccountingModeChangeDate": "2019-08-24T14:15:22Z",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z"
}

Enterprises_SwitchManagementMode

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
managementMode
required
string
Enum: "TotalProduction" "PreAccounting"

Responses

EnterprisesRights

EnterprisesRights_CanManageBank

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

EnterprisesRights_CanAccessEnterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
isWrite
boolean

Responses

Response samples

Content type
application/json
true

Entries

Get the journal

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the accounting folder Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

virtualAnBehavior
string
Enum: "Default" "Grouped"
page
required
integer <int32>
Default: 1

The page

size
required
integer <int32> [ 1 .. 10000 ]
Default: 100

The size

sortBy
required
string
Default: "Date"
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"

The sort by

sortDesc
required
boolean
Default: true

the sort direction

entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"

The entry scope

entryFilter
string
Default: 3
Enum: "Real" "Virtual" "All"

The entry filter

Request Body schema:
required

The body object

required
object (JournalEntriesSearch)
required
object (JournalEntriesOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
{
  • "Metadata": {
    },
  • "Data": [
    ]
}

Get the entry by entry id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder Id

entryId
required
integer <int32>

The entry Id

query Parameters
withAnalytics
boolean
withQuantities
boolean
withAssociations
boolean
withTransactionId
boolean
withEntryRef
boolean
withDocDate
boolean
withReAllocatedAt
boolean
withAccountName
boolean
withEntryLineType
boolean
withEntryLabel
boolean
withSellingPrice
boolean
withPaymentMethod
boolean
withDueDate
boolean

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "JournalId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "ExerciseId": 0,
  • "Label": "string",
  • "DocRef": "string",
  • "EntryRef": "string",
  • "DocDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "PaymentMethod": "string",
  • "FileId": 0,
  • "TransactionId": 0,
  • "Source": "ByUser",
  • "SourceId": "string",
  • "LastUpdateDate": "2019-08-24T14:15:22Z",
  • "UserId": 0,
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "PaymentMode": "string",
  • "NatureOperation": "string",
  • "ClientId": "string",
  • "Lines": [
    ]
}

Get the physical entries by a search criteria

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder Id

Request Body schema:
required
required
object (GetEntriesSearch)
required
object (JournalEntriesOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Export the journal

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the accounting folder Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

virtualAnBehavior
string
Enum: "Default" "Grouped"
sortBy
required
string
Default: "Date"
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"

The sort by

sortDesc
required
boolean
Default: true

the sort direction

entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"

The entry scope

entryFilter
string
Default: 3
Enum: "Real" "Virtual" "All"
journalExportType
required
string
Default: "Excel"
Enum: "Excel" "Csv"

The journal export type

Request Body schema:
required

The export object

required
object (JournalEntriesExportSearch)
required
object (JournalEntriesExportOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
"string"

Create an entry

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects (CreateEntryCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

Get entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entriesId
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array of objects or null (UpdateEntryCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Get invoice payment

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>
journalType
string
Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"
includeDoubtfulAccounts
boolean
Default: false
page
integer <int32>

1-based page number. Omit page and pageSize to get the whole period at once.

pageSize
integer <int32>

Number of entries per page. A page smaller than pageSize is the last one.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get lines for bank stability

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
shouldGetEntryLinesInAllPendingAccounts
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upsert entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects (UpsertEntriesCommandEntry) <= 500 items

Responses

Request samples

Content type
{
  • "Entries": [
    ]
}

Response samples

Content type
application/json
{
  • "Entries": [
    ]
}

Update entries without lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array of objects or null (UpdateEntryWithoutLinesCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Delete fixed assets entries by journal and period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
exerciseId
required
integer <int32>
journalId
required
integer <int32>

Responses

Delete entries by source, day and journal

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
journalId
required
integer <int32>
day
required
string <date-time>
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"

Responses

Delete entries by a list of Ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

System.Int32 representing the id of the client

Request Body schema:
required

Command object containing Ids of entries

EntriesIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EntriesIds": [
    ]
}

Delete entries by a list of Ids with impacts (used by UI) It is a two step process: - First, we return the number of impacted lines and number of unlettered lines - Second, if the user confirms, we process the deletion of the entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EntryIds
required
Array of integers <int32> [ items <int32 > ]
IsConfirmed
required
boolean

Responses

Request samples

Content type
{
  • "EntryIds": [
    ],
  • "IsConfirmed": true
}

Response samples

Content type
application/json
{
  • "EntryLinesToUnmatchCount": 0,
  • "EntryLinesToDeleteCount": 0,
  • "IsCommited": true
}

Get entries by source and source Id Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
sourceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
journalId
required
integer <int32>
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
sourceId
required
string
startDate
string <date-time>

Responses

Get entries by source and line source Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
sourceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get entries by source and entry source Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
entrySourceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get entries by source and entry lines source ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
entrySource
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"

Entry source type (Loan, Lease, CutOff, ...)

sourceIds
required
Array of strings

List of source ids to filter. (50 items max).

startDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unvalidate entries by period ADMIN ONLY

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • 0
]

Unvalidate entries by ids ADMIN ONLY

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EntryIds": [
    ]
}

Validate entries by ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntriesIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EntriesIds": [
    ]
}

Response samples

Content type
application/json
true

Validate entries in the situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
SituationId
required
integer <int32>
ForceEvenIfInconsistency
boolean

Responses

Request samples

Content type
{
  • "SituationId": 0,
  • "ForceEvenIfInconsistency": true
}

Response samples

Content type
application/json
true

Defines whether the selected period contains (or not) validated entries.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>

Responses

Response samples

Content type
application/json
true

Reverse an entry

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryId
required
integer <int32>
Request Body schema:
required
OverrideEntryDate
string or null <date-time>
OverrideJournalId
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
0
0

Reverse a list of entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryIds
required
Array of integers <int32> [ items <int32 > ]
OverrideEntryDate
string or null <date-time>
OverrideJournalId
integer <int32>

Responses

Request samples

Content type
{
  • "EntryIds": [
    ],
  • "OverrideEntryDate": "2019-08-24T14:15:22Z",
  • "OverrideJournalId": 0
}

Response samples

Content type
application/json
[
  • 0
]

Reverse a list of entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects (ReallocateLineByCopy)
OverrideEntryDate
string or null <date-time>
OverrideJournalId
integer <int32>
ReallocateAccountId
required
integer <int32>
ReallocateSubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "ToReallocate": [
    ],
  • "OverrideEntryDate": "2019-08-24T14:15:22Z",
  • "OverrideJournalId": 0,
  • "ReallocateAccountId": 0,
  • "ReallocateSubAccountId": 0
}

Response samples

Content type
application/json
[
  • 0
]

Update Revision Status on period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
AccountingFolderId
required
integer <int32>
BeginDate
required
string <date-time>
EndDate
required
string <date-time>
Revision
required
string
Enum: "Unrevised" "Revised"
object (AccountKey)
Array of objects or null (AccountKey)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "Revision": "Unrevised",
  • "AccountKey": {
    },
  • "AccountsKeys": [
    ]
}

Update Revision Status on entry

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryId
required
integer <int32>
Request Body schema:
required
Revision
required
string
Enum: "Unrevised" "Revised"

Responses

Request samples

Content type
{
  • "Revision": "Unrevised"
}

Update revision status

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the accounting folder Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

reviseEntryLines
required
boolean

Revise the entry lines or not

accountScope
string
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"

The account scope

entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"

The entry scope

Request Body schema:
required

The body object

required
object (JournalEntriesSearch)
required
object (JournalEntriesOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Get available units

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "AvailableUnits": [
    ]
}

Ensure entries can be impacted

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects or null (EntriesGenerationAvailibilityQuery)
required
Array of objects or null (EntriesGenerationAvailibilityQuery)
required
Array of objects or null (EntriesGenerationAvailibilityQuery)

Responses

Request samples

Content type
{
  • "Create": [
    ],
  • "Update": [
    ],
  • "Delete": [
    ]
}

Response samples

Content type
application/json
{
  • "Create": [
    ],
  • "Update": [
    ],
  • "Delete": [
    ]
}

EntriesJournals

Get entries journals in pdf format

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
"string"

EntryLines

Update entry line cut off type

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryLineId
required
integer <int64>
Request Body schema:
required
CutOffType
required
string
Enum: "None" "CCA" "PCA" "FNP" "AAR"

Responses

Request samples

Content type
{
  • "CutOffType": "None"
}

Get entry lines Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
ids
required
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get entry lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryLineIds
Array of integers or null <int64> [ items <int64 > ]
IncludeDeleted
boolean
WithAccount
boolean

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "IncludeDeleted": true,
  • "WithAccount": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a list of lines to letter.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Accounts
Array of integers or null <int32> [ items <int32 > ]
SubAccountIds
Array of integers or null <int32> [ items <int32 > ]
AccountNames
Array of strings or null
Start
required
string <date-time>
End
required
string <date-time>

Responses

Request samples

Content type
{
  • "Accounts": [
    ],
  • "SubAccountIds": [
    ],
  • "AccountNames": [
    ],
  • "Start": "2019-08-24T14:15:22Z",
  • "End": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "LinesToLetter": [
    ]
}

Add associations on entry lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
AssociationModule
required
string
Enum: "Unknown" "CutOff" "FixedAsset" "Grant" "CurrentAccountInterest"
AssociationType
required
string
Enum: "Unknown" "CCA" "PCA" "FNP" "AAR" "FixedAsset" "Grant" "CurrentAccountInterest" "FAE" "AAE" "CAP" "PAR"
Array of objects or null (AssociationCommand)

Responses

Request samples

Content type
{
  • "AssociationModule": "Unknown",
  • "AssociationType": "Unknown",
  • "Association": [
    ]
}

Delete associations

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
AssociationModule
required
string
Enum: "Unknown" "CutOff" "FixedAsset" "Grant" "CurrentAccountInterest"
AssociationType
required
string
Enum: "Unknown" "CCA" "PCA" "FNP" "AAR" "FixedAsset" "Grant" "CurrentAccountInterest" "FAE" "AAE" "CAP" "PAR"
SourceId
required
integer <int32>
EntryLineIds
Array of integers or null <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "AssociationModule": "Unknown",
  • "AssociationType": "Unknown",
  • "SourceId": 0,
  • "EntryLineIds": [
    ]
}

Add association on an entry line

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryLineId
required
integer <int64>
Request Body schema:
required
AssociationModule
required
string
Enum: "Unknown" "CutOff" "FixedAsset" "Grant" "CurrentAccountInterest"
AssociationType
required
string
Enum: "Unknown" "CCA" "PCA" "FNP" "AAR" "FixedAsset" "Grant" "CurrentAccountInterest" "FAE" "AAE" "CAP" "PAR"
SourceId
required
integer <int32>

Responses

Request samples

Content type
{
  • "AssociationModule": "Unknown",
  • "AssociationType": "Unknown",
  • "SourceId": 0
}

Response samples

Content type
application/json
0
0

Delete association

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryLineId
required
integer <int64>
Request Body schema:
required
AssociationModule
required
string
Enum: "Unknown" "CutOff" "FixedAsset" "Grant" "CurrentAccountInterest"
AssociationType
required
string
Enum: "Unknown" "CCA" "PCA" "FNP" "AAR" "FixedAsset" "Grant" "CurrentAccountInterest" "FAE" "AAE" "CAP" "PAR"
SourceId
required
integer <int32>

Responses

Request samples

Content type
{
  • "AssociationModule": "Unknown",
  • "AssociationType": "Unknown",
  • "SourceId": 0
}

Transfer entry lines to a different account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryLineIdsSource
required
Array of integers <int64> unique [ items <int64 > ]
required
object (DestinationEntryCommand)

Responses

Request samples

Content type
{
  • "EntryLineIdsSource": [
    ],
  • "DestinationEntry": {
    }
}

Response samples

Content type
application/json
0
0

Backfill a batch of entry line analytics with the denormalized columns of their entry line

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
0
0

Update quantities/units on multiple entry lines

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EntryLineIds
required
Array of integers <int64> unique [ items <int64 > ]
object (QuantityUpdate)
object (QuantityUpdate)

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "Quantity1": {
    },
  • "Quantity2": {
    }
}

Response samples

Content type
application/json
0
0

Exercises

Get All Exercises by enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get by Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Situations": [
    ],
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Year": 0,
  • "Locked": true,
  • "FolderItemId": 0
}

Delete an empty exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
CompanyId
required
integer <int32>

Responses

Request samples

Content type
{
  • "CompanyId": 0
}

Get exercises between two dates (included)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the id of enterprise

query Parameters
start
string <date-time>

first date

end
string <date-time>

last date

withLocked
boolean
Default: false

include locked exercises

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contains A-Nouveau Entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Ids": [
    ]
}

Update beginDate, endDate, Name

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
required
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Situations": [
    ],
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Year": 0,
  • "Locked": true,
  • "FolderItemId": 0
}

Update exercise lock based on value<param name="enterpriseId">Enterprise Id</param><param name="id">Exercise id</param><param name="value">true if the exercise should be locked, false otherwise</param><param name="cancellationToken"></param>

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
query Parameters
value
boolean

Responses

Response samples

Content type
application/json
{
  • "Situations": [
    ],
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Year": 0,
  • "Locked": true,
  • "FolderItemId": 0
}

Update exercise lock based on value, also handles AN generation/deletion <param name="enterpriseId">Enterprise Id</param><param name="id">Exercise id</param><param name="value">true if the exercise should be locked, false otherwise</param><param name="cancellationToken"></param>

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
query Parameters
value
boolean

Responses

Response samples

Content type
application/json
{
  • "Situations": [
    ],
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Year": 0,
  • "Locked": true,
  • "FolderItemId": 0
}

Create new exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Situations": [
    ],
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Year": 0,
  • "Locked": true,
  • "FolderItemId": 0
}

Checks whether an exercise can be deleted.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Error": "None"
}

Get Period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Start": "2019-08-24T14:15:22Z",
  • "End": "2019-08-24T14:15:22Z",
  • "MonthCount": 0
}

Protect exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "ExerciseId": 0,
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Open",
  • "IsClosed": true,
  • "IsProtected": true,
  • "IsImpactable": true
}

Unprotect exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

ExtendedChartOfAccounts

Get all extended charts of accounts

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new chart of accounts extension

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
ChartOfAccountsId
required
integer <int32>
Name
required
string or null

Responses

Request samples

Content type
{
  • "ChartOfAccountsId": 0,
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Get an extended chart of accounts

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Update a chart of accounts extension

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
Name
required
string or null

Responses

Request samples

Content type
{
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Delete a chart of accounts extension that is not assigned to any accounting folder

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>

Responses

Export a chart of accounts extension as a CSV file in the import format, either its differences from the base chart of accounts or the complete effective chart

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
query Parameters
mode
string
Default: "Differences"
Enum: "Differences" "Complete"

Responses

Response samples

Content type
application/json
"string"

Duplicate a chart of accounts extension under a new name, unpublished, for the same owner

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
ChartOfAccountsId
required
integer <int32>
Name
required
string [ 1 .. 50 ] characters

Responses

Request samples

Content type
{
  • "ChartOfAccountsId": 0,
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Create an unpublished chart of accounts extension from a CSV file (UTF-8, ';', header compte;libellé;divisible;imputable;verrouillé;début de validité;fin de validité, dates dd/mm/yyyy designating the version of the base account, empty meaning unbounded)

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema: multipart/form-data
Name
required
string <= 50 characters

Name of the extension

ChartOfAccountsId
required
integer <int32>

Chart of accounts the extension is based on

File
required
string <binary>

CSV file, 5 MB and 50 000 account lines at most

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Publish/unpublish a chart of accounts extension

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
query Parameters
publish
boolean

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Assign a chart of accounts extension to a company group

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ChartOfAccountsId": 0,
  • "Name": "string",
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "CompanyName": "string",
  • "IsPublished": true
}

Get company accounting settings

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0
}

Set company accounting settings

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
required
AccountLabelUpperCase
boolean
AccountNameAligned
boolean
AccountNameAlignmentMinChars
integer <int32>

Responses

Request samples

Content type
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0
}

Response samples

Content type
application/json
{
  • "AccountLabelUpperCase": true,
  • "AccountNameAligned": true,
  • "AccountNameAlignmentMinChars": 0
}

ExternalFilesImport

Post file data

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
providerType
required
string
Enum: "Tra" "Isa" "Acd" "Ecr" "Oe"
Request Body schema: multipart/form-data
File
required
string <binary>

File

Responses

Response samples

Content type
application/json
"string"

Files

Upload a file for store and share url

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
string or null <binary>
TypeScan
string or null
Enum: "Administrative" "Client" "Supplier" "ExpenseReport" "Bank" "Others" "TicketAttachment" "RevisionAttachment" "ImportData" "FecExport" "Sellsy" "None"
ParentId
integer or null <int32>
FileSource
string or null
Enum: "Api" "Firebase" "DropBox" "SendGrid" "Magas" "Mobile" "Edi" "Sellsy" "Viseeon" "Fred" "QuickBooks" "CashManager"
ClientSource
string or null

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Type": "Administrative",
  • "Size": 0,
  • "IsAccounting": true,
  • "OrigineId": 0,
  • "DropboxId": "string",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Comment": "string",
  • "OcrDone": true,
  • "PdfUrl": "string",
  • "XmlUrl": "string",
  • "TxtUrl": "string",
  • "Checksum": "string",
  • "FbUniqueKey": "string",
  • "MatchId": 0,
  • "MatchScore": 0.1,
  • "MatchOp": "string",
  • "IsHidden": true,
  • "Status": "Received",
  • "Id": 0,
  • "EnterpriseId": 0,
  • "OriginalName": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "FileUrl": "string",
  • "ThumbUrl": "string"
}

Create fileItem resource from outside upload

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
TypeScan
string or null
Enum: "Administrative" "Client" "Supplier" "ExpenseReport" "Bank" "Others" "TicketAttachment" "RevisionAttachment" "ImportData" "FecExport" "Sellsy" "None"
ParentId
integer or null <int32>
FileSource
string or null
Enum: "Api" "Firebase" "DropBox" "SendGrid" "Magas" "Mobile" "Edi" "Sellsy" "Viseeon" "Fred" "QuickBooks" "CashManager"
ClientSource
string or null
FileName
required
string
FileUrl
required
string
FileSizeInKb
required
integer <int64>
FileChecksum
string or null
IsHidden
boolean or null

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Type": "Administrative",
  • "Size": 0,
  • "IsAccounting": true,
  • "OrigineId": 0,
  • "DropboxId": "string",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Comment": "string",
  • "OcrDone": true,
  • "PdfUrl": "string",
  • "XmlUrl": "string",
  • "TxtUrl": "string",
  • "Checksum": "string",
  • "FbUniqueKey": "string",
  • "MatchId": 0,
  • "MatchScore": 0.1,
  • "MatchOp": "string",
  • "IsHidden": true,
  • "Status": "Received",
  • "Id": 0,
  • "EnterpriseId": 0,
  • "OriginalName": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "FileUrl": "string",
  • "ThumbUrl": "string"
}

get Info file. Must have fileId in FormData

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
query Parameters
withPublicUrl
boolean

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "FileUrl": "string",
  • "ThumbUrl": "string",
  • "Name": "string",
  • "Size": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "FileType": "Administrative",
  • "Status": "Received",
  • "IsAccounting": true,
  • "Owner": {
    },
  • "OwnerId": 0,
  • "FolderItem": {
    },
  • "FolderItemId": 0,
  • "PdfUrl": "string",
  • "AuditVersion": 0
}

Generate public temporary URLs for a list of files.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The company identifier (linked to the EnterpriseId of the command).

Request Body schema:

The command containing the file IDs and optional duration.

FileIds
required
Array of integers or null <int32> [ items <int32 > ]
ValidationDurationInMinutes
integer <int32>
IsForPreview
required
boolean
WithDeleted
boolean

Responses

Request samples

Content type
{
  • "FileIds": [
    ],
  • "ValidationDurationInMinutes": 0,
  • "IsForPreview": true,
  • "WithDeleted": true
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Resolve file metadata for a batch of identifiers. Service-account surface: the Messaging microservice resolves its conversation attachments here rather than reading the shared `FileItem` table.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The company identifier owning the files.

Request Body schema:

The identifiers to resolve.

FileIds
required
Array of integers <int32> <= 1000 items [ items <int32 > ]

Responses

Request samples

Content type
{
  • "FileIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get public file url. Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
id
integer <int32>
privateFileUrl
string

Responses

Response samples

Content type
application/json
"string"

Copy File. Must have enterpriseId, id and destId in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
destId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "EnterpriseId": 0,
  • "FileUrl": "string",
  • "Type": "Administrative",
  • "Name": "string",
  • "Size": 0,
  • "ThumbUrl": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "FolderItem": {
    },
  • "IsAccounting": true,
  • "OrigineId": 0,
  • "DropboxId": "string",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "PermanentlyDeletedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Comment": "string",
  • "OrigineUrl": "string",
  • "OcrDone": true,
  • "PdfUrl": "string",
  • "XmlUrl": "string",
  • "TxtUrl": "string",
  • "Checksum": "string",
  • "FbUniqueKey": "string",
  • "OriginalName": "string",
  • "MatchId": 0,
  • "MatchScore": 0.1,
  • "MatchOp": "string",
  • "IsHidden": true,
  • "Status": "Received",
  • "GoogleJsonUrl": "string",
  • "SourceId": "string",
  • "DeltaObjectId": "string",
  • "DeltaSynchronizationStatus": "None",
  • "Id": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0
}

FilesAccounting

FilesAccounting_ChangeFileType Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
newType
string
fileIds
Array of integers <int32> [ items <int32 > ]

Responses

FilesAccounting_ChangeFileStatus Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
status
string
fileId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Status": "Received",
  • "Type": "Administrative",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ThumbUrl": "string",
  • "FileUrl": "string",
  • "AccountingFolderId": 0,
  • "OriginalName": "string",
  • "Checksum": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "GoogleJsonUrl": "string",
  • "FolderItemId": 0,
  • "OrigineId": 0,
  • "OwnerId": 0,
  • "Size": 0,
  • "Source": "string"
}

Post file Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
string or null <binary>
FileName
string or null
DocRef
string or null
SourceId
string or null
WithoutWorkFlow
boolean or null
TypeScan
string or null
FileSource
string or null
ClientSource
string or null

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "Type": "string",
  • "Size": 0,
  • "OrigineId": 0,
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "SourceId": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Checksum": "string",
  • "Status": "string",
  • "StatusReason": 0,
  • "StatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "StatusResponsibleUserId": 0,
  • "FileUrl": "string",
  • "ThumbUrl": "string",
  • "GoogleJsonUrl": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "OriginalName": "string",
  • "ContentSource": "string",
  • "StatusReasons": "string",
  • "CounterParty": "string",
  • "Amount": 0.1,
  • "EffectifDate": "2019-08-24T14:15:22Z",
  • "UserDefinedThirdPartyName": "string",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "EntryGenerationProvider": "string",
  • "HasRevisedStatus": true,
  • "Provider": "string"
}

Post file Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
string or null <binary>
FileName
string or null
DocRef
string or null
SourceId
string or null
WithoutWorkFlow
boolean or null
TypeScan
string or null
FileSource
string or null
ClientSource
string or null

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "Type": "string",
  • "Size": 0,
  • "OrigineId": 0,
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "SourceId": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Checksum": "string",
  • "Status": "string",
  • "StatusReason": 0,
  • "StatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "StatusResponsibleUserId": 0,
  • "FileUrl": "string",
  • "ThumbUrl": "string",
  • "GoogleJsonUrl": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "OriginalName": "string",
  • "ContentSource": "string",
  • "StatusReasons": "string",
  • "CounterParty": "string",
  • "Amount": 0.1,
  • "EffectifDate": "2019-08-24T14:15:22Z",
  • "UserDefinedThirdPartyName": "string",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "EntryGenerationProvider": "string",
  • "HasRevisedStatus": true,
  • "Provider": "string"
}

FilesAccounting_Upload Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

Request Body schema: multipart/form-data
EntryId
integer or null <int32>
Files
Array of strings or null <binary> [ items <binary > ]
TypeScan
string or null
FileSource
string or null
ClientSource
string or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

notify deleted doc Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
documentId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get origine file information of duplicated file Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
query Parameters
withPublicUrl
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "Type": "string",
  • "Size": 0,
  • "OrigineId": 0,
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Source": "string",
  • "SourceId": "string",
  • "ClientSource": "string",
  • "DocRef": "string",
  • "Checksum": "string",
  • "Status": "string",
  • "StatusReason": 0,
  • "StatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "StatusResponsibleUserId": 0,
  • "FileUrl": "string",
  • "ThumbUrl": "string",
  • "GoogleJsonUrl": "string",
  • "OwnerId": 0,
  • "FolderItemId": 0,
  • "OriginalName": "string",
  • "ContentSource": "string",
  • "StatusReasons": "string",
  • "CounterParty": "string",
  • "Amount": 0.1,
  • "EffectifDate": "2019-08-24T14:15:22Z",
  • "UserDefinedThirdPartyName": "string",
  • "TargetDate": "2019-08-24T14:15:22Z",
  • "EntryGenerationProvider": "string",
  • "HasRevisedStatus": true,
  • "Provider": "string"
}

FileValidations

Create new validation for multiple files Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
FileIds
required
Array of integers or null <int32> [ items <int32 > ]
DestinationUserIds
required
Array of integers or null <int32> [ items <int32 > ]
Subject
required
string or null
Message
required
string or null

Responses

Request samples

Content type
{
  • "FileIds": [
    ],
  • "DestinationUserIds": [
    ],
  • "Subject": "string",
  • "Message": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get all the files validations on pending or rejected state Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update validation status Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
fileValidationId
required
integer <int32>
Request Body schema:
required
FileId
required
integer <int32>
Status
required
string
Enum: "None" "Pending" "Approved" "Rejected"
ValidationPageLink
required
string or null
Comment
string or null
MessageId
integer <int32>

Responses

Request samples

Content type
{
  • "FileId": 0,
  • "Status": "None",
  • "ValidationPageLink": "string",
  • "Comment": "string",
  • "MessageId": 0
}

Folders

Get recent files, must have enterpriseId in formData, in case Personal Folder need userId Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Personal

Responses

Response samples

Content type
application/json
{
  • "Today": [
    ],
  • "LastWeek": [
    ],
  • "LastMonth": [
    ]
}

Get Folders and Files of a selected folder in permanent folder, must have enterpriseId and folderId in formData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Exercice, Personal

query Parameters
personalFolderUserId
integer <int32>

Optional Id of a user for personal folder

exerciseId
integer <int32>

Optional Id of an exercise folder

Responses

Response samples

Content type
application/json
{
  • "Files": [
    ],
  • "Folders": [
    ]
}

Get Folders and Files of a selected folder in permanent folder, must have enterpriseId and folderId in formData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderId
required
integer <int32>

Folder Id to retrieve

Responses

Response samples

Content type
application/json
{
  • "Files": [
    ],
  • "Folders": [
    ]
}

Get Folders of a selected folder in permanent folder, must have enterpriseId and folderId in formData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Exercice, Personal

query Parameters
personalFolderUserId
integer <int32>

Optional Id of a user for personal folder

exerciseId
integer <int32>

Optional Id of an exercise folder

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Folder Accessors Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderId
required
integer <int32>

ParentId of the folder accessor children

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a folder using parentId and the name of the folder. Must have enterpriseId, parentId and name in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Exercice, Personal

parentId
required
integer <int32>
query Parameters
name
string
isHidden
boolean
Default: false

When true, creates a confidential folder (owner-only, no inherited access); CEO only

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Type": "None",
  • "Name": "string",
  • "Path": "string",
  • "ParentId": 0,
  • "EnterpriseId": 0,
  • "OwnerId": 0,
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "ExerciseId": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0,
  • "SubFoldersCount": 0,
  • "FilesCount": 0,
  • "IsHidden": true
}

rename a folder using folderId and the new name. Must have enterpriseId, folderId and name in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Exercice, Personal

folderId
required
integer <int32>
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

delete a folder using folderId. Must have enterpriseId and folderId in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"

Possible Values: Permanent, Exercice, Personal

folderId
required
integer <int32>
query Parameters
forceDelete
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

rename a file using fileId and the new name. Must have fileId and name in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"
fileId
required
integer <int32>
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

delete a file using fileId. Must have enterpriseId and fileId in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
FileIds
Array of integers or null <int32> [ items <int32 > ]
DeleteBookEntries
required
boolean
DeleteBookLetters
required
boolean
Deprecated
KeepFiles
required
boolean
object (ImpactDeleteFile)

Responses

Request samples

Content type
{
  • "FileIds": [
    ],
  • "DeleteBookEntries": true,
  • "DeleteBookLetters": true,
  • "KeepFiles": true,
  • "OperationImpacts": {
    }
}

Response samples

Content type
application/json
{
  • "FileIds": [
    ],
  • "DeleteBookEntries": true,
  • "DeleteBookLetters": true,
  • "KeepFiles": true,
  • "OperationImpacts": {
    }
}

Upload files for a given accounting folder Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderId
required
integer <int32>
Request Body schema: multipart/form-data
Files
Array of strings or null <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Move a folder. Must have enterpriseId, srcId and destId in FormData Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
folderCategory
required
string
Enum: "Divers" "Scans" "Permanent" "Exercice" "Personal"
srcId
required
integer <int32>
destId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

ForcedTwoFactorReconciliation

Reconciles a single bounded page so the nightly WebJob walks the whole User table across requests, one transaction per page.

Authorizations:
oauth2
query Parameters
afterUserId
integer <int32>
pageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "LastUserId": 0,
  • "Processed": 0,
  • "Corrected": 0,
  • "HasMore": true
}

General

Get general information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Ape": "string",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "Activity": "string",
  • "IsListedOnTradeDirectory": true,
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "WebSite": "string",
  • "Street": "string",
  • "AdditionalAddress": "string",
  • "Hamlet": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "CountryId": 0,
  • "CountryCode": "string",
  • "Telephone": "string",
  • "Addresses": [
    ],
  • "IsAppelALaGenerositeDuPublic": true,
  • "IsMedicoSocial": true,
  • "IsNonProfessionalFurnishedRental": true,
  • "LastModification": {
    },
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Siret": "string",
  • "CodeNafId": 0,
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "VatSystemId": 0,
  • "TaxSystemId": 0,
  • "ChartOfAccountId": 0,
  • "ExtendedChartOfAccountsId": 0,
  • "VatTaxObligationReference": "string",
  • "CseType": "None",
  • "AccountingType": "Engagement",
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "ContractType": "Normal",
  • "StateMode": "Active",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z",
  • "CompanyId": 0,
  • "TradeName": "string",
  • "UrlLogo": "string",
  • "Container": "string",
  • "AcceptProviderEmails": true,
  • "IsEligibleToAi": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "TaxSystem": {
    },
  • "Email": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Id": 0,
  • "Name": "string"
}

Change general information of accounting folder in

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Name
required
string non-empty
TradeName
string or null
CreationDate
string or null <date-time>
LegalFormId
required
integer <int32>
LegalFormDisplayName
string or null [ 0 .. 150 ] characters
Nic
required
string [ 0 .. 5 ] characters
Siren
required
string [ 0 .. 9 ] characters
Ape
string or null [ 3 .. 6 ] characters
Deprecated
CodeNafId
integer <int32>
Activity
string or null <= 50 characters
CseType
string or null
Enum: "None" "Small" "Medium" "Large"
RegistrationCity
string or null <= 100 characters
RegistrationType
required
string
Enum: "None" "A" "B"
RegistrationDate
string or null <date-time>
IsListedOnTradeDirectory
required
boolean
ExternalId
string or null <= 50 characters
ExternalSystemId
string or null <= 50 characters
object (LocationCommand)
Telephone
string or null
Email
string or null
WebSite
string or null
AccountingType
string or null
Enum: "Engagement" "Trésorerie"
IsAppelALaGenerositeDuPublic
boolean
IsMedicoSocial
required
boolean
IsNonProfessionalFurnishedRental
required
boolean

Responses

Request samples

Content type
{
  • "Name": "string",
  • "TradeName": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "Nic": "strin",
  • "Siren": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "Activity": "string",
  • "CseType": "None",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "IsListedOnTradeDirectory": true,
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Location": {
    },
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "AccountingType": "Engagement",
  • "IsAppelALaGenerositeDuPublic": true,
  • "IsMedicoSocial": true,
  • "IsNonProfessionalFurnishedRental": true
}

Response samples

Content type
application/json
{
  • "Message": "string",
  • "Errors": [
    ]
}

Get accountingFolder state of accounting is in progress or not

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

Add an address to an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
AddressTypes
required
Array of strings unique
Items Enum: "None" "AdministrativeAndLegal" "MainEstablishment" "Correspondence" "Secondary"
Street
required
string non-empty
Complement
string or null
Locality
string or null
ZipCode
required
string non-empty
City
required
string non-empty
CountryCodeId
required
integer <int32>
Phone
string or null
StartValidity
string or null <date-time>
EndValidity
string or null <date-time>

Responses

Request samples

Content type
{
  • "AddressTypes": [
    ],
  • "Street": "string",
  • "Complement": "string",
  • "Locality": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "CountryCodeId": 0,
  • "Phone": "string",
  • "StartValidity": "2019-08-24T14:15:22Z",
  • "EndValidity": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
0
0

Edit an address of an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
addressId
required
integer <int32>
Request Body schema:
AddressTypes
required
Array of strings unique
Items Enum: "None" "AdministrativeAndLegal" "MainEstablishment" "Correspondence" "Secondary"
Street
required
string non-empty
Complement
string or null
Locality
string or null
ZipCode
required
string non-empty
City
required
string non-empty
CountryCodeId
required
integer <int32>
Phone
string or null
StartValidity
string or null <date-time>
EndValidity
string or null <date-time>

Responses

Request samples

Content type
{
  • "AddressTypes": [
    ],
  • "Street": "string",
  • "Complement": "string",
  • "Locality": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "CountryCodeId": 0,
  • "Phone": "string",
  • "StartValidity": "2019-08-24T14:15:22Z",
  • "EndValidity": "2019-08-24T14:15:22Z"
}

Edit an address of an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
addressId
required
integer <int32>

Responses

Get accounting folder with all relations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "SourceAccountingFolder": {
    },
  • "LegalPersons": {
    },
  • "NaturalPersons": {
    }
}

HealthCheck

Health check endpoint to initialize application before Azure slot swap

Authorizations:
oauth2

Responses

ImportFileTemplate

Get all import file templates

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or update template for accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Accounting folder identifier

Request Body schema:

Template data

Id
integer <int32>
AccountingFolderId
integer <int32>
CompanyId
integer <int32>
CompanyGroupId
integer <int32>
Name
required
string non-empty
HasHeader
required
boolean
StartLine
integer <int32>
ExcludeLastLines
integer <int32>
DefaultDateFormat
string or null
Enum: "DayMonthYear" "DayMonthShortYear" "MonthDayYear" "MonthDayShortYear" "YearMonthDay" "ShortYearMonthDay"
object (ImportFileEntryLineGroupingCommand)
object (ImportFileEntryTemplateCommand)
Array of objects or null (ImportFileEntryLineTemplateCommand)

Responses

Request samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "Name": "string",
  • "HasHeader": true,
  • "StartLine": 0,
  • "ExcludeLastLines": 0,
  • "DefaultDateFormat": "DayMonthYear",
  • "LineGrouping": {
    },
  • "Entry": {
    },
  • "EntryLines": [
    ]
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "Name": "string",
  • "HasHeader": true,
  • "StartLine": 0,
  • "ExcludeLastLines": 0,
  • "DefaultDateFormat": "DayMonthYear",
  • "LineGrouping": {
    },
  • "Entry": {
    },
  • "EntryLines": [
    ]
}

Get import file template from an accounting folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "Name": "string",
  • "HasHeader": true,
  • "StartLine": 0,
  • "ExcludeLastLines": 0,
  • "DefaultDateFormat": "DayMonthYear",
  • "LineGrouping": {
    },
  • "Entry": {
    },
  • "EntryLines": [
    ]
}

Update company template share

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Optional accounting folder identifier parameter

id
required
integer <int32>

Template identifier

query Parameters
companyId
required
integer <int32>

Company identifier

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "LastTimeUsed": "2019-08-24T14:15:22Z",
  • "CompanyName": "string",
  • "AccountingFolderName": "string"
}

Get sample data from template and file

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
Id
integer or null <int32>

Optional template identifier

HasHeader
boolean or null

Optional parameter to override template has header state

StartLine
integer or null <int32>

Optional parameter to override template has start lines to exclude

File
required
string <binary>

File to import

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get import file template empty line mappings

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get import file template empty entry mappings

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get import file template available destination columns

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Entry": [
    ],
  • "EntryLine": [
    ],
  • "Analytics": [
    ]
}

ImportFileTemplateCompany

Get all company import file templates

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get company import file template

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier

id
required
integer <int32>

Template identifier

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "Name": "string",
  • "HasHeader": true,
  • "StartLine": 0,
  • "ExcludeLastLines": 0,
  • "DefaultDateFormat": "DayMonthYear",
  • "LineGrouping": {
    },
  • "Entry": {
    },
  • "EntryLines": [
    ]
}

Delete company import file template

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier

id
required
integer <int32>

Template identifier

Responses

Update company template name

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier

id
required
integer <int32>

Template identifier

Request Body schema:

Command data

Name
required
string non-empty

Responses

Request samples

Content type
{
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "LastTimeUsed": "2019-08-24T14:15:22Z",
  • "CompanyName": "string",
  • "AccountingFolderName": "string"
}

Update company template share Deprecated

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier

id
required
integer <int32>

Template identifier

query Parameters
accountingFolderId
required
integer <int32>

Optional accounting folder identifier parameter

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "LastTimeUsed": "2019-08-24T14:15:22Z",
  • "CompanyName": "string",
  • "AccountingFolderName": "string"
}

Update company group template share

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company identifier parameter

id
required
integer <int32>

Template identifier

query Parameters
companyGroupId
required
integer <int32>

Company group identifier

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "LastTimeUsed": "2019-08-24T14:15:22Z",
  • "CompanyName": "string",
  • "AccountingFolderName": "string"
}

ImportFileTemplateCompanyGroup

Get all company group import file templates

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Company group identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get company group import file template

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Company group identifier

id
required
integer <int32>

Template identifier

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "Name": "string",
  • "HasHeader": true,
  • "StartLine": 0,
  • "ExcludeLastLines": 0,
  • "DefaultDateFormat": "DayMonthYear",
  • "LineGrouping": {
    },
  • "Entry": {
    },
  • "EntryLines": [
    ]
}

Update company group template name

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

Company group identifier

id
required
integer <int32>

Template identifier

Request Body schema:

Command data

Name
required
string non-empty

Responses

Request samples

Content type
{
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "AccountingFolderId": 0,
  • "CompanyId": 0,
  • "CompanyGroupId": 0,
  • "LastTimeUsed": "2019-08-24T14:15:22Z",
  • "CompanyName": "string",
  • "AccountingFolderName": "string"
}

JournalMapping

Retrieve journal mapping for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve journal mapping for generate this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update destination journal for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
journalMappingId
required
integer <int32>
Request Body schema:
required
JournalId
required
integer <int32>

Responses

Request samples

Content type
{
  • "JournalId": 0
}

Import initial mappings

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Initial Mapping File

Responses

Journals

Get Journals

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Journals Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new journal by enterprise. JournalType from api/app/Referentials/BookKeeping/BookJournalTypes

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EnterpriseId
required
integer <int32>
Name
required
string [ 1 .. 20 ] characters
Description
required
string [ 1 .. 100 ] characters
Type
required
string
Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"
OperationId
integer <int32>

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Name": "string",
  • "Description": "string",
  • "Type": "Buy",
  • "OperationId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Type": "Buy",
  • "TypeDescription": "string",
  • "Name": "string",
  • "Description": "string",
  • "EnterpriseId": 0
}

Get by Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Type": "Buy",
  • "TypeDescription": "string",
  • "Name": "string",
  • "Description": "string",
  • "EnterpriseId": 0
}

Send book journal command to update.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
required
Id
required
integer <int32>
EnterpriseId
required
integer <int32>
Name
required
string [ 1 .. 20 ] characters
Description
required
string [ 1 .. 100 ] characters
Type
required
string
Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"
IsConfirmed
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "Description": "string",
  • "Type": "Buy",
  • "IsConfirmed": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Type": "Buy",
  • "TypeDescription": "string",
  • "Name": "string",
  • "Description": "string",
  • "EnterpriseId": 0
}

All Journal types

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send book journal command to update.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
required
Id
required
integer <int32>
EnterpriseId
required
integer <int32>
Name
required
string [ 1 .. 20 ] characters
Description
required
string [ 1 .. 100 ] characters
Type
required
string
Enum: "Buy" "Sell" "Bank" "Misc" "Cash" "Salary" "ANouveaux" "Depreciation" "CutOff" "Loan" "Lease" "Situation" "Revision" "Stock" "Transfer" "Other"
IsConfirmed
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Name": "string",
  • "Description": "string",
  • "Type": "Buy",
  • "IsConfirmed": true
}

Response samples

Content type
application/json
{
  • "ImpactsViewModel": {
    },
  • "JournalViewModel": {
    }
}

Delete a journal

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
journalId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

delete multiple journals

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
journalIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
true

Languages

Get All Languages

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a new Language

Authorizations:
oauth2
Request Body schema:
Id
required
integer <int32>
Label
required
string [ 1 .. 30 ] characters
AbbyName
string or null <= 30 characters
IETFTag
string or null <= 10 characters
PrimaryIETFTag
string or null <= 10 characters
Available
required
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Label": "string",
  • "AbbyName": "string",
  • "IETFTag": "string",
  • "PrimaryIETFTag": "string",
  • "Available": true
}

Get Languages by its Id

Authorizations:
oauth2
query Parameters
ids
Array of integers <int32> [ items <int32 > ]
names
Array of strings
isPrimary
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Language by its Id

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Label": "string",
  • "AbbyName": "string",
  • "IETFTag": "string",
  • "PrimaryIETFTag": "string",
  • "Available": true
}

Update an existing Language

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
Label
required
string [ 1 .. 30 ] characters
AbbyName
string or null <= 30 characters
IETFTag
string or null <= 10 characters
PrimaryIETFTag
string or null <= 10 characters
Available
required
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Label": "string",
  • "AbbyName": "string",
  • "IETFTag": "string",
  • "PrimaryIETFTag": "string",
  • "Available": true
}

Response samples

Content type
application/json
"string"

Delete a existing Language

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Label": "string",
  • "AbbyName": "string",
  • "IETFTag": "string",
  • "PrimaryIETFTag": "string",
  • "Available": true
}

Ledger

Get the ledger by account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

virtualAnBehavior
string
Enum: "Default" "Grouped"
page
required
integer <int32>
Default: 1

The page

size
required
integer <int32> [ 1 .. 1000 ]
Default: 100

The size

sortBy
required
string
Default: "Date"
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"

The sort by

sortDesc
required
boolean
Default: true

the sort direction

accountScope
required
string
Default: "General"
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"

The account scope

entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"

The entry scope

entryFilter
string
Default: 3
Enum: "Real" "Virtual" "All"
Request Body schema:
required

The body object

required
object (LedgerByAccountSearch)
required
object (LedgerByAccountOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Metadata": {
    }
}

Get the ledger of an analytic axis: for each account, the entry lines distributed on the requested tags. The axis is Search.WithAxisId (required); the selected tags are Search.WithTagIds, each id being greater than or equal to 0; 0 selects the undistributed amount of the lines not or partially distributed on the axis; an empty selection returns an empty view. Amount of a line carries the distributed share.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>
virtualAnBehavior
string
Enum: "Default" "Grouped"
page
required
integer <int32>
Default: 1
size
required
integer <int32> [ 1 .. 1000 ]
Default: 100
sortBy
required
string
Default: "Date"
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"
sortDesc
required
boolean
Default: true
accountScope
required
string
Default: "General"
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"
entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"
entryFilter
string
Default: 3
Enum: "Real" "Virtual" "All"
Request Body schema:
required
required
object (LedgerByAccountSearch)
required
object (LedgerByAccountOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Metadata": {
    }
}

Export the ledger by account

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

the accounting folder Id

query Parameters
beginDate
required
string <date-time>

The begin date

endDate
required
string <date-time>

The end date

virtualAnBehavior
string
Enum: "Default" "Grouped"
sortBy
required
string
Default: "Date"
Enum: "None" "Account" "Date" "DebitSum" "CreditSum" "AbsoluteAmount" "Label" "Journal" "Letter" "DocRef" "DueDate"

The sort by

sortDesc
required
boolean
Default: true

the sort direction

accountScope
required
string
Default: "General"
Enum: "General" "Providers" "Customers" "IncomeStatement" "FixedAsset" "Bank"

The account scope

entryScope
required
string
Default: "All"
Enum: "All" "WithBookLetters" "WithoutBookLetters" "Revised" "NotRevised" "NotLetteredAndNotValidated" "Validated" "NotValidated" "WithTag" "WithoutTag" "NotLettered" "NotLetteredOrPartiallyLettered" "PartiallyLettered" "PartiallyOrFullyLettered" "FullyLettered"

The entry scope

entryFilter
string
Default: 3
Enum: "Real" "Virtual" "All"

The entry filter

ledgerExport
required
string
Default: "Excel"
Enum: "Html" "Pdf" "Excel"

The ledger export type

Request Body schema:
required

The body object

required
object (LedgerByAccountExportSearch)
required
object (LedgerByAccountExportOutput)

Responses

Request samples

Content type
{
  • "Search": {
    },
  • "Output": {
    }
}

Response samples

Content type
application/json
"string"

LegalPersons

GetLegalPersonById

Authorizations:
oauth2
query Parameters
legalPersonId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "Siren": "string",
  • "Nic": "string",
  • "Name": "string",
  • "EnterpriseLegalFormId": 0,
  • "EnterpriseLegalForm": {
    },
  • "TaxSystemId": 0,
  • "IsHolding": true,
  • "Issuer2042": 0,
  • "RepresentativeNaturalPersonId": 0,
  • "RepresentativeNaturalPerson": {
    },
  • "PhoneNumber": "string",
  • "ShareCapital": 0,
  • "ShareUnitValue": 0,
  • "TotalShareCount": 0,
  • "InventoryValue": 0,
  • "Street": "string",
  • "Additional": "string",
  • "Hamlet": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "CountryId": 0,
  • "ForeignIdentifier": "string",
  • "EntityCountryId": 0
}

GetLegalPersonByIdsForAccountingFolder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
legalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetAccountingFoldersByLegalPersonIds

Renvoie, pour chaque associé (personne morale) demandé, l'ensemble des dossiers comptables actifs au régime IR / BA (réel normal ou simplifié) où il apparaît comme associé, avec le nom de la société. Sert à alimenter la liste déroulante "Annexe 2042".

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
legalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetLegalPersonCapitalById

Authorizations:
oauth2
path Parameters
legalPersonId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ShareCapital": 0,
  • "ShareUnitValue": 0,
  • "TotalShareCount": 0,
  • "InventoryValue": 0,
  • "NaturalPersonShareholdersCount": 0,
  • "NaturalPersonShareholdersSharesCount": 0,
  • "LegalPersonShareholdersCount": 0,
  • "LegalPersonShareholdersSharesCount": 0,
  • "MinorShareholdersCount": 0,
  • "MinorShareholdersShareCount": 0,
  • "MajorShareholdersCount": 0,
  • "MajorShareholdersShareCount": 0,
  • "MajorShareholdersPartsCompletion": {
    }
}

EditLegalPersonCapital

Authorizations:
oauth2
path Parameters
legalPersonId
required
integer <int32>
Request Body schema:
ShareCapital
number or null <decimal>
ShareUnitValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
NaturalPersonShareholdersCount
integer <int32>
NaturalPersonShareholdersSharesCount
integer <int32>
LegalPersonShareholdersCount
integer <int32>
LegalPersonShareholdersSharesCount
integer <int32>
MinorShareholdersCount
integer <int32>
MinorShareholdersShareCount
integer <int32>
MajorShareholdersCount
integer <int32>
MajorShareholdersShareCount
integer <int32>

Responses

Request samples

Content type
{
  • "ShareCapital": 0,
  • "ShareUnitValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "NaturalPersonShareholdersCount": 0,
  • "NaturalPersonShareholdersSharesCount": 0,
  • "LegalPersonShareholdersCount": 0,
  • "LegalPersonShareholdersSharesCount": 0,
  • "MinorShareholdersCount": 0,
  • "MinorShareholdersShareCount": 0,
  • "MajorShareholdersCount": 0,
  • "MajorShareholdersShareCount": 0
}

GetLegalPersonsBySiren

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
siren
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetManyLegalPersonsBySirens

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
sirens
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetLegalPersonsBySearch

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
searchQuery
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetLegalPersonByIdsWithParticipations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
legalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateLegalPerson

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
Siren
string or null = 9 characters
Name
required
string [ 1 .. 200 ] characters
Nic
string or null [ 0 .. 5 ] characters
EnterpriseLegalFormId
integer <int32>
TaxSystemId
integer <int32>
Issuer2042
integer <int32>
IsHolding
required
boolean
ShareCapital
number or null <decimal>
ShareUnitValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
PhoneNumber
string or null
object (AddressCommand)
EntityCountryId
integer <int32>
ForeignIdentifier
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "Siren": "stringstr",
  • "Name": "string",
  • "Nic": "strin",
  • "EnterpriseLegalFormId": 0,
  • "TaxSystemId": 0,
  • "Issuer2042": 0,
  • "IsHolding": true,
  • "ShareCapital": 0,
  • "ShareUnitValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "PhoneNumber": "string",
  • "AddressCommand": {
    },
  • "EntityCountryId": 0,
  • "ForeignIdentifier": "string"
}

Response samples

Content type
application/json
0
0

EditLegalPerson

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
legalPersonId
required
integer <int32>
Request Body schema:
Siren
string or null = 9 characters
Name
required
string [ 1 .. 200 ] characters
Nic
string or null [ 0 .. 5 ] characters
EnterpriseLegalFormId
integer <int32>
TaxSystemId
integer <int32>
Issuer2042
integer <int32>
IsHolding
required
boolean
ShareCapital
number or null <decimal>
ShareUnitValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
PhoneNumber
string or null
object (AddressCommand)
EntityCountryId
integer <int32>
ForeignIdentifier
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "Siren": "stringstr",
  • "Name": "string",
  • "Nic": "strin",
  • "EnterpriseLegalFormId": 0,
  • "TaxSystemId": 0,
  • "Issuer2042": 0,
  • "IsHolding": true,
  • "ShareCapital": 0,
  • "ShareUnitValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "PhoneNumber": "string",
  • "AddressCommand": {
    },
  • "EntityCountryId": 0,
  • "ForeignIdentifier": "string"
}

EditLegalPerson Siren

Authorizations:
oauth2
path Parameters
legalPersonId
required
integer <int32>
Request Body schema:
OldSiren
string or null
NewSiren
string or null

Responses

Request samples

Content type
{
  • "OldSiren": "string",
  • "NewSiren": "string"
}

Lettering

Retrieves all letterings.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

query Parameters
beginDate
required
string <date-time>
endDate
required
string <date-time>
page
integer <int32>
size
integer <int32>
letteringType
string
Enum: "Full" "Partial"
letter
string
accountStartWith
string
sortBy
string
Enum: "Date" "Journal" "Account" "Label" "CreditSum" "DebitSum" "AbsoluteAmount" "Letter"
sortDesc
boolean

Responses

Response samples

Content type
application/json
{
  • "LetteringsByAccount": [
    ],
  • "Metadata": {
    }
}

Create a new partial letterings between provided

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
reviseEntryLines
boolean

When true (default), the lettered lines are marked as revised. Set to false to skip the revision.

Request Body schema:
required
Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
0
0

Retrieves a lettering.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

letteringId
required
integer <int32>

The lettering Id.

query Parameters
sortBy
string
Enum: "Date" "Journal" "Account" "Label" "CreditSum" "DebitSum" "AbsoluteAmount" "Letter"
sortDesc
boolean

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": "string",
  • "Lettering": {
    }
}

Removes a partial lettering.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

letteringId
required
integer <int32>

The lettering Id.

Responses

Updates a lettering by adding and/or removing lines.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
letteringId
required
integer <int32>
Request Body schema:
required
LineIdsToAdd
Array of integers or null <int64> [ items <int64 > ]
LineIdsToRemove
Array of integers or null <int64> [ items <int64 > ]
ReviseEntryLines
boolean

Responses

Request samples

Content type
{
  • "LineIdsToAdd": [
    ],
  • "LineIdsToRemove": [
    ],
  • "ReviseEntryLines": true
}

Retrieves letterings by ids

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

Request Body schema:
required
LetteringIds
Array of integers or null <int32> [ items <int32 > ]
IncludeDeleted
boolean

Responses

Request samples

Content type
{
  • "LetteringIds": [
    ],
  • "IncludeDeleted": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Adds lines to an existing lettering.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

letteringId
required
integer <int32>

The lettering Id.

query Parameters
reviseEntryLines
boolean

When true (default), the added lines are marked as revised. Set to false to skip the revision.

Request Body schema:
required

The adding lines Ids.

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Removes lines from an existing lettering.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

letteringId
required
integer <int32>

The lettering Id.

Request Body schema:
required

The adding lines Ids.

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Creates a saturation between two entry lines.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
EntryLine1Id
required
integer <int64>
EntryLine2Id
required
integer <int64>
Saturation
required
number <decimal>

Responses

Request samples

Content type
{
  • "EntryLine1Id": 0,
  • "EntryLine2Id": 0,
  • "Saturation": 0
}

Response samples

Content type
application/json
0
0

Update a saturation.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
Id
required
integer <int32>
Saturation
required
number <decimal>

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Saturation": 0
}

Create a compensation entry according the payload.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder Id.

letteringId
required
integer <int32>

The lettering Id.

Request Body schema:
required

The compensation entry

EnterpriseId
required
integer <int32>
Date
required
string <date-time>
DocRef
string or null
Label
string or null <= 256 characters
Source
required
string
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
SourceId
string or null
JournalId
required
integer <int32>
required
Array of objects (CreateEntryLineCommand)
DueDate
string or null <date-time>
PaymentMethod
string or null <= 200 characters

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "DocRef": "string",
  • "Label": "string",
  • "Source": "ByUser",
  • "SourceId": "string",
  • "JournalId": 0,
  • "Lines": [
    ],
  • "DueDate": "2019-08-24T14:15:22Z",
  • "PaymentMethod": "string"
}

Create multiple letterings

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
Array of objects (CreateLetteringCommand)
LetterType
required
string
Enum: "Unknown" "Manual" "Auto" "Fec" "Reverse" "PublicApi"
ReviseEntryLines
boolean

Responses

Request samples

Content type
{
  • "CreateLetterringCommands": [
    ],
  • "LetterType": "Unknown",
  • "ReviseEntryLines": true
}

Response samples

Content type
application/json
{
  • "CreatedLetterings": [
    ]
}

Create lettering with optional compensation entry

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers <int64> unique [ items <int64 > ]
LetterType
required
string
Enum: "Unknown" "Manual" "Auto" "Fec" "Reverse" "PublicApi"
LetterDate
string or null <date-time>
CompensationEntryDiffType
string or null
Enum: "Exchange" "Settlement" "Offsetting"
object (CreateCompensationEntryCommand)
ReviseEntryLines
boolean

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "LetterType": "Unknown",
  • "LetterDate": "2019-08-24T14:15:22Z",
  • "CompensationEntryDiffType": "Exchange",
  • "CreateCompensationEntryCommand": {
    },
  • "ReviseEntryLines": true
}

Response samples

Content type
application/json
{
  • "CreatedLettering": {
    },
  • "CompensationEntry": {
    }
}

Delete letterings by line ids

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers <int64> unique [ items <int64 > ]
IsConfirmed
required
boolean

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ],
  • "IsConfirmed": true
}

Response samples

Content type
application/json
{
  • "UnmatchedLinesCount": 0
}

Fix letterings

Authorizations:
oauth2
query Parameters
accountingFolderId
integer <int32>
execute
boolean
Default: false
overview
boolean
Default: true

Responses

Response samples

Content type
application/json
null

Member

Get all internal roles of user for email

Authorizations:
oauth2
query Parameters
email
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all roles of one user for accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Role for user in accounting folder

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all member of accounting folder or accountant affected at

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user with roles in company Required : Email, FirstName, LastName, Roles

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
Gender
required
string
Enum: "Mrs" "Mr" "Ms" "None"
Firstname
string or null
Lastname
string or null
Email
string or null
InviterEmail
string or null
CodeRole
required
string
Enum: "None" "CA" "A" "S" "CEO" "DAF" "E" "RF" "SM" "TAG" "SUP" "EA" "CEO_GROUPE" "DAF_GROUPE" "CC_GROUPE" "C_GROUPE" "J" "FI" "SYSTEM" "DAF_READONLY" "E_FE"
Active
required
boolean
ShouldSendEmail
boolean

Responses

Request samples

Content type
{
  • "Gender": "Mrs",
  • "Firstname": "string",
  • "Lastname": "string",
  • "Email": "string",
  • "InviterEmail": "string",
  • "CodeRole": "None",
  • "Active": true,
  • "ShouldSendEmail": true
}

Response samples

Content type
application/json
0
0

Get all members of company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Affect user with roles in company Required : Role, userId, companyId

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>

UserId

RoleName
required
string non-empty

RoleName

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "RoleName": "string"
}

Activate user, send message and setup profile

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>

Responses

Disable user

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>
query Parameters
userEmail
string

Responses

Update accountingFolder collaborator role

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
userId
required
integer <int32>
Request Body schema:
RoleId
required
integer <int32>

Responses

Request samples

Content type
{
  • "RoleId": 0
}

Update company collaborator role

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>
Request Body schema:
RoleId
required
integer <int32>

Responses

Request samples

Content type
{
  • "RoleId": 0
}

Invite a collaborator in company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
FirstName
required
string non-empty
LastName
required
string non-empty
Email
required
string non-empty
RoleName
required
string non-empty
EnterpriseId
required
integer <int32>

Responses

Request samples

Content type
{
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "RoleName": "string",
  • "EnterpriseId": 0
}

Response samples

Content type
application/json
0
0

Invite a collaborator in accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
FirstName
required
string non-empty
LastName
required
string non-empty
Email
required
string non-empty
RoleName
required
string non-empty
EnterpriseId
required
integer <int32>

Responses

Request samples

Content type
{
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "RoleName": "string",
  • "EnterpriseId": 0
}

Response samples

Content type
application/json
0
0

All Roles

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Messaging

Create a new message Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema: multipart/form-data
Title
string or null
Text
string or null
ParticipantUserIds
string or null
MentionedUserIds
string or null
Files
Array of strings or null <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "AuditVersion": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AuthorId": 0,
  • "Type": "CeoToChiefAccountant",
  • "Title": "string",
  • "Text": "string",
  • "Status": "All",
  • "TicketStatus": "Create",
  • "Comments": [
    ],
  • "TicketRate": 0,
  • "LastComment": {
    },
  • "CommentCount": 0,
  • "TicketParticipants": [
    ],
  • "IsUserSubscribedToNotifications": true,
  • "CanCloseOpen": true,
  • "AttachFiles": [
    ],
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Create a new comment, private note Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
messageId
required
integer <int32>
Request Body schema: multipart/form-data
Text
string or null
Type
string or null
Enum: "Response" "PrivateNote"
MentionedUserIds
string or null
Files
Array of strings or null <binary> [ items <binary > ]
AuthorEnterpriseId
integer or null <int32>
CommentSource
string or null
Enum: "WebApp" "Email"
UserId
integer or null <int32>

Responses

Response samples

Content type
application/json
{
  • "AuditVersion": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "TicketId": 0,
  • "AuthorEnterpriseId": 0,
  • "UserId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "UrlAvatar": "string",
  • "Type": "Response",
  • "Text": "string",
  • "AttachFiles": [
    ],
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Source": "WebApp"
}

Set message status Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
messageId
required
integer <int32>
Request Body schema:
AccountingFolderId
required
integer <int32>
MessageId
required
integer <int32>
Status
required
string
Enum: "Create" "ParticipantCommentCreate" "OwnerCommentCreate" "ClosedByParticipant" "ClosedByOwner" "ReopenedByParticipant" "ReopenedByOwner"

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "MessageId": 0,
  • "Status": "Create"
}

Response samples

Content type
application/json
0
0

Create multiple messages by accounting folders Deprecated

Authorizations:
oauth2
Request Body schema:
AccountingFolderIds
required
Array of integers or null <int32> [ items <int32 > ]
Title
required
string or null
Text
required
string or null
RoleIds
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "AccountingFolderIds": [
    ],
  • "Title": "string",
  • "Text": "string",
  • "RoleIds": [
    ]
}

Get all the participants on any message of the given accounting folder Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Metadata

MigrationManager

Get one MigrationManagerOperation

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
migrationManagerOperationId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Get many MigrationManagerOperation

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post file data

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Zip File, or an .isa/.tra file (nu ou zippe) when FredV2.WebApi.Controllers.Import.CreateMigrationManagerOperationUploadCommand.ProviderType is set

ProviderType
string or null
Enum: "Tra" "Isa" "Acd" "Ecr" "Oe"

US 49097 : quand renseigne (Isa ou Tra uniquement), FredV2.WebApi.Controllers.Import.CreateMigrationManagerOperationUploadCommand.File est converti serveur avant d'etre traite comme un zip Migration Manager. Absent (defaut), comportement inchange : File doit etre un zip de FEC deja convertis.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Get many MigrationManagerOperation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create and integrate migration manager lot by azure url

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The Id of the company.

Request Body schema:

The command containing file URL and integration options.

FileUrl
required
string non-empty
required
object (UpdateLotActionsCommand)
FileAttachmentImportType
string or null
Enum: "None" "NomFichier" "PieceRef" "ForceNomFichier" "ForcePieceRef"
KeepLinesWithZeroAmount
boolean
KeepExistingEntriesOnFecImport
boolean
FecIsTemporary
boolean
WithPartialLettering
required
boolean
WithVatDetails
required
boolean
KeepAccountLabels
boolean
MarkLinesAsRevised
boolean
AnalyticLibraryId
integer <int32>
WithAnalytics
boolean
WithQuantities
boolean
WithSellingPrice
boolean
WithDueDate
boolean
WithoutAccountMappingTemplate
boolean
WithPaymentMethod
boolean

Responses

Request samples

Content type
{
  • "FileUrl": "string",
  • "UpdateActionsCommand": {
    },
  • "FileAttachmentImportType": "None",
  • "KeepLinesWithZeroAmount": true,
  • "KeepExistingEntriesOnFecImport": true,
  • "FecIsTemporary": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "AnalyticLibraryId": 0,
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "WithDueDate": true,
  • "WithoutAccountMappingTemplate": true,
  • "WithPaymentMethod": true
}

Response samples

Content type
application/json
{
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "CompanyId": 0,
  • "FileName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Operations": [
    ],
  • "OperationsCount": 0
}

Creates a Google migration manager operation.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The ID of the company.

googleFolderId
required
string

The ID of the Google folder.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Creates a migration manager operation by azure url.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The Id of the company.

query Parameters
fileUrl
required
string

The URL of the file in azure storage.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Creates an azure url writable for Migration manager.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The Id of the company.

query Parameters
fileName
required
string

The name of the file.

Responses

Response samples

Content type
application/json
"string"

Integrate Operation

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
FileAttachmentImportType
string or null
Enum: "None" "NomFichier" "PieceRef" "ForceNomFichier" "ForcePieceRef"
KeepLinesWithZeroAmount
boolean
KeepExistingEntriesOnFecImport
boolean
FecIsTemporary
boolean
WithPartialLettering
required
boolean
WithVatDetails
required
boolean
KeepAccountLabels
boolean
MarkLinesAsRevised
boolean
AnalyticLibraryId
integer <int32>
WithAnalytics
boolean
WithQuantities
boolean
WithSellingPrice
boolean
WithDueDate
boolean
WithoutAccountMappingTemplate
boolean
WithPaymentMethod
boolean
required
object (UpdateActionsCommand)

Responses

Request samples

Content type
{
  • "FileAttachmentImportType": "None",
  • "KeepLinesWithZeroAmount": true,
  • "KeepExistingEntriesOnFecImport": true,
  • "FecIsTemporary": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "AnalyticLibraryId": 0,
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "WithDueDate": true,
  • "WithoutAccountMappingTemplate": true,
  • "WithPaymentMethod": true,
  • "UpdateActionsCommand": {
    }
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Update Status

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
Name
required
string non-empty
Status
required
string
Enum: "WaitingPreviousStep" "Pending" "InProgress" "Success" "Failed"
ExternalId
integer <int32>
ErrorDescription
string or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Status": "WaitingPreviousStep",
  • "ExternalId": 0,
  • "ErrorDescription": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Update Status

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
id
required
integer <int32>
Request Body schema:
ImportedFileId
required
integer <int32>
FileName
required
string non-empty

Responses

Request samples

Content type
{
  • "ImportedFileId": 0,
  • "FileName": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0,
  • "AccountingFolderName": "string",
  • "Siren": "string",
  • "ExternalId": "string",
  • "ImportedFileId": 0,
  • "ImportedFileName": "string",
  • "LotId": "01061197-9ab9-47db-8df8-b474b9c88553",
  • "Status": "Analyzed",
  • "SubmissionDate": "2019-08-24T14:15:22Z",
  • "CompletionDate": "2019-08-24T14:15:22Z",
  • "CreateExerciseSteps": [
    ],
  • "ImportTemplateMappingSteps": [
    ],
  • "ImportFecSteps": [
    ],
  • "ProtectExerciseSteps": [
    ],
  • "ImportAccountingDocumentsSteps": [
    ],
  • "ImportGoogleDriveFileStep": {
    },
  • "ImportLoanLeaseSteps": [
    ],
  • "ImportFixedAssetsSteps": [
    ]
}

Delete by ids

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
id
integer <int32>
Request Body schema:
Ids
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "Ids": [
    ]
}

MissionLetter

Get mission letter of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccountingFolderTypology": "BookKeeping",
  • "ChartOfAccountsId": 0,
  • "HasAccountingSoftware": true,
  • "AccountingSoftwareName": "string",
  • "HasProductionLegalAnnexesAnnualAccounts": true,
  • "LetterMissionDate": "2019-08-24T14:15:22Z",
  • "HasVatKeeping": true,
  • "DistributionContract": true,
  • "SpecificTreatmentType": "None"
}

Update mission letter information of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
HasAccountingSoftware
required
boolean
AccountingSoftwareName
string or null
HasProductionLegalAnnexesAnnualAccounts
required
boolean
MissionLetterDate
string or null <date-time>
HasVatKeeping
required
boolean
DistributionContract
required
boolean
AccountingFolderTypology
string or null
Enum: "BookKeeping" "RevisionClosing"
SpecificTreatmentType
string or null
Enum: "None" "Agricultural"

Responses

Request samples

Content type
{
  • "HasAccountingSoftware": true,
  • "AccountingSoftwareName": "string",
  • "HasProductionLegalAnnexesAnnualAccounts": true,
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "HasVatKeeping": true,
  • "DistributionContract": true,
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None"
}

Monitoring

Checks if the API is available and responds with the provided text or "OK".

Authorizations:
oauth2
query Parameters
text
string

Optional text to return in the response

Responses

Response samples

Content type
application/json
"string"

NaturalPersons

GetNaturalPersonById

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
naturalPersonId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CompanyId": 0,
  • "Issuer2042": 0,
  • "LastName": "string",
  • "FirstName": "string",
  • "FiscalNumber": "string",
  • "SocialSecurityNumber": "string",
  • "Gender": "Mrs",
  • "BrideName": "string",
  • "PersonalSituationType": "None",
  • "MatrimonialRegimeType": "None",
  • "SocialStatus": "None",
  • "PartnerNaturalPersonId": 0,
  • "PartnerNaturalPersonName": "string",
  • "PartnerSocialStatus": "None",
  • "RelationStartDate": "2019-08-24T14:15:22Z",
  • "RelationEndDate": "2019-08-24T14:15:22Z",
  • "Occupation": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BirthDate": "2019-08-24T14:15:22Z",
  • "BirthCity": "string",
  • "BirthDepartment": "string",
  • "BirthCountryId": 0,
  • "TaxSystemId": 0,
  • "AddressStreet": "string",
  • "AddressAdditional": "string",
  • "AddressHamlet": "string",
  • "AddressZipCode": "string",
  • "AddressCity": "string",
  • "AddressCountryId": 0
}

EditNaturalPerson

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
naturalPersonId
required
integer <int32>
Request Body schema:
LastName
required
string [ 1 .. 200 ] characters
FirstName
string or null
FiscalNumber
string or null <= 20 characters
SocialSecurityNumber
string or null <= 15 characters
Gender
string or null
Enum: "Mrs" "Mr" "Ms" "None"
BrideName
string or null <= 200 characters
PersonalSituationType
string or null
Enum: "None" "Single" "CivilUnion" "Cohabitation" "Married" "Widow" "Separated" "Divorced"
MatrimonialRegimeType
string or null
Enum: "None" "SeparationOfProperty" "FullCommunityOfProperty" "CommunityOfAcquisitions" "ParticipationOfAcquisitions"
SocialStatus
required
string
Enum: "None" "NonSalariedWorker" "SalariedWorker"
PartnerNaturalPersonId
integer <int32>
PartnerSocialStatus
string or null
Enum: "None" "CollaboratingSpouse" "EmployeeSpouse" "PartnerSpouse"
RelationStartDate
string or null <date-time>
RelationEndDate
string or null <date-time>
Occupation
string or null <= 100 characters
Email
string or null <= 255 characters
PhoneNumber
string or null <= 20 characters
BirthDate
string or null <date-time>
BirthCity
string or null <= 100 characters
BirthDepartment
string or null
BirthCountryId
integer <int32>
TaxSystemId
integer <int32>
Issuer2042
integer <int32>
object (AddressCommand)

Responses

Request samples

Content type
{
  • "LastName": "string",
  • "FirstName": "string",
  • "FiscalNumber": "string",
  • "SocialSecurityNumber": "string",
  • "Gender": "Mrs",
  • "BrideName": "string",
  • "PersonalSituationType": "None",
  • "MatrimonialRegimeType": "None",
  • "SocialStatus": "None",
  • "PartnerNaturalPersonId": 0,
  • "PartnerSocialStatus": "None",
  • "RelationStartDate": "2019-08-24T14:15:22Z",
  • "RelationEndDate": "2019-08-24T14:15:22Z",
  • "Occupation": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BirthDate": "2019-08-24T14:15:22Z",
  • "BirthCity": "string",
  • "BirthDepartment": "string",
  • "BirthCountryId": 0,
  • "TaxSystemId": 0,
  • "Issuer2042": 0,
  • "AddressCommand": {
    }
}

GetNaturalPersonByIds

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
naturalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateNaturalPerson

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
LastName
required
string [ 1 .. 200 ] characters
FirstName
string or null
FiscalNumber
string or null <= 20 characters
SocialSecurityNumber
string or null <= 15 characters
Gender
string or null
Enum: "Mrs" "Mr" "Ms" "None"
BrideName
string or null <= 200 characters
PersonalSituationType
string or null
Enum: "None" "Single" "CivilUnion" "Cohabitation" "Married" "Widow" "Separated" "Divorced"
MatrimonialRegimeType
string or null
Enum: "None" "SeparationOfProperty" "FullCommunityOfProperty" "CommunityOfAcquisitions" "ParticipationOfAcquisitions"
SocialStatus
required
string
Enum: "None" "NonSalariedWorker" "SalariedWorker"
PartnerNaturalPersonId
integer <int32>
PartnerSocialStatus
string or null
Enum: "None" "CollaboratingSpouse" "EmployeeSpouse" "PartnerSpouse"
RelationStartDate
string or null <date-time>
RelationEndDate
string or null <date-time>
Occupation
string or null <= 100 characters
Email
string or null <= 255 characters
PhoneNumber
string or null <= 20 characters
BirthDate
string or null <date-time>
BirthCity
string or null <= 100 characters
BirthDepartment
string or null
BirthCountryId
integer <int32>
TaxSystemId
integer <int32>
Issuer2042
integer <int32>
object (AddressCommand)

Responses

Request samples

Content type
{
  • "LastName": "string",
  • "FirstName": "string",
  • "FiscalNumber": "string",
  • "SocialSecurityNumber": "string",
  • "Gender": "Mrs",
  • "BrideName": "string",
  • "PersonalSituationType": "None",
  • "MatrimonialRegimeType": "None",
  • "SocialStatus": "None",
  • "PartnerNaturalPersonId": 0,
  • "PartnerSocialStatus": "None",
  • "RelationStartDate": "2019-08-24T14:15:22Z",
  • "RelationEndDate": "2019-08-24T14:15:22Z",
  • "Occupation": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BirthDate": "2019-08-24T14:15:22Z",
  • "BirthCity": "string",
  • "BirthDepartment": "string",
  • "BirthCountryId": 0,
  • "TaxSystemId": 0,
  • "Issuer2042": 0,
  • "AddressCommand": {
    }
}

Response samples

Content type
application/json
0
0

GetAccountingFoldersByNaturalPersonIds

Renvoie, pour chaque associé (personne physique) demandé, l'ensemble des dossiers comptables actifs au régime IR / BA (réel normal ou simplifié) où il apparaît comme associé, avec le nom de la société. Sert à alimenter la liste déroulante "Annexe 2042".

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
naturalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetNaturalPersonByIdsWithParticipations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
naturalPersonIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetNaturalPersonsBySearch

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
searchQuery
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetManyNaturalPersonsBySearch

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
searchQueries
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Notification

Insert/Update notification definition

Authorizations:
oauth2
query Parameters
isFullRefresh
boolean

Responses

Response samples

Content type
true

Validate notification SQL execution

Authorizations:
oauth2

Responses

Response samples

Content type
true

Trigger a notification

Authorizations:
oauth2
query Parameters
Id
string
EntityChangeType
string
Enum: "Technical" "BookEntry" "BookBalance" "User" "Ticket" "Planning" "BankinItem" "AccountingFiles" "FileItem" "Email" "Comment" "Invite" "Enterprise" "SupportAction" "AssignUserRole" "BookEntryLine" "BookAccountState" "InboundMail" "AssignationConfirmation" "NotificationToSale" "DownloadFiles" "NewMessage" "FeatureAccess" "Unknown"
EntityAction
string
Enum: "CreateBookEntry" "UpdateBookEntry" "Match" "Unmatch" "ImportedBookEntry" "ValidatedBookEntry" "CreateBookLedger" "UpdateBookLedger" "CreateUser" "UpdateUser" "ActivateUser" "DeactivateUser" "ResetPassword" "CreateTicket" "CreateComment" "ResolveTicket" "ReopenTicket" "PersonalNotifyTicket" "CreateTicketEmergency" "CreateCommentEmergency" "DeleteAbsence" "DeleteVacation" "CreateAbsence" "CreateVacation" "CountDoublonAccountingFiles" "AccountingFileUploaded" "VacationValidated" "CreateAccountingFile" "CreateAdministratifFile" "VacationRejected" "UpdateAccountingFile" "UpdateAdministratifFile" "UpdateFileType" "UpdateThumbUrl" "UpdatedByCheckSumJobs" "UpdatedByDropBoxJobs" "UpdatedByMagasJobs" "SoftDeleteFile" "RealDeleteFile" "SoftDeletedByMagasJobs" "BankinStateNeedHumanAction" "BankinStateInvalidCredentials" "UpdatedByOcrJobs" "CreatePrivateNote" "MessagingReplyTo" "ReceivedEmailError" "FileIsAttachedToTicket" "TicketWithoutAnswerAfter24H" "MentionPrivate" "MentionPublic" "CreateNote" "FileIsAttachedToRevision" "NewUserInFred" "ExistedUserInvitation" "NewCollaboratorEmploye" "ExistedCollaboratorEmploye" "NewCollaboratorDaf" "ExistedCollaboratorDaf" "NewCollaboratorFreelancer" "ExistedCollaboratorFreelancer" "NewCollaboratorCeo" "ExistedCollaboratorCeo" "NewCollaboratorCabinet" "ExistedCollaboratorCabinet" "EnterpriseArchive" "EnterpriseClose" "EnterpriseActivate" "EnterpriseInactivate" "EnterpriseCreate" "EnterpriseNameUpdate" "EnterpriseSoftDelete" "EnterpriseUndelete" "EnterpriseAccountingModeUpdate" "EnterpriseTypeToDemo" "EnterpriseTypeToFake" "EnterpriseTypeToTrial" "EnterpriseTypeToNormal" "EnterpriseToIa" "EnterpriseToManual" "EnterpriseToMaga" "EnterpriseToMagaToIa" "EnterpriseToPreAccounting" "EnterpriseToTotalProduction" "ChangeAccountingType" "AssignmentToAccountant" "AssignmentToCeoDaf" "DeassignmentToAccountant" "Move" "Remove" "DeassignmentToClient" "PublishTickets" "UpdateBookAccountStateStatusAnomaly" "UpdateBookAccountStateStatusValidate" "UpdateBookAccountStateComment" "ReviseEntryLine" "UnreviseEntryLine" "NewCollaborator" "WelcomeEmail" "InviteForRegister" "UnsupportedMultipleRecipients" "UnsupportedReceivedEmailFormat" "UnAuthorizedEmail" "ReceiveMailReport" "NoAttachmentFound" "ForwardEmail" "MailToPdfReport" "ConfirmationToClient" "ConfirmationToChiefAccountant" "ConfirmationToChiefMission" "Declined" "Voided" "Completed" "Confirmed" "DownloadFiles" "NewMessage" "GrantFeatureAccess" "RemoveFeatureAccess" "DenyFeatureAccess"
UserId
integer <int32>
EnterpriseId
integer <int32>

Responses

Response samples

Content type
true

Trigger notification scheduler

Authorizations:
oauth2

Responses

Response samples

Content type
true

OperationEntries

Create multiple entries in one transaction (all or nothing) Entry Mandatory : EnterpriseId, JournalId, Status(default Pending), Date, Lines. Optional: Label, FileId, DocRef EntryLine mandatory : AccountId, CurrencyId, Debit/Credit amount. Optional: SubAccountId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
required
Array of objects (CreateOperationEntriesCommandEntry)
EntryLineRevision
required
string
Enum: "Unrevised" "Revised"

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "Entries": [
    ],
  • "EntryLineRevision": "Unrevised"
}

Response samples

Content type
application/json
{
  • "Entries": [
    ]
}

Get entries and entry lines ordered by entryId paged by entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
Request Body schema:
Skip
required
integer <int32>
Take
required
integer <int32>
IncludeDeleted
required
boolean

Responses

Request samples

Content type
{
  • "Skip": 0,
  • "Take": 0,
  • "IncludeDeleted": true
}

Response samples

Content type
application/json
[
  • {
    }
]

OperationError

Create operation errors

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
Request Body schema:
required
Array of objects (CreateOperationErrorCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

OperationIssue

Retrieve all issues for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resolve all issues for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get state of all issues from operation id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise id

operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

Operations

Get import operations for enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post file data

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

Fec File

ExerciseId
required
integer <int32>

Id of the current exercise

OperationType
string or null
Enum: "None" "KeepExisting" "ReplaceAll" "Merge"

Type of operation (keep existing data, replace, ...)

Temporary
boolean or null

Defines whether the user imports a temporary FEC or not.

CloseExercise
boolean or null

Defines whether the user imports a closed FEC or not.

ShouldValidateEntries
boolean or null

Entries must be Validate on import

FileName
string or null

Overrides the uploaded file name

WithAnalytics
boolean or null

Import with the analytics or not

WithQuantities
boolean or null

Import with the quantities or not

WithSellingPrice
boolean or null

Import with the selling price or not

KeepAccountLabels
boolean or null

Keep account labels

MarkLinesAsRevised
boolean or null

Mark lines as revised

KeepLinesWithZeroAmount
boolean or null

Keep lines with zero amount

WithPartialLettering
boolean or null

Import with partial lettering or not

WithVatDetails
boolean or null

Import with VAT details or not

WithoutAccountMappingTemplate
boolean or null

Import without account mapping template or not

WithDueDate
boolean or null

Import with due date or not

WithPaymentMethod
boolean or null

Import with payment method (ModePaiement column) or not

AutoIntegrate
boolean or null

Integration auto (without WaitingUserAction status)

FileAttachmentImportType
string or null
Enum: "None" "NomFichier" "PieceRef" "ForceNomFichier" "ForcePieceRef"

Attachment file type (none, NomFichier, PieceRef)

AnalyticLibraryId
integer or null <int32>

Id of the analytic library to activate before the import, when it is not already active

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Get one import operation by id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Delete an operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Operations_ImportBalance

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>
Type
required
string
Enum: "OpeningBalance" "PeriodicBalanceWithoutAn" "PeriodicBalanceWithAn"
JournalId
required
integer <int32>
EntryDate
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Import file with a specific template

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
templateId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

File to import

MarkLinesAsRevised
boolean or null

Mark lines as revised

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Import a balance snapshot

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>

File

StartDate
required
string <date-time>

StartDate

EndDate
required
string <date-time>

EndDate

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Post action to generate book entries

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Retry an operation (ADMIN): recreate a new operation with the same options and the already uploaded file, then republish the import message Supports only operations with status ReadFileFail or ParsingFail

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Get waiting line for operation Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
query Parameters
index
required
integer <int32>
count
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Clean after successful import

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "FileId": 0,
  • "FileName": "string",
  • "FileType": "Undefined",
  • "FileAttachmentImportType": "None",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Received",
  • "OperationType": "None",
  • "OperationSource": "Inqom",
  • "PostImportProcess": "None",
  • "WithAnalytics": true,
  • "WithQuantities": true,
  • "WithSellingPrice": true,
  • "KeepAccountLabels": true,
  • "MarkLinesAsRevised": true,
  • "KeepLinesWithZeroAmount": true,
  • "WithPartialLettering": true,
  • "WithVatDetails": true,
  • "WithoutAccountMappingTemplate": true,
  • "AutoIntegrate": true,
  • "WithDueDate": true,
  • "WithPaymentMethod": true,
  • "ExerciseId": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "Errors": [
    ],
  • "EntriesCount": 0,
  • "LetteredEntryLinesCount": 0,
  • "EntryLinesCount": 0,
  • "BeginFileDate": "2019-08-24T14:15:22Z",
  • "EndFileDate": "2019-08-24T14:15:22Z",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "ImportFileTemplateId": 0,
  • "BalanceSnapshotStartDate": "2019-08-24T14:15:22Z",
  • "BalanceSnapshotEndDate": "2019-08-24T14:15:22Z"
}

Rollback an operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Remove others operations in same exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Change state of operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
query Parameters
state
required
string
Enum: "Received" "ReadFileFail" "ParsingFail" "ParsingOk" "WaitingUserAction" "Succeeded" "Remove" "EntryIntegration" "Lettering" "ExerciseReplace" "RollBack" "IntegrationFailed" "ParsingStart" "Purged" "ExerciseClosing" "EntryIntegrationPending"

Responses

Operations needed to be purged

Authorizations:
oauth2
query Parameters
deadline
required
string <date-time>
isForRealEnterprise
required
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purge data for an operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Close an exercise after having imported a Closed FEC

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the enterprise Id.

operationId
required
integer <int32>

The operation Id.

Responses

Get accounts with invalid status

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder Id

operationId
required
integer <int32>

The operation Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Parsing operations needed to be stoped

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Integration operations needed to be stoped

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rollback operations needed to be relaunched

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exercise closing operations needed to be stopped

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pdf

Create a pdf from html files

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

the id of concerned enterprise

Request Body schema:
required

Command containing different html files (style, cover, footer, header, contents)

Header
string or null
Footer
string or null
Cover
string or null
Style
string or null
HeaderFooterEnableOnCover
required
boolean
HtmlFiles
Array of strings or null
FileName
string or null

Responses

Request samples

Content type
{
  • "Header": "string",
  • "Footer": "string",
  • "Cover": "string",
  • "Style": "string",
  • "HeaderFooterEnableOnCover": true,
  • "HtmlFiles": [
    ],
  • "FileName": "string"
}

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Url": "string"
}

PersonParticipations

GetParticipations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownedLegalPersonId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "OwnerLegalPersonId": 0,
  • "OwnedLegalPersonId": 0,
  • "OwnedLegalPersonName": "string",
  • "OwnerIsCorporateOfficer": true,
  • "OwnerCorporateOfficerType": "NotSpecified",
  • "ShareholderIdentifier": "string",
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "FullOwnerShipShareCount": 0,
  • "FullOwnerShipShareDecimal": 0,
  • "IndirectSharePercent": 0,
  • "BareOwnershipShareCount": 0,
  • "BareOwnershipShareDecimal": 0,
  • "UsufructShareCount": 0,
  • "UsufructShareDecimal": 0,
  • "SharePercent": 0,
  • "DateEntry": "2019-08-24T14:15:22Z",
  • "DateExit": "2019-08-24T14:15:22Z",
  • "IsOwnerInqomFolder": true,
  • "IsOwnedInqomFolder": true,
  • "IsOwnedForeignLegalPerson": true,
  • "OwnedShareCapital": 0,
  • "OwnedParValue": 0,
  • "OwnedShareTotalCount": 0
}

CreateParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownedLegalPersonId
required
integer <int32>
Request Body schema:
OwnerIsCorporateOfficer
required
boolean
OwnerCorporateOfficerType
string or null
Enum: "NotSpecified" "Manager" "President" "ChiefExecutiveOfficer" "ChiefOperatingOfficer" "PresidentCA" "MemberCA" "MemberCS"
ShareholderIdentifier
string or null
AcquisitionDate
string or null <date-time>
FullOwnerShipShareCount
number or null <decimal>
IndirectSharePercent
number or null <decimal>
BareOwnershipShareCount
number or null <decimal>
UsufructShareCount
number or null <decimal>
Array of objects or null (UsufructHolderCommand)
DateEntry
string or null <date-time>
DateExit
string or null <date-time>
CustomDistributionTaxableIncomePercent
number or null <decimal> [ 0 .. 100 ]
CustomDistributionCapitalGainsPercent
number or null <decimal> [ 0 .. 100 ]
Urssaf
string or null
Deprecated
Msa
string or null
Pacage
string or null
IsAgriculturalOperator
required
boolean

Responses

Request samples

Content type
{
  • "OwnerIsCorporateOfficer": true,
  • "OwnerCorporateOfficerType": "NotSpecified",
  • "ShareholderIdentifier": "string",
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "FullOwnerShipShareCount": 0,
  • "IndirectSharePercent": 0,
  • "BareOwnershipShareCount": 0,
  • "UsufructShareCount": 0,
  • "UsufructHolders": [
    ],
  • "DateEntry": "2019-08-24T14:15:22Z",
  • "DateExit": "2019-08-24T14:15:22Z",
  • "CustomDistributionTaxableIncomePercent": 0,
  • "CustomDistributionCapitalGainsPercent": 0,
  • "Urssaf": "string",
  • "Msa": "string",
  • "Pacage": "string",
  • "IsAgriculturalOperator": true
}

Response samples

Content type
application/json
0
0

EditParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownedLegalPersonId
required
integer <int32>
Request Body schema:
OwnerIsCorporateOfficer
required
boolean
OwnerCorporateOfficerType
string or null
Enum: "NotSpecified" "Manager" "President" "ChiefExecutiveOfficer" "ChiefOperatingOfficer" "PresidentCA" "MemberCA" "MemberCS"
ShareholderIdentifier
string or null
AcquisitionDate
string or null <date-time>
FullOwnerShipShareCount
number or null <decimal>
IndirectSharePercent
number or null <decimal>
BareOwnershipShareCount
number or null <decimal>
UsufructShareCount
number or null <decimal>
Array of objects or null (UsufructHolderCommand)
DateEntry
string or null <date-time>
DateExit
string or null <date-time>
CustomDistributionTaxableIncomePercent
number or null <decimal> [ 0 .. 100 ]
CustomDistributionCapitalGainsPercent
number or null <decimal> [ 0 .. 100 ]
Urssaf
string or null
Deprecated
Msa
string or null
Pacage
string or null
IsAgriculturalOperator
required
boolean

Responses

Request samples

Content type
{
  • "OwnerIsCorporateOfficer": true,
  • "OwnerCorporateOfficerType": "NotSpecified",
  • "ShareholderIdentifier": "string",
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "FullOwnerShipShareCount": 0,
  • "IndirectSharePercent": 0,
  • "BareOwnershipShareCount": 0,
  • "UsufructShareCount": 0,
  • "UsufructHolders": [
    ],
  • "DateEntry": "2019-08-24T14:15:22Z",
  • "DateExit": "2019-08-24T14:15:22Z",
  • "CustomDistributionTaxableIncomePercent": 0,
  • "CustomDistributionCapitalGainsPercent": 0,
  • "Urssaf": "string",
  • "Msa": "string",
  • "Pacage": "string",
  • "IsAgriculturalOperator": true
}

DeleteParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownedLegalPersonId
required
integer <int32>

Responses

PersonShareholders

GetShareholders

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownerId
required
integer <int32>
query Parameters
ownerType
string
Enum: "LegalPerson" "NaturalPerson"
Request Body schema:
OwnerIsCorporateOfficer
required
boolean
OwnerCorporateOfficerType
string or null
Enum: "NotSpecified" "Manager" "President" "ChiefExecutiveOfficer" "ChiefOperatingOfficer" "PresidentCA" "MemberCA" "MemberCS"
ShareholderIdentifier
string or null
AcquisitionDate
string or null <date-time>
FullOwnerShipShareCount
number or null <decimal>
IndirectSharePercent
number or null <decimal>
BareOwnershipShareCount
number or null <decimal>
UsufructShareCount
number or null <decimal>
Array of objects or null (UsufructHolderCommand)
DateEntry
string or null <date-time>
DateExit
string or null <date-time>
CustomDistributionTaxableIncomePercent
number or null <decimal> [ 0 .. 100 ]
CustomDistributionCapitalGainsPercent
number or null <decimal> [ 0 .. 100 ]
Urssaf
string or null
Deprecated
Msa
string or null
Pacage
string or null
IsAgriculturalOperator
required
boolean

Responses

Request samples

Content type
{
  • "OwnerIsCorporateOfficer": true,
  • "OwnerCorporateOfficerType": "NotSpecified",
  • "ShareholderIdentifier": "string",
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "FullOwnerShipShareCount": 0,
  • "IndirectSharePercent": 0,
  • "BareOwnershipShareCount": 0,
  • "UsufructShareCount": 0,
  • "UsufructHolders": [
    ],
  • "DateEntry": "2019-08-24T14:15:22Z",
  • "DateExit": "2019-08-24T14:15:22Z",
  • "CustomDistributionTaxableIncomePercent": 0,
  • "CustomDistributionCapitalGainsPercent": 0,
  • "Urssaf": "string",
  • "Msa": "string",
  • "Pacage": "string",
  • "IsAgriculturalOperator": true
}

Response samples

Content type
application/json
0
0

EditParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownerId
required
integer <int32>
query Parameters
ownerType
string
Enum: "LegalPerson" "NaturalPerson"
Request Body schema:
OwnerIsCorporateOfficer
required
boolean
OwnerCorporateOfficerType
string or null
Enum: "NotSpecified" "Manager" "President" "ChiefExecutiveOfficer" "ChiefOperatingOfficer" "PresidentCA" "MemberCA" "MemberCS"
ShareholderIdentifier
string or null
AcquisitionDate
string or null <date-time>
FullOwnerShipShareCount
number or null <decimal>
IndirectSharePercent
number or null <decimal>
BareOwnershipShareCount
number or null <decimal>
UsufructShareCount
number or null <decimal>
Array of objects or null (UsufructHolderCommand)
DateEntry
string or null <date-time>
DateExit
string or null <date-time>
CustomDistributionTaxableIncomePercent
number or null <decimal> [ 0 .. 100 ]
CustomDistributionCapitalGainsPercent
number or null <decimal> [ 0 .. 100 ]
Urssaf
string or null
Deprecated
Msa
string or null
Pacage
string or null
IsAgriculturalOperator
required
boolean

Responses

Request samples

Content type
{
  • "OwnerIsCorporateOfficer": true,
  • "OwnerCorporateOfficerType": "NotSpecified",
  • "ShareholderIdentifier": "string",
  • "AcquisitionDate": "2019-08-24T14:15:22Z",
  • "FullOwnerShipShareCount": 0,
  • "IndirectSharePercent": 0,
  • "BareOwnershipShareCount": 0,
  • "UsufructShareCount": 0,
  • "UsufructHolders": [
    ],
  • "DateEntry": "2019-08-24T14:15:22Z",
  • "DateExit": "2019-08-24T14:15:22Z",
  • "CustomDistributionTaxableIncomePercent": 0,
  • "CustomDistributionCapitalGainsPercent": 0,
  • "Urssaf": "string",
  • "Msa": "string",
  • "Pacage": "string",
  • "IsAgriculturalOperator": true
}

DeleteParticipation

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
ownerId
required
integer <int32>
query Parameters
ownerType
string
Enum: "LegalPerson" "NaturalPerson"

Responses

ProvisioningAccountingFolders

Création d'un exercice comptable pour un dossier d'un cabinet donné Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>
dossierId
required
integer <int32>
Request Body schema:
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "Year": 0
}

Création d'un exercice comptable pour un dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
BeginDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "BeginDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "Year": 0
}

Archiver un dossier d'un cabinet Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>

Id cabinet

dossierId
required
integer <int32>

Id dossier

Responses

Archiver un dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Id dossier

Responses

Activer un dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Id dossier

Responses

Désarchiver un dossier d'un cabinet Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>

Id cabinet

dossierId
required
integer <int32>

Id dossier

Responses

Désarchiver un dossier

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Id dossier

Responses

Delete an archived accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Gets the informations from the "Dossier Permanent General" for a given dossierId Deprecated

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "Ape": "string",
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "Telephone": "string",
  • "Website": "string",
  • "Activity": "string",
  • "LegalForm": {
    },
  • "Address": {
    },
  • "Addresses": [
    ],
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Siret": "string",
  • "CodeNafId": 0,
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "VatSystemId": 0,
  • "TaxSystemId": 0,
  • "ChartOfAccountId": 0,
  • "ExtendedChartOfAccountsId": 0,
  • "VatTaxObligationReference": "string",
  • "CseType": "None",
  • "AccountingType": "Engagement",
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "ContractType": "Normal",
  • "StateMode": "Active",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z",
  • "CompanyId": 0,
  • "TradeName": "string",
  • "UrlLogo": "string",
  • "Container": "string",
  • "AcceptProviderEmails": true,
  • "IsEligibleToAi": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "TaxSystem": {
    },
  • "Email": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Id": 0,
  • "Name": "string"
}

Gets the informations from the "Dossier Permanent Fiscal" for a given dossierId Deprecated

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TaxSystem": {
    },
  • "VatSystem": {
    },
  • "Rof": {
    }
}

Gets the informations from the "Dossier Permanent Juridique" for a given dossierId Deprecated

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "LegalPersonCapital": {
    },
  • "MinorShareHolders": [
    ],
  • "MajorShareHolders": [
    ]
}

Gets the informations from the "Dossier Permanent Social" for a given dossierId Deprecated

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StaffCountAverage": 0,
  • "StaffCountFinal": 0,
  • "PayrollManagedByAccountingFirm": true
}

Gets the informations from the "Dossier Permanent General" for a given dossierId

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "Ape": "string",
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "Telephone": "string",
  • "Website": "string",
  • "Activity": "string",
  • "LegalForm": {
    },
  • "Address": {
    },
  • "Addresses": [
    ],
  • "ExternalId": "string",
  • "UniqueName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Siret": "string",
  • "CodeNafId": 0,
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "VatSystemId": 0,
  • "TaxSystemId": 0,
  • "ChartOfAccountId": 0,
  • "ExtendedChartOfAccountsId": 0,
  • "VatTaxObligationReference": "string",
  • "CseType": "None",
  • "AccountingType": "Engagement",
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "ContractType": "Normal",
  • "StateMode": "Active",
  • "StateModeClosingDate": "2019-08-24T14:15:22Z",
  • "CompanyId": 0,
  • "TradeName": "string",
  • "UrlLogo": "string",
  • "Container": "string",
  • "AcceptProviderEmails": true,
  • "IsEligibleToAi": true,
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "TaxSystem": {
    },
  • "Email": "string",
  • "WhiteLabelId": 0,
  • "ThemeId": 0,
  • "Id": 0,
  • "Name": "string"
}

Upage accounting folder general informations

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Name
required
string non-empty
TradeName
string or null
CreationDate
string or null <date-time>
LegalFormId
required
integer <int32>
LegalFormDisplayName
string or null [ 0 .. 150 ] characters
Nic
required
string [ 0 .. 5 ] characters
Siren
required
string [ 0 .. 9 ] characters
Ape
string or null [ 3 .. 6 ] characters
Deprecated
CodeNafId
integer <int32>
Activity
string or null <= 50 characters
CseType
string or null
Enum: "None" "Small" "Medium" "Large"
RegistrationCity
string or null <= 100 characters
RegistrationType
required
string
Enum: "None" "A" "B"
RegistrationDate
string or null <date-time>
IsListedOnTradeDirectory
required
boolean
ExternalId
string or null <= 50 characters
ExternalSystemId
string or null <= 50 characters
object (LocationCommand)
Telephone
string or null
Email
string or null
WebSite
string or null
AccountingType
string or null
Enum: "Engagement" "Trésorerie"
IsAppelALaGenerositeDuPublic
boolean
IsMedicoSocial
required
boolean
IsNonProfessionalFurnishedRental
required
boolean

Responses

Request samples

Content type
{
  • "Name": "string",
  • "TradeName": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "Nic": "strin",
  • "Siren": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "Activity": "string",
  • "CseType": "None",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "IsListedOnTradeDirectory": true,
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Location": {
    },
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "AccountingType": "Engagement",
  • "IsAppelALaGenerositeDuPublic": true,
  • "IsMedicoSocial": true,
  • "IsNonProfessionalFurnishedRental": true
}

Response samples

Content type
application/json
{
  • "Message": "string",
  • "Errors": [
    ]
}

Gets the informations from the "Dossier Permanent Fiscal" for a given dossierId

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TaxSystem": {
    },
  • "VatSystem": {
    },
  • "Rof": {
    }
}

Gets the informations from the "Dossier Permanent Juridique" for a given dossierId

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "LegalPersonCapital": {
    },
  • "MinorShareHolders": [
    ],
  • "MajorShareHolders": [
    ]
}

Gets the informations from the "Dossier Permanent Social" for a given dossierId

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StaffCountAverage": 0,
  • "StaffCountFinal": 0,
  • "PayrollManagedByAccountingFirm": true
}

ProvisioningAccountingFolders_UpdateGeneralObsolete Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>
dossierId
required
integer <int32>
Request Body schema:
Name
required
string non-empty
CreationDate
required
string <date-time>
LegalForm
required
string non-empty
Nic
required
string [ 0 .. 5 ] characters
Ape
required
string [ 3 .. 6 ] characters
MissionLetterDate
string or null <date-time>
object (Address)
Telephone
string or null
Email
string or null
WebSite
string or null
Activity
string or null <= 50 characters
ExternalId
string or null <= 50 characters

Responses

Request samples

Content type
{
  • "Name": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "LegalForm": "string",
  • "Nic": "strin",
  • "Ape": "string",
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "Address": {
    },
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "Activity": "string",
  • "ExternalId": "string"
}

Update accounting folder fiscal information

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Id
required
integer <int32>
TaxSystemId
integer <int32>
WithDepositeISTax
required
boolean
VatSystemId
integer <int32>
IsAgriculturalCA12Applicable
boolean
VatDeadlineDay
integer <int32>
VatTaxObligationReference
string or null
VatRateOnTaxableSales
Array of numbers or null <decimal> [ items <decimal > ]
VatRateOnTaxablePurchases
number or null <decimal>
SalesExigibilite
string or null
Enum: "Unknown" "OnReceipts" "OnDebits" "VatOptionOnDebits" "Mixed"
Rof
string or null
RofCVAE
string or null
TaxReporterGender
string or null
TaxReporterName
string or null
TaxReporterTitle
string or null
IsSubjectToCbCR
required
boolean
IsOverHeadCosts
required
boolean
IsTransferPricing
required
boolean
IsCvaeAdvanceDeposit
required
boolean
IsBalance
required
boolean
IsSubjectToCvae
required
boolean
IsSubjectTo1330Cvae
required
boolean
IsMonoEstablishment
required
boolean
IsEligibleForReducedRate
required
boolean
TaxIntracommunityNumber
string or null
Array of objects or null (EnterpriseAdvisorCommand)
HasPayrollTaxLiability
boolean
HasCfeLiability
boolean

Responses

Request samples

Content type
{
  • "Id": 0,
  • "TaxSystemId": 0,
  • "WithDepositeISTax": true,
  • "VatSystemId": 0,
  • "IsAgriculturalCA12Applicable": true,
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "VatRateOnTaxableSales": [
    ],
  • "VatRateOnTaxablePurchases": 0,
  • "SalesExigibilite": "Unknown",
  • "Rof": "string",
  • "RofCVAE": "string",
  • "TaxReporterGender": "string",
  • "TaxReporterName": "string",
  • "TaxReporterTitle": "string",
  • "IsSubjectToCbCR": true,
  • "IsOverHeadCosts": true,
  • "IsTransferPricing": true,
  • "IsCvaeAdvanceDeposit": true,
  • "IsBalance": true,
  • "IsSubjectToCvae": true,
  • "IsSubjectTo1330Cvae": true,
  • "IsMonoEstablishment": true,
  • "IsEligibleForReducedRate": true,
  • "TaxIntracommunityNumber": "string",
  • "EnterpriseAdvisors": [
    ],
  • "HasPayrollTaxLiability": true,
  • "HasCfeLiability": true
}

Response samples

Content type
application/json
{
  • "IsOk": true,
  • "IsError": true,
  • "Message": "string",
  • "Errors": [
    ],
  • "Warnings": [
    ]
}

Change legal information of accounting folder in company

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
ShareCapital
number or null <decimal>
ParValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
NaturalPersonShareholdersTotalCount
integer <int32>
NaturalPersonShareholdersTotalShareCount
integer <int32>
LegalPersonShareholdersTotalCount
integer <int32>
LegalPersonShareholdersTotalShareCount
integer <int32>
MinorShareholdersCount
integer <int32>
MinorShareholdersShareCount
integer <int32>

Responses

Request samples

Content type
{
  • "ShareCapital": 0,
  • "ParValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "NaturalPersonShareholdersTotalCount": 0,
  • "NaturalPersonShareholdersTotalShareCount": 0,
  • "LegalPersonShareholdersTotalCount": 0,
  • "LegalPersonShareholdersTotalShareCount": 0,
  • "MinorShareholdersCount": 0,
  • "MinorShareholdersShareCount": 0
}

Invite a collaborator in accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
FirstName
string or null
LastName
required
string or null
Email
required
string or null
RoleName
required
string or null
Active
required
boolean
ShouldSendEmail
boolean

Indicates whether an email should be sent. True by default

Responses

Request samples

Content type
{
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "RoleName": "string",
  • "Active": true,
  • "ShouldSendEmail": true
}

Activate accounting folder user, send message and setup profile

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
userId
required
integer <int32>
query Parameters
shouldSendEmail
boolean
Default: true

for enabling sending mail invitation to accounting folder user

Responses

Get a collaborator in accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove a internal user from accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
userId
integer <int32>

Responses

Gets the accounting folders matching the given externalId that the current user has access to

Authorizations:
oauth2
query Parameters
externalId
string

External identifier of the accounting folders to look up

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Partially update the permanent file of an accounting folder (general, mission letter, fiscal sections). Only non-null fields are applied; null means keep current value.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting folder identifier

Request Body schema:

Partial update payload

Name
string or null
TradeName
string or null
CreationDate
string or null <date-time>
LegalFormId
integer <int32>
LegalFormDisplayName
string or null
Nic
string or null
Siren
string or null
Ape
string or null
CodeNafId
integer <int32>
Activity
string or null
CseType
string or null
Enum: "None" "Small" "Medium" "Large"
RegistrationCity
string or null
RegistrationType
string or null
Enum: "None" "A" "B"
RegistrationDate
string or null <date-time>
IsListedOnTradeDirectory
boolean
ExternalId
string or null
ExternalSystemId
string or null
object (PatchLocationCommand)
Telephone
string or null
Email
string or null
WebSite
string or null
AccountingType
string or null
Enum: "Engagement" "Trésorerie"
IsAppelALaGenerositeDuPublic
boolean
IsMedicoSocial
boolean
IsNonProfessionalFurnishedRental
boolean
HasAccountingSoftware
boolean
AccountingSoftwareName
string or null
HasProductionLegalAnnexesAnnualAccounts
boolean
MissionLetterDate
string or null <date-time>
HasVatKeeping
boolean
DistributionContract
boolean
AccountingFolderTypology
string or null
Enum: "BookKeeping" "RevisionClosing"
SpecificTreatmentType
string or null
Enum: "None" "Agricultural"
TaxSystemId
integer <int32>
WithDepositeISTax
boolean
VatSystemId
integer <int32>
IsAgriculturalCA12Applicable
boolean
VatDeadlineDay
integer <int32>
VatTaxObligationReference
string or null
VatRateOnTaxableSales
Array of numbers or null <decimal> [ items <decimal > ]
VatRateOnTaxablePurchases
number or null <decimal>
SalesExigibilite
string or null
Enum: "Unknown" "OnReceipts" "OnDebits" "VatOptionOnDebits" "Mixed"
Rof
string or null
RofCVAE
string or null
TaxReporterGender
string or null
TaxReporterName
string or null
TaxReporterTitle
string or null
IsSubjectToCbCR
boolean
IsOverHeadCosts
boolean
IsTransferPricing
boolean
IsCvaeAdvanceDeposit
boolean
IsBalance
boolean
IsSubjectToCvae
boolean
IsSubjectTo1330Cvae
boolean
IsMonoEstablishment
boolean
IsEligibleForReducedRate
boolean
TaxIntracommunityNumber
string or null
Array of objects or null (EnterpriseAdvisorCommand)
HasPayrollTaxLiability
boolean
HasCfeLiability
boolean

Responses

Request samples

Content type
{
  • "Name": "string",
  • "TradeName": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "LegalFormId": 0,
  • "LegalFormDisplayName": "string",
  • "Nic": "string",
  • "Siren": "string",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "Activity": "string",
  • "CseType": "None",
  • "RegistrationCity": "string",
  • "RegistrationType": "None",
  • "RegistrationDate": "2019-08-24T14:15:22Z",
  • "IsListedOnTradeDirectory": true,
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Location": {
    },
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "AccountingType": "Engagement",
  • "IsAppelALaGenerositeDuPublic": true,
  • "IsMedicoSocial": true,
  • "IsNonProfessionalFurnishedRental": true,
  • "HasAccountingSoftware": true,
  • "AccountingSoftwareName": "string",
  • "HasProductionLegalAnnexesAnnualAccounts": true,
  • "MissionLetterDate": "2019-08-24T14:15:22Z",
  • "HasVatKeeping": true,
  • "DistributionContract": true,
  • "AccountingFolderTypology": "BookKeeping",
  • "SpecificTreatmentType": "None",
  • "TaxSystemId": 0,
  • "WithDepositeISTax": true,
  • "VatSystemId": 0,
  • "IsAgriculturalCA12Applicable": true,
  • "VatDeadlineDay": 0,
  • "VatTaxObligationReference": "string",
  • "VatRateOnTaxableSales": [
    ],
  • "VatRateOnTaxablePurchases": 0,
  • "SalesExigibilite": "Unknown",
  • "Rof": "string",
  • "RofCVAE": "string",
  • "TaxReporterGender": "string",
  • "TaxReporterName": "string",
  • "TaxReporterTitle": "string",
  • "IsSubjectToCbCR": true,
  • "IsOverHeadCosts": true,
  • "IsTransferPricing": true,
  • "IsCvaeAdvanceDeposit": true,
  • "IsBalance": true,
  • "IsSubjectToCvae": true,
  • "IsSubjectTo1330Cvae": true,
  • "IsMonoEstablishment": true,
  • "IsEligibleForReducedRate": true,
  • "TaxIntracommunityNumber": "string",
  • "EnterpriseAdvisors": [
    ],
  • "HasPayrollTaxLiability": true,
  • "HasCfeLiability": true
}

Response samples

Content type
application/json
{
  • "Message": "string",
  • "Errors": [
    ]
}

ProvisioningAssignments

Assign users of company in accounting folders

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
AccountingFoldersId
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "AccountingFoldersId": [
    ]
}

Unassign users of company in accounting folders

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
AccountingFolderId
required
integer <int32>

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "AccountingFolderId": 0
}

Get accountingFolder for userId Deprecated

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get accountingFolder for userId in companyId

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
query Parameters
companyId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the company users list for a given "dossierId" Deprecated

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the company users list for a given "AccountingFolderId"

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign user with roles in company Required : Role, userId, companyId

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>
CodeRole
required
string
Enum: "None" "CA" "A" "S" "CEO" "DAF" "E" "RF" "SM" "TAG" "SUP" "EA" "CEO_GROUPE" "DAF_GROUPE" "CC_GROUPE" "C_GROUPE" "J" "FI" "SYSTEM" "DAF_READONLY" "E_FE"

Responses

Request samples

Content type
{
  • "UserId": 0,
  • "CodeRole": "None"
}

Unassign user from company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "UserId": 0
}

List companies (cabinet/pme) the current user can access

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ProvisioningCompany

Récupération des dossiers du cabinet/PME

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Cabinet/PME Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un dossier pour un cabinet/PME

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Id Cabinet/PME

Request Body schema:

Informations sur le dossier

Name
required
string non-empty
LegalFormId
integer <int32>
TaxSystemId
integer <int32>
VatSystemId
integer <int32>
VatDeadlineDay
integer <int32>
Siren
required
string [ 0 .. 9 ] characters
Nic
required
string [ 0 .. 5 ] characters
Ape
string or null [ 3 .. 6 ] characters
Deprecated
CodeNafId
integer <int32>
ExerciseBeginDate
required
string <date-time>
ExerciseEndDate
required
string <date-time>
Activity
string or null <= 50 characters
CreationDate
string or null <date-time>
object (LocationCommand)
ExternalId
string or null <= 50 characters
ExternalSystemId
string or null <= 50 characters
Assignees
Array of integers or null <int32> [ items <int32 > ]
AccountingType
string or null <Enumeration>
Enum: "Engagement" "Trésorerie"
AccountingFolderTypology
string or null <Enumeration>
Enum: "BookKeeping" "RevisionClosing"
ChartOfAccountsType
string or null <Enumeration>
Enum: "InqomPcg" "PCAAssociatif" "PCGeneral" "PCCSE" "PCNotary" "PCAgricole"
ApplyDefaultChartOfAccounts
boolean
CseType
string or null <Enumeration>
Enum: "None" "Small" "Medium" "Large"
RcsRegistrationDate
string or null <date-time>
IsListedOnTradeDirectory
required
boolean
Telephone
string or null
Email
string or null
WebSite
string or null
ShareCapital
number or null <decimal>
ParValue
number or null <decimal>
InventoryValue
number or null <decimal>
ShareTotalCount
integer <int64>
IsAppelALaGenerositeDuPublic
boolean
AccountingMode
string or null <Enumeration>
Enum: "Manual" "Auto"
ManagementMode
string or null
Enum: "TotalProduction" "PreAccounting"
HasAccountingSoftware
required
boolean
AccountingSoftwareName
string or null [ 0 .. 255 ] characters

Responses

Request samples

Content type
{
  • "Name": "string",
  • "LegalFormId": 0,
  • "TaxSystemId": 0,
  • "VatSystemId": 0,
  • "VatDeadlineDay": 0,
  • "Siren": "string",
  • "Nic": "strin",
  • "Ape": "string",
  • "CodeNafId": 0,
  • "ExerciseBeginDate": "2019-08-24T14:15:22Z",
  • "ExerciseEndDate": "2019-08-24T14:15:22Z",
  • "Activity": "string",
  • "CreationDate": "2019-08-24T14:15:22Z",
  • "Location": {
    },
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "Assignees": [
    ],
  • "AccountingType": "Engagement",
  • "AccountingFolderTypology": "BookKeeping",
  • "ChartOfAccountsType": "InqomPcg",
  • "ApplyDefaultChartOfAccounts": true,
  • "CseType": "None",
  • "RcsRegistrationDate": "2019-08-24T14:15:22Z",
  • "IsListedOnTradeDirectory": true,
  • "Telephone": "string",
  • "Email": "string",
  • "WebSite": "string",
  • "ShareCapital": 0,
  • "ParValue": 0,
  • "InventoryValue": 0,
  • "ShareTotalCount": 0,
  • "IsAppelALaGenerositeDuPublic": true,
  • "AccountingMode": "Manual",
  • "ManagementMode": "TotalProduction",
  • "HasAccountingSoftware": true,
  • "AccountingSoftwareName": "string"
}

Response samples

Content type
application/json
{
  • "ExternalSystemId": "string",
  • "ExternalId": "string",
  • "ManagementMode": "TotalProduction",
  • "Id": 0,
  • "Siren": "string",
  • "Nic": "string",
  • "Name": "string",
  • "UniqueName": "string",
  • "ContractType": "Normal",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Active",
  • "AccountingType": "Engagement",
  • "CompanyId": 0,
  • "StateMode": "Active",
  • "OwnerCompanyId": 0
}

Get AccountingFolder of company by name / externalId / externalSystemId / contact in accounting folder / legalForm / siret (siren + nic)

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

companyId

query Parameters
search
string

Search parameters

page
integer <int32>

Number page

size
integer <int32>

Size page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Récupération des utilisateurs du cabinet/PME

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Cabinet/PME Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user for a given accounting firm

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
Gender
required
string
Enum: "Mrs" "Mr" "Ms" "None"
Firstname
string or null
Lastname
string or null
Email
string or null
InviterEmail
string or null
CodeRole
required
string
Enum: "None" "CA" "A" "S" "CEO" "DAF" "E" "RF" "SM" "TAG" "SUP" "EA" "CEO_GROUPE" "DAF_GROUPE" "CC_GROUPE" "C_GROUPE" "J" "FI" "SYSTEM" "DAF_READONLY" "E_FE"
Active
required
boolean
ShouldSendEmail
boolean

Responses

Request samples

Content type
{
  • "Gender": "Mrs",
  • "Firstname": "string",
  • "Lastname": "string",
  • "Email": "string",
  • "InviterEmail": "string",
  • "CodeRole": "None",
  • "Active": true,
  • "ShouldSendEmail": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CabinetId": 0,
  • "Gender": "string",
  • "Firstname": "string",
  • "Lastname": "string",
  • "Email": "string",
  • "CodeRole": "string"
}

Récupération des personnes physiques du cabinet

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Supprime une personne physique du cabinet

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
naturalPersonId
required
integer <int32>

Responses

Create new company

Authorizations:
oauth2
Request Body schema:
required
CompanyName
required
string non-empty
PhoneNumber
required
string non-empty
LastName
required
string non-empty
CompanyType
required
string
Enum: "None" "Accounting" "Pme"
Siren
string or null [ 0 .. 9 ] characters
Nic
string or null [ 0 .. 5 ] characters
ExternalId
string or null
ExternalSystemId
string or null <= 50 characters
CompanyGroupId
integer <int32>
object (LocationCommand)
ContractType
required
string
Enum: "Normal" "Fake" "Demo" "Trial" "Ghost"
Segment
string or null
Enum: "LAF" "MAF" "SAF"

Responses

Request samples

Content type
{
  • "CompanyName": "string",
  • "PhoneNumber": "string",
  • "LastName": "string",
  • "CompanyType": "None",
  • "Siren": "string",
  • "Nic": "strin",
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "CompanyGroupId": 0,
  • "Location": {
    },
  • "ContractType": "Normal",
  • "Segment": "LAF"
}

Response samples

Content type
application/json
0
0

Update an existing company (provisioning). Strict update — returns 404 if the company does not exist (no upsert).

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Company id (path)

Request Body schema:
required

Updated company data (mirrors the POST payload)

CompanyName
required
string non-empty
PhoneNumber
required
string non-empty
LastName
required
string non-empty
CompanyType
required
string
Enum: "None" "Accounting" "Pme"
Siren
string or null [ 0 .. 9 ] characters
Nic
string or null [ 0 .. 5 ] characters
ExternalId
string or null
ExternalSystemId
string or null <= 50 characters
CompanyGroupId
integer <int32>
object (LocationCommand)
ContractType
required
string
Enum: "Normal" "Fake" "Demo" "Trial" "Ghost"

Responses

Request samples

Content type
{
  • "CompanyName": "string",
  • "PhoneNumber": "string",
  • "LastName": "string",
  • "CompanyType": "None",
  • "Siren": "string",
  • "Nic": "strin",
  • "ExternalId": "string",
  • "ExternalSystemId": "string",
  • "CompanyGroupId": 0,
  • "Location": {
    },
  • "ContractType": "Normal"
}

Response samples

Content type
application/json
0
0

Create user for a given accounting firm

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
Array of objects or null (CreateUserInCompanyCommand)

Responses

Request samples

Content type
{
  • "CreateUserCommands": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Activate user, send message and setup profile

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>
query Parameters
shouldSendEmail
boolean
Default: true

Responses

Disable user (user access is removed)

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>
query Parameters
userEmail
required
string

Responses

Move accounting folder from company to each other company and assign user

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
NewCompanyId
required
integer <int32>
AccountingFolderId
required
integer <int32>
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "NewCompanyId": 0,
  • "AccountingFolderId": 0,
  • "UserId": 0
}

Move many accounting folders from company to each other company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
NewCompanyId
required
integer <int32>
AccountingFolderIds
required
Array of integers <int32> <= 10 items [ items <int32 > ]

Responses

Request samples

Content type
{
  • "NewCompanyId": 0,
  • "AccountingFolderIds": [
    ]
}

Import many accounting folders / shareholders into a company / an accounting folder from an Excel file

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
isTestMode
boolean
withoutChartOfAccount
boolean
overrideChartOfAccountsType
string
Enum: "InqomPcg" "PCAAssociatif" "PCGeneral" "PCCSE" "PCNotary" "PCAgricole"
extendedChartOfAccountsId
integer <int32>
Request Body schema: multipart/form-data
importFile
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "Warnings": [
    ],
  • "ImportedAccountingFolders": [
    ],
  • "ImportedShareholders": [
    ],
  • "ShareholdersSummary": {
    },
  • "AccountingFoldersSummary": {
    }
}

List the columns of a bulk import template in the order of the template file, each with its letter, its exact name and whether it is reserved to the migration team.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
template
required
string

Responses

Response samples

Content type
application/json
{
  • "Template": "string",
  • "SheetName": "string",
  • "Columns": [
    ]
}

Import one accounting folder into a company from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
IsTestMode
required
boolean
WithoutChartOfAccount
boolean
OverrideChartOfAccountsType
string or null
Enum: "InqomPcg" "PCAAssociatif" "PCGeneral" "PCCSE" "PCNotary" "PCAgricole"
ExtendedChartOfAccountsId
integer <int32>
required
object (ImportAccountingFolderRawV2)

Responses

Request samples

Content type
{
  • "IsTestMode": true,
  • "WithoutChartOfAccount": true,
  • "OverrideChartOfAccountsType": "InqomPcg",
  • "ExtendedChartOfAccountsId": 0,
  • "AccountingFolder": {
    }
}

Response samples

Content type
application/json
{
  • "AccountingFolderId": 0,
  • "Warnings": [
    ]
}

Import many accounting folders into a company from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
IsTestMode
required
boolean
WithoutChartOfAccount
boolean
OverrideChartOfAccountsType
string or null
Enum: "InqomPcg" "PCAAssociatif" "PCGeneral" "PCCSE" "PCNotary" "PCAgricole"
ExtendedChartOfAccountsId
integer <int32>
required
Array of objects or null (ImportAccountingFolderRawV2)

Responses

Request samples

Content type
{
  • "IsTestMode": true,
  • "WithoutChartOfAccount": true,
  • "OverrideChartOfAccountsType": "InqomPcg",
  • "ExtendedChartOfAccountsId": 0,
  • "AccountingFolders": [
    ]
}

Response samples

Content type
application/json
{
  • "AccountingFolders": [
    ],
  • "Warnings": [
    ]
}

Switch the accounting type (Engagement or Trésorerie) of a list of accounting folders of a company, even with book entries: each folder is reported changed, already in the target type or rejected, the request reference kept in its history.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
AccountingFolderIds
required
Array of integers or null <int32> [ items <int32 > ]
AccountingType
required
string or null
Enum: "Engagement" "Trésorerie"
RequestReference
required
string or null

Responses

Request samples

Content type
{
  • "AccountingFolderIds": [
    ],
  • "AccountingType": "Engagement",
  • "RequestReference": "string"
}

Response samples

Content type
application/json
{
  • "ChangedCount": 0,
  • "AlreadyInTargetTypeCount": 0,
  • "RejectedCount": 0,
  • "Results": [
    ]
}

Import one shareholder into an accounting folder from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
IsTestMode
required
boolean
required
object (ImportShareholdersExcelRaw)

Responses

Request samples

Content type
{
  • "IsTestMode": true,
  • "Shareholder": {
    }
}

Response samples

Content type
application/json
{
  • "AccountingFolderId": 0,
  • "ShareHolderType": "None",
  • "PersonId": 0,
  • "ParticipationId": 0,
  • "Warnings": [
    ],
  • "Status": "Imported",
  • "FailureReason": "string"
}

Import many Shareholders into an accounting folder from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
IsTestMode
required
boolean
required
Array of objects or null (ImportShareholdersExcelRaw)

Responses

Request samples

Content type
{
  • "IsTestMode": true,
  • "Shareholders": [
    ]
}

Response samples

Content type
application/json
{
  • "ImportShareholderResults": [
    ]
}

Import one participation into an accounting folder from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
required
object (ImportParticipationRaw)

Responses

Request samples

Content type
{
  • "Participation": {
    }
}

Response samples

Content type
application/json
{
  • "AccountingFolderId": 0,
  • "PersonId": 0,
  • "ParticipationId": 0
}

Import many Participations into an accounting folder from a json command

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
required
Array of objects or null (ImportParticipationRaw)

Responses

Request samples

Content type
{
  • "Participations": [
    ]
}

Response samples

Content type
application/json
{
  • "ImportParticipationResults": [
    ]
}

Get all dossiers of a cabinet Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>

Cabinet ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un dossier pour un cabinet Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>

Id Cabinet

Request Body schema:

Informations sur le dossier

Name
required
string non-empty
LegalFormId
required
integer <int32>
TaxSystemId
required
integer <int32>
Siren
required
string [ 0 .. 9 ] characters
Ape
string or null [ 3 .. 6 ] characters
ExerciseBeginDate
required
string <date-time>
ExerciseEndDate
required
string <date-time>
ExternalId
string or null <= 50 characters
Assignees
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "Name": "string",
  • "LegalFormId": 0,
  • "TaxSystemId": 0,
  • "Siren": "string",
  • "Ape": "string",
  • "ExerciseBeginDate": "2019-08-24T14:15:22Z",
  • "ExerciseEndDate": "2019-08-24T14:15:22Z",
  • "ExternalId": "string",
  • "Assignees": [
    ]
}

Response samples

Content type
application/json
{
  • "ExternalSystemId": "string",
  • "ExternalId": "string",
  • "ManagementMode": "TotalProduction",
  • "Id": 0,
  • "Siren": "string",
  • "Nic": "string",
  • "Name": "string",
  • "UniqueName": "string",
  • "ContractType": "Normal",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Active",
  • "AccountingType": "Engagement",
  • "CompanyId": 0,
  • "StateMode": "Active",
  • "OwnerCompanyId": 0
}

ProvisioningCompany_MigrateDossierObsolete Deprecated

Authorizations:
oauth2
path Parameters
id
required
integer <int32>
Request Body schema:
NewCompanyId
required
integer <int32>
AccountingFolderId
required
integer <int32>
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "NewCompanyId": 0,
  • "AccountingFolderId": 0,
  • "UserId": 0
}

Create user for a given accounting firm Deprecated

Authorizations:
oauth2
path Parameters
cabinetId
required
integer <int32>
Request Body schema:
Gender
required
string
Enum: "Mrs" "Mr" "Ms" "None"
Firstname
string or null
Lastname
string or null
Email
string or null
InviterEmail
string or null
CodeRole
required
string
Enum: "None" "CA" "A" "S" "CEO" "DAF" "E" "RF" "SM" "TAG" "SUP" "EA" "CEO_GROUPE" "DAF_GROUPE" "CC_GROUPE" "C_GROUPE" "J" "FI" "SYSTEM" "DAF_READONLY" "E_FE"
Active
required
boolean
ShouldSendEmail
boolean

Responses

Request samples

Content type
{
  • "Gender": "Mrs",
  • "Firstname": "string",
  • "Lastname": "string",
  • "Email": "string",
  • "InviterEmail": "string",
  • "CodeRole": "None",
  • "Active": true,
  • "ShouldSendEmail": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CabinetId": 0,
  • "Gender": "string",
  • "Firstname": "string",
  • "Lastname": "string",
  • "Email": "string",
  • "CodeRole": "string"
}

ProvisioningReferences

Get All Vat System for Fiscal Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get All Legal Form for General Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get All tax system for General Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get All code NAF for General Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Public

Gets the current version of the application.

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
"string"

A test endpoint that returns the provided parameter.

Authorizations:
oauth2
query Parameters
param
string

Optional parameter to echo back

Responses

Response samples

Content type
application/json
"string"

Sends a request to reset the password for a user.

Authorizations:
oauth2
header Parameters
Origin
string
Referer
string
Request Body schema:
Email
string or null

Responses

Request samples

Content type
{
  • "Email": "string"
}

Response samples

Content type
application/json
true

Resets the password for a user using a token.

Authorizations:
oauth2
Request Body schema:
Token
string or null
Password
string or null

Responses

Request samples

Content type
{
  • "Token": "string",
  • "Password": "string"
}

Response samples

Content type
application/json
"string"

Confirms the user's email address using the token sent by email.

Authorizations:
oauth2
Request Body schema:
Token
string or null

Token received in the email confirmation link.

Responses

Request samples

Content type
{
  • "Token": "string"
}

PublicV1AccountingPeriods

Gets a list of accounting periods for a dossierId.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PublicV1Accounts

Gets the list of all accounts for a dossierId. The list may be trimmed by providing the starting characters of the requested accounts.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
query Parameters
accountNumberPrefix
string

(optional) The starting characters to filter account numbers on

accountType
string
Default: "Impactable"
Enum: "All" "Impactable"

(optional) 'Impactable' allows getting only impactable accounts, and 'All' allows getting all accounts (or those matching the accountNumberPrefix parameter).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an account for a dossierId.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
Request Body schema:

The Create Account command, containing the number and name of the account to create.

AccountNumber
string or null <= 39 characters
Name
string or null <= 100 characters
EntryDate
string or null <date-time>
Auxiliarize
boolean

Responses

Request samples

Content type
{
  • "AccountNumber": "string",
  • "Name": "string",
  • "EntryDate": "2019-08-24T14:15:22Z",
  • "Auxiliarize": true
}

Response samples

Content type
application/json
"string"

Get or creates accounts for a folder id.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The folder id

Request Body schema:
required

The accounts to get or create.

AtDate
string or null <date-time>
Array of objects or null (GetOrCreateAccountCommand_V1)

Responses

Request samples

Content type
{
  • "AtDate": "2019-08-24T14:15:22Z",
  • "Accounts": [
    ]
}

Response samples

Content type
application/json
{
  • "Accounts": {
    }
}

PublicV1Analytics

Add Analytics on entry lines (1000 entry lines max)

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
Request Body schema:
required
Array of objects (AddEntryLineAnalyticsCommand_V1)

Responses

Request samples

Content type
{
  • "EntryLinesAnalytics": [
    ]
}

PublicV1ANouveaux

Get Virtual An Entry for journal-contrôle.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
query Parameters
beginDate
required
string <date-time>

Begin dates match an exercise dates

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "JournalId": 0,
  • "JournalName": "string",
  • "EntryRef": "string",
  • "Date": "2019-08-24T14:15:22Z",
  • "ExerciseId": 0,
  • "Label": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "ValidateDate": "2019-08-24T14:15:22Z",
  • "ValidationNumber": 0,
  • "DocRef": "string",
  • "FileId": 0,
  • "DocDate": "2019-08-24T14:15:22Z",
  • "TransactionId": 0,
  • "Source": "ByUser",
  • "SourceId": "string",
  • "Conf": 0.1,
  • "Warning": "string",
  • "BankManaged": true,
  • "OperationId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "PaymentMethod": "string",
  • "LastUpdateDate": "2019-08-24T14:15:22Z",
  • "UserInfo": {
    },
  • "Lines": [
    ]
}

PublicV1Balances

Gets a list of account balances for a dossierId and a specific date range. The returned list may be scoped to specific book accounts.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

accountNumbers
Array of strings

(optional) A list of account numbers to filter returned balances.

balanceScope
string
Default: "Impacted"
Enum: "All" "Impacted"

'Impacted' allows getting only balances impacted in the requested date range, and 'All' allows getting the full account balances list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PublicV1Entries

This endpoint allows creating multiple book entries

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossierId for which the entries should be created

Request Body schema:
required

An array of Book entries to create

Array (<= 500 items)
JournalId
required
integer <int32>
Date
required
string <date-time>
EntryRef
string or null <= 100 characters
ExternalId
string or null <= 200 characters
object (CreateEntryDocumentCommand_V1)
Array of objects or null (CreateEntryLineCommand_V1)
AccountingDocumentId
integer <int32>
ExternalSource
string or null
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
Revision
string or null
Enum: "Unrevised" "Revised"
DueDate
string or null <date-time>
PaymentMethod
string or null <= 200 characters

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

This endpoint allows updating multiple entries

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossierId for which the entries should be updated

Request Body schema:
required

An array of Book entries to update

Array (<= 500 items)
Id
required
integer <int32>
JournalId
required
integer <int32>
Date
required
string <date-time>
object (UpdateEntryDocumentCommand_V1)
required
Array of objects (UpsertEntryLineCommand_V1)
ExternalSource
string or null
Enum: "ByUser" "ImportFec" "Server" "ImportBalance" "ImportFred" "FixedAsset" "Sellsy" "CutOff" "QuickBooks" "Loan" "Lease" "PublicApi" "VatDeclaration" "ANouveau" "Meg" "Silae" "Billing" "Grant" "Transfer" "Banking" "Chaintrust" "Payment" "CurrentAccountInterest" "Provision" "Stock" "Reverse" "ViDA" "Cashbook" "EdiFlux"
Revision
string or null
Enum: "Unrevised" "Revised"
DueDate
string or null <date-time>
PaymentMethod
string or null <= 200 characters

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

PublicV1EntryLines

Gets a single page of entry lines for a dossierId and a specific date range. The returned list may be scoped to a single book account

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossier identifier

query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

pageNumber
required
integer <int32>
Default: 1

The page number to get. Each page may contain at most 1000 entry lines.

accountNumber
string

(optional) An account number to filter returned entry lines

journalId
integer <int32>

(optional) Journal id to filter returned entry lines by journal

Responses

Response samples

Content type
application/json
{
  • "EntryLines": [
    ],
  • "CurrentPage": 0
}

Gets the paging informations for an entry lines list.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossier identifier

query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

accountNumber
string

(optional) An account number to filter counted entry lines

Responses

Response samples

Content type
application/json
{
  • "TotalLinesCount": 0,
  • "TotalPagesCount": 0
}

Gets a single page of changed entry lines for a dossierId, a specific date range, and changed after a specific date. The returned list may be scoped to a single book account

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossier identifier

query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

changedBefore
required
string <date-time>

The date before which the entry lines changed, with the following format : yyyy-MM-dd

changedAfter
string <date-time>

(optional) The date after which the entry lines changed, with the following format : yyyy-MM-dd

accountNumber
string

(optional) An account number to filter returned entry lines

pageNumber
required
integer <int32>
Default: 1

The page number to get. Each page may contain at most 1000 entry lines.

Responses

Response samples

Content type
application/json
{
  • "EntryLines": [
    ],
  • "CurrentPage": 0
}

Gets a single page of changed entry lines with analytics for a dossierId, a specific date range, and changed after a specific date. The returned list may be scoped to a single book account

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossier identifier

query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

changedBefore
required
string <date-time>

The date before which the entry lines changed, with the following format : yyyy-MM-dd

changedAfter
string <date-time>

(optional) The date after which the entry lines changed, with the following format : yyyy-MM-dd

pageNumber
required
integer <int32>
Default: 1

The page number to get. Each page may contain at most 100 000 entry lines.

pageItemCount
required
integer <int32> [ 1 .. 100000 ]
Default: 1000

Each page may contain at most 100 000 entry lines.

accountNumber
string

(optional) An account number to filter returned entry lines

Responses

Response samples

Content type
application/json
{
  • "EntryLines": [
    ],
  • "CurrentPage": 0
}

Gets the paging informations for a changed entry lines list.

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

The dossier identifier

query Parameters
startDate
required
string <date-time>

The start date with the following format : yyyy-MM-dd

endDate
required
string <date-time>

The end date with the following format : yyyy-MM-dd

changedAfter
required
string <date-time>

The date after which the entry lines changed, with the following format : yyyy-MM-dd

accountNumber
string

(optional) An account number to filter counted entry lines

Responses

Response samples

Content type
application/json
{
  • "TotalLinesCount": 0,
  • "TotalPagesCount": 0
}

PublicV1Journals

Gets the list of all journals for a given dossierId

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PublicV1Letterings

Create multiple lettering

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
Request Body schema:
required
Array of objects (CreateLetteringCommand_V1)

Responses

Request samples

Content type
{
  • "CreateLetterringCommands": [
    ]
}

Response samples

Content type
application/json
{
  • "CreatedLetterings": [
    ]
}

Delete multiple lettering

Authorizations:
oauth2
path Parameters
dossierId
required
integer <int32>
Request Body schema:
LetteringIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "LetteringIds": [
    ]
}

QuantityMapping

Retrieve quantity mappings for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve quantity mappings for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
Request Body schema:
required
required
Array of objects (CreateQuantityMappingCommand)

Responses

Request samples

Content type
{
  • "Mappings": [
    ]
}

Update quantity mappings for this operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
operationId
required
integer <int32>
Request Body schema:
required
required
Array of objects (UpdateQuantityMappingDestinationCommand)

Responses

Request samples

Content type
{
  • "Mappings": [
    ]
}

Retrieve existing quantity mappings for this folder

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reconciliation

Get all reconciliation for an account of the enterprise during an exercise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of enterprise

query Parameters
accountId
integer <int32>

Id of Account

subAccountId
integer <int32>

Id of sub account

beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "ManualReconciliations": [
    ],
  • "AutomaticReconciliations": [
    ]
}

Get all reconciliation for a "dossier" during an period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of enterprise

query Parameters
beginDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the balance of an account for a date Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of the enterprise

subAccountId
required
integer <int32>

Id of the sub account

query Parameters
accountId
integer <int32>
date
string <date-time>

Specify the balance date

Responses

Response samples

Content type
application/json
0
0

Get the balance of an account for a date (V2)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of the enterprise

query Parameters
Date
string <date-time>
AccountId
integer <int32>
SubAccountId
integer <int32>

Responses

Response samples

Content type
application/json
0
0

Get a specific reconciliation for an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of the enterprise

reconciliationId
required
integer <int32>

Id of the reconciliation

Responses

Response samples

Content type
application/json
{
  • "AccountDto": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Delete a specific reconciliation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of enterprise

reconciliationId
required
integer <int32>

Id of the reconciliation to delete

Responses

Update a specific reconciliation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of the enterprise

reconciliationId
required
integer <int32>

Id of the reconciliation to modify

Request Body schema:

Command containing all parameters to update the reconciliation

Deadline
required
string <date-time>
BankBalance
required
number <double>

Responses

Request samples

Content type
{
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0.1
}

Response samples

Content type
application/json
{
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Create a new reconciliation for an enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of enterprise

Request Body schema:

Command containing all parameters to create a reconciliation

Deadline
required
string <date-time>
BankBalance
required
number <double>
AccountId
integer <int32>
SubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0.1,
  • "AccountId": 0,
  • "SubAccountId": 0
}

Response samples

Content type
application/json
{
  • "AccountDto": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Upload a file for reconciliation Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
reconciliationId
required
integer <int32>
Request Body schema: multipart/form-data
Files
Array of strings or null <binary> [ items <binary > ]

Files to associate to the reconciliation

Responses

Response samples

Content type
application/json
{
  • "FileItems": [
    ],
  • "User": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Upload a file for reconciliation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
reconciliationId
required
integer <int32>
Request Body schema: multipart/form-data
File
string or null <binary>

File to associate to the reconciliation

Responses

Response samples

Content type
application/json
{
  • "FileItems": [
    ],
  • "User": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Upload a file for reconciliation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
reconciliationId
required
integer <int32>
fileId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "FileItems": [
    ],
  • "User": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Update the date of different lines to get a valid reconciliation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Id of the enterprise

reconciliationId
required
integer <int32>

Id of the reconciliation

Request Body schema:

An array containing all line Ids which needed to update theirs date

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
{
  • "FileItems": [
    ],
  • "User": {
    },
  • "Id": 0,
  • "Deadline": "2019-08-24T14:15:22Z",
  • "BankBalance": 0,
  • "AccountingBalance": 0,
  • "Gap": 0,
  • "Type": "Auto",
  • "Status": "HasError"
}

Set the reconciliation date if the two balance are equals

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
associationId
required
integer <int32>

Responses

Set the reconciliation date if the two balance are equals

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
sourceId
integer <int32>

Responses

ReferentialEnterprise

Get All Vat System for Fiscal Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get All Legal Form for General Information

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get Vat Deadline Day for Fiscal Information / Get Payroll Day for Social Infomation

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • 0
]

ReferentialGeneral

Get All Countries

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ReferentialGeneral_GetCountry

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "ISO2LetterCode": "st",
  • "ISO3LetterCode": "str",
  • "PhoneCode": 0,
  • "Name": "string",
  • "PhoneRegexs": "string",
  • "ZipCodeRegexs": "string",
  • "LanguagesIETFTag": "string",
  • "LanguageIRTFTagId": 0,
  • "LanguageIRTFTag": {
    },
  • "CurrencyId": 0,
  • "InEurope": true,
  • "Available": true
}

RelatedEstablishments

Get all related establishments of an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add or update an establishment relation between an accounting folder and a legal person

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
EstablishmentId
required
integer <int32>

Responses

Request samples

Content type
{
  • "EstablishmentId": 0
}

Remove an establishment relation between an accounting folder and a legal person

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
EstablishmentId
required
integer <int32>

Responses

Request samples

Content type
{
  • "EstablishmentId": 0
}

SendGrid

Receive send grid emails Deprecated

Authorizations:
oauth2

Responses

Situation

Get by Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "ExerciseId": 0,
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Open",
  • "IsClosed": true,
  • "IsProtected": true,
  • "IsImpactable": true
}

Delete situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

Validate create operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
ExerciseId
required
integer <int32>
EndDate
required
string <date-time>
object (CutOffRelation)

Responses

Request samples

Content type
{
  • "ExerciseId": 0,
  • "EndDate": "2019-08-24T14:15:22Z",
  • "WithCutOff": {
    }
}

Response samples

Content type
application/json
{
  • "CutOffEntryToGenerateCount": 0,
  • "CutOffEntryLineToGenerateCount": 0
}

Create a situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
ExerciseId
required
integer <int32>
EndDate
required
string <date-time>
object (CutOffRelation)

Responses

Request samples

Content type
{
  • "ExerciseId": 0,
  • "EndDate": "2019-08-24T14:15:22Z",
  • "WithCutOff": {
    }
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "ExerciseId": 0,
  • "EndDate": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": "Open",
  • "IsClosed": true,
  • "IsProtected": true,
  • "IsImpactable": true
}

Protect a situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

Unprotect a situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

Validate close operation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>
Request Body schema:
required
GenerateAn
boolean

Responses

Request samples

Content type
{
  • "GenerateAn": true
}

Response samples

Content type
application/json
{
  • "RevisionErrors": [
    ],
  • "EntriesHaveDocRefErrors": [
    ],
  • "EntriesHaveBeenReviewedErrors": [
    ],
  • "SuspenseAccountErrors": [
    ],
  • "AnGenerationErrors": [
    ],
  • "PreviousAnErrors": [
    ],
  • "GeneralErrors": [
    ]
}

Close situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>
Request Body schema:
required
GenerateAn
boolean
ValidateOnly
required
boolean
Deprecated

Responses

Request samples

Content type
{
  • "GenerateAn": true,
  • "ValidateOnly": true
}

Validate situation

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

Move the situation to the next step (eg: isClosing to closed)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>
query Parameters
expectedState
required
string
Enum: "Open" "Protected" "Closed" "Closing" "Validating" "Protecting" "ClosePending" "ValidationPending" "ProtectionPending" "ClosingFromImport" "ClosePendingFromImport" "ClosedFromImport"

Responses

Response samples

Content type
application/json
true

FNF203 : Unclose situation ONLY ADMIN

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>

Responses

FNF203 : Unclose and unprotect all situations (delete ALL intermediate AN, remove validation for entries of these situations) ONLY ADMIN

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Migrate all exercises eligible to the migration (until lastExerciseId if value is defined)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID.

Request Body schema:

Defines (or not) up to which exercise run the migration.

integer <int32>

Responses

Request samples

Content type
0
0

Response samples

Content type
application/json
[
  • {
    }
]

Rollback situation status to protected

Authorizations:
oauth2

Responses

Revert status without change / event

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
situationId
required
integer <int32>
query Parameters
status
required
string
Enum: "Open" "Protected" "Closed" "Closing" "Validating" "Protecting" "ClosePending" "ValidationPending" "ProtectionPending" "ClosingFromImport" "ClosePendingFromImport" "ClosedFromImport"

Responses

Stakeholders

Get legal representative person of accounting folder. Used in frontend in edition mode. Grants access to company collaborators.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "PersonId": 0,
  • "Name": "string",
  • "PersonType": "LegalPerson",
  • "LastModification": {
    },
  • "LogoUrl": "string",
  • "Email": "string",
  • "StakeholderType": "AuditorOfAccountsTitular"
}

Get legal representative person of accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
companyId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "PersonId": 0,
  • "Name": "string",
  • "PersonType": "LegalPerson",
  • "LastModification": {
    },
  • "LogoUrl": "string",
  • "Email": "string",
  • "StakeholderType": "AuditorOfAccountsTitular"
}

Create stakeholder relation with a legal person

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>
Request Body schema:
required
LegalPersonId
integer <int32>
NaturalPersonId
integer <int32>
StakeholderType
required
string
Enum: "AuditorOfAccountsTitular" "AuditorOfAccountsSubstitute" "PropertyAdministrator" "CorporateOfficer" "ProfessionalAccountant" "Advisor" "TaxReporter" "LegalRepresentative"

Responses

Request samples

Content type
{
  • "LegalPersonId": 0,
  • "NaturalPersonId": 0,
  • "StakeholderType": "AuditorOfAccountsTitular"
}

Delete stakeholder relation with an accounting folder

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>
Request Body schema:
required
LegalPersonId
integer <int32>
NaturalPersonId
integer <int32>
StakeholderType
required
string
Enum: "AuditorOfAccountsTitular" "AuditorOfAccountsSubstitute" "PropertyAdministrator" "CorporateOfficer" "ProfessionalAccountant" "Advisor" "TaxReporter" "LegalRepresentative"

Responses

Request samples

Content type
{
  • "LegalPersonId": 0,
  • "NaturalPersonId": 0,
  • "StakeholderType": "AuditorOfAccountsTitular"
}

Stock

Get token

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Get stock url

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Create entries

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
0
0

Store documents

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
0
0

Get plan comptable

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CodeAgc": "string",
  • "LignesPlanCompta": [
    ]
}

Get activités agence

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "CodeAgc": "string",
  • "LignesActivites": [
    ]
}

Send ledger

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "LignesGrandLivre": [
    ]
}

Assign to Farmeo agency

Authorizations:
oauth2
Request Body schema:
required
Name
required
string or null
CompanyGroupId
integer <int32>
CompanyId
integer <int32>
AccountingFolderId
integer <int32>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "CompanyGroupId": 0,
  • "CompanyId": 0,
  • "AccountingFolderId": 0
}

SubAccounts

Update sub accounts

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
required
Array of objects (UpdateSubAccountCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Update a sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
subAccountId
required
integer <int32>
Request Body schema:
required
Label
required
string non-empty
Impactable
boolean
IsAux
boolean
CentralizerId
integer <int32>
CentralizedSubAccountIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "Label": "string",
  • "Impactable": true,
  • "IsAux": true,
  • "CentralizerId": 0,
  • "CentralizedSubAccountIds": [
    ]
}

Response samples

Content type
application/json
{
  • "AccountId": 0,
  • "SubAccountId": 0,
  • "Account": 0,
  • "AccountClass": 0,
  • "AccountName": "string",
  • "AccountLabel": "string",
  • "AccountDescription": "string",
  • "Impactable": true,
  • "Dividable": true,
  • "Configurable": true,
  • "Optional": true,
  • "StatusByPeriod": [
    ],
  • "MappingAccount": 0,
  • "SubAccountLabel": "string",
  • "SubAccountCode": "string",
  • "IsAux": true,
  • "IsCentralizer": true,
  • "CentralizerId": 0,
  • "Divided": "None",
  • "ValidFrom": "2019-08-24T14:15:22Z",
  • "ValidTo": "2019-08-24T14:15:22Z",
  • "IsExtended": true,
  • "ArchivedAt": "2019-08-24T14:15:22Z",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "BookOperationId": 0
}

Delete an enterpise account (only sub accounts allowed)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
subAccountId
required
integer <int32>

Responses

Change label of a sub account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
subAccountId
required
integer <int32>
Request Body schema:
required
Label
required
string [ 1 .. 100 ] characters

Responses

Request samples

Content type
{
  • "Label": "string"
}

Change Sub Accounts Type (Sub/Aux)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
SubAccountIds
required
Array of integers <int32> [ items <int32 > ]
IsAux
required
boolean

Responses

Request samples

Content type
{
  • "SubAccountIds": [
    ],
  • "IsAux": true
}

Delete many account (only sub accounts allowed)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
SubAccountIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "SubAccountIds": [
    ]
}

Support

Move accounting folder from company to each other company and assign user

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
NewCompanyId
required
integer <int32>
AccountingFolderId
required
integer <int32>
UserId
required
integer <int32>

Responses

Request samples

Content type
{
  • "NewCompanyId": 0,
  • "AccountingFolderId": 0,
  • "UserId": 0
}

Move many accounting folders from company to each other company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
NewCompanyId
required
integer <int32>
AccountingFolderIds
required
Array of integers <int32> <= 10 items [ items <int32 > ]

Responses

Request samples

Content type
{
  • "NewCompanyId": 0,
  • "AccountingFolderIds": [
    ]
}

Prepare migration command for accounting folder and all its relations from company to other company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
destinationCompanyId
integer <int32>
accountingFolderId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "SourceAccountingFolder": {
    },
  • "MigrateLegalPersons": [
    ],
  • "MigrateNaturalPersons": [
    ],
  • "LegalPersons": {
    },
  • "NaturalPersons": {
    }
}

Move many legal persons and natural persons from company to other company

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema:
DestinationCompanyId
required
integer <int32>
required
Array of objects or null (MigrateLegalPersonCommand)
required
Array of objects or null (MigrateNaturalPersonCommand)

Responses

Request samples

Content type
{
  • "DestinationCompanyId": 0,
  • "MigrateLegalPersonCommands": [
    ],
  • "MigrateNaturalPersonCommands": [
    ]
}

Assign accounting folder to user in other company (Delegation)

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Original CompanyId

query Parameters
accountingFolderId
integer <int32>

Id of accounting folder to delegate

newCompanyId
integer <int32>

Id of Destination Company

userId
integer <int32>

User id in Company destination

Responses

Set account labels from FEC imports for an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
required
Array of objects (AddOverriddenAccountCommand)

Responses

Request samples

Content type
{
  • "Commands": [
    ]
}

Search the deleted accounting folders of a company, most recently deleted first, 50 at most

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
query Parameters
siren
string

Start of the SIREN

name
string

Part of the accounting folder name

Responses

Response samples

Content type
application/json
{
  • "Items": [
    ],
  • "IsTruncated": true
}

Restore a deleted accounting folder of a company, in the state mode it had when deleted

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
accountingFolderId
required
integer <int32>
Request Body schema:

Optional audit note

Note
string or null

Responses

Request samples

Content type
{
  • "Note": "string"
}

SupportingDocument

Get one supporting Document by Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
supportingDocumentId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "ThumbUrl": "string",
  • "FileName": "string",
  • "FileUrl": "string",
  • "Extension": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": "None",
  • "TypeDocument": "Administrative",
  • "Id": 0,
  • "TransactionEntryId": 0,
  • "FileId": 0,
  • "BookEntryId": 0,
  • "DocRef": "string"
}

UnAttach document before lettering

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
supportingDocumentId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Type": "string",
  • "Title": "string",
  • "Status": 0,
  • "Detail": "string",
  • "Instance": "string",
  • "property1": null,
  • "property2": null
}

Get Supporting Documents by transactionEntryId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

transactionEntryId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Supporting Documents by documentId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

documentId
required
integer <int32>

Responses

Get Supporting Documents Metadata

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
status
string
Enum: "None" "InProgress" "ToReview" "Optional" "Justified" "Lost" "Missing" "PartiallyJustified"
AmountGreaterThan
number <decimal>
AmountLesserThan
number <decimal>
Amount
number <decimal>
Label
string
StartDate
string <date-time>
EndDate
string <date-time>
Sort
string
Enum: "None" "Date" "Amount" "CounterPartyAccount"
Ascending
boolean
CounterPartyAccountId
integer <int32>
BankAccountId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Count": 0
}

Get Supporting Documents

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
page
integer <int32>
size
integer <int32>
status
string
Enum: "None" "InProgress" "ToReview" "Optional" "Justified" "Lost" "Missing" "PartiallyJustified"
AmountGreaterThan
number <decimal>
AmountLesserThan
number <decimal>
Amount
number <decimal>
Label
string
StartDate
string <date-time>
EndDate
string <date-time>
Sort
string
Enum: "None" "Date" "Amount" "CounterPartyAccount"
Ascending
boolean
CounterPartyAccountId
integer <int32>
BankAccountId
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add supportingDocument by azure function

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
TransactionEntryLineId
required
integer <int64>
DocumentEntryId
required
integer <int32>
LetterId
required
integer <int32>

Responses

Request samples

Content type
{
  • "TransactionEntryLineId": 0,
  • "DocumentEntryId": 0,
  • "LetterId": 0
}

Response samples

Content type
application/json
0
0

update supportingDocument when lettering

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
SupportingDocumentId
required
integer <int32>
DocumentEntryId
required
integer <int32>
LetterId
required
integer <int32>
DocRef
string or null
FileId
integer <int32>

Responses

Request samples

Content type
{
  • "SupportingDocumentId": 0,
  • "DocumentEntryId": 0,
  • "LetterId": 0,
  • "DocRef": "string",
  • "FileId": 0
}

Get Supporting Documents .xlsx export

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Enterprise Id

query Parameters
status
string
Enum: "None" "InProgress" "ToReview" "Optional" "Justified" "Lost" "Missing" "PartiallyJustified"
AmountGreaterThan
number <decimal>
AmountLesserThan
number <decimal>
Amount
number <decimal>
Label
string
StartDate
string <date-time>
EndDate
string <date-time>
Sort
string
Enum: "None" "Date" "Amount" "CounterPartyAccount"
Ascending
boolean
CounterPartyAccountId
integer <int32>
BankAccountId
integer <int32>

Responses

Response samples

Content type
application/json
"string"

Upload document with transaction id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema: multipart/form-data
File
required
string <binary>
TransactionEntryId
integer or null <int64>
Type
string or null
Enum: "Administrative" "Client" "Supplier" "ExpenseReport" "Bank" "Others" "TicketAttachment" "RevisionAttachment" "ImportData" "FecExport" "Sellsy" "None"

Responses

Response samples

Content type
application/json
0
0

delete by letterId

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
letterId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • 0
]

Get optional account list

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add account to optional list

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EnterpriseId
required
integer <int32>
AccountId
required
integer <int32>
SubAccountId
integer <int32>

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "AccountId": 0,
  • "SubAccountId": 0
}

Response samples

Content type
application/json
0
0

Remove account from optional list

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
spdOptionalAccountId
required
integer <int32>

Responses

Get client access

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

Give access to Client

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Remove access to Client

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Theme

Retrieves all themes with their assignations to companies, company groups and accounting folders. Deprecated

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new theme.

Authorizations:
oauth2
Request Body schema:

The command containing the color palette (Brand50..Brand950) and the logo URL.

Name
required
string or null
Brand50
required
string or null
Brand100
required
string or null
Brand200
required
string or null
Brand300
required
string or null
Brand400
required
string or null
Brand500
required
string or null
Brand600
required
string or null
Brand700
required
string or null
Brand800
required
string or null
Brand900
required
string or null
Brand950
required
string or null
LogoUrl
required
string or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Brand50": "string",
  • "Brand100": "string",
  • "Brand200": "string",
  • "Brand300": "string",
  • "Brand400": "string",
  • "Brand500": "string",
  • "Brand600": "string",
  • "Brand700": "string",
  • "Brand800": "string",
  • "Brand900": "string",
  • "Brand950": "string",
  • "LogoUrl": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Brand50": "string",
  • "Brand100": "string",
  • "Brand200": "string",
  • "Brand300": "string",
  • "Brand400": "string",
  • "Brand500": "string",
  • "Brand600": "string",
  • "Brand700": "string",
  • "Brand800": "string",
  • "Brand900": "string",
  • "Brand950": "string",
  • "LogoUrl": "string"
}

Retrieves all themes

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a theme by its unique identifier.

Authorizations:
oauth2
path Parameters
themeId
required
integer <int32>

The unique identifier of the theme to retrieve.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Brand50": "string",
  • "Brand100": "string",
  • "Brand200": "string",
  • "Brand300": "string",
  • "Brand400": "string",
  • "Brand500": "string",
  • "Brand600": "string",
  • "Brand700": "string",
  • "Brand800": "string",
  • "Brand900": "string",
  • "Brand950": "string",
  • "LogoUrl": "string"
}

Updates an existing theme.

Authorizations:
oauth2
path Parameters
themeId
required
integer <int32>

The unique identifier of the theme to update.

Request Body schema:

The command containing the updated color palette and logo URL.

Name
required
string or null
Brand50
required
string or null
Brand100
required
string or null
Brand200
required
string or null
Brand300
required
string or null
Brand400
required
string or null
Brand500
required
string or null
Brand600
required
string or null
Brand700
required
string or null
Brand800
required
string or null
Brand900
required
string or null
Brand950
required
string or null
LogoUrl
required
string or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "Brand50": "string",
  • "Brand100": "string",
  • "Brand200": "string",
  • "Brand300": "string",
  • "Brand400": "string",
  • "Brand500": "string",
  • "Brand600": "string",
  • "Brand700": "string",
  • "Brand800": "string",
  • "Brand900": "string",
  • "Brand950": "string",
  • "LogoUrl": "string"
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Name": "string",
  • "Brand50": "string",
  • "Brand100": "string",
  • "Brand200": "string",
  • "Brand300": "string",
  • "Brand400": "string",
  • "Brand500": "string",
  • "Brand600": "string",
  • "Brand700": "string",
  • "Brand800": "string",
  • "Brand900": "string",
  • "Brand950": "string",
  • "LogoUrl": "string"
}

Assigns a theme to a company, or removes the existing assignment when no theme is provided.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The unique identifier of the company to which the theme will be assigned.

query Parameters
themeId
integer <int32>

The unique identifier of the theme to assign, or null to remove the existing assignment.

Responses

Assigns a theme to a company group, or removes the existing assignment when no theme is provided.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

The unique identifier of the company group to which the theme will be assigned.

query Parameters
themeId
integer <int32>

The unique identifier of the theme to assign, or null to remove the existing assignment.

Responses

Ticket

Get all tickets of enterprise Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
status
string
Default: "All"
Enum: "All" "NewTicket" "InProgressTicket" "ClosedTicket"

All = 0, NewTicket = 1, InProgressTicket = 2, ClosedTicket = 3

size
integer <int32>
Default: 3

default 3 tickets in a page

page
integer <int32>

null: get all

text
string

null: get all

Responses

Response samples

Content type
application/json
{
  • "Page": 0,
  • "Size": 0,
  • "Count": 0,
  • "Items": [
    ]
}

Get number of ticket for a given status. New = an answer is needed from you or one of your collaborators, InProgress = you or one of your collaborators has answered this ticket, Closed = closed Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
status
string
Default: "All"
Enum: "All" "NewTicket" "InProgressTicket" "ClosedTicket"

All = 0 or null, NewTicket = 1,InProgressTicket = 2,ClosedTicket = 3

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one ticket of enterprise Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
ticketId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AuditVersion": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "AuthorId": 0,
  • "Type": "CeoToChiefAccountant",
  • "Title": "string",
  • "Text": "string",
  • "Status": "All",
  • "TicketStatus": "Create",
  • "Comments": [
    ],
  • "TicketRate": 0,
  • "LastComment": {
    },
  • "CommentCount": 0,
  • "TicketParticipants": [
    ],
  • "IsUserSubscribedToNotifications": true,
  • "CanCloseOpen": true,
  • "AttachFiles": [
    ],
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z"
}

Get all comments of ticket Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
ticketId
required
integer <int32>
query Parameters
size
integer <int32>
Default: 3

default 3 tickets in a page

page
integer <int32>

null: get all

text
string

null: get all

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create comment Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
ticketId
required
integer <int32>
Request Body schema: multipart/form-data
Title
string or null
Text
string or null
EnterpriseIds
string or null
Type
required
string
Enum: "Response" "PrivateNote"
Files
Array of strings or null <binary> [ items <binary > ]
FileItemIds
string or null
UserIds
string or null

Responses

Response samples

Content type
application/json
{
  • "AuditVersion": 0,
  • "Id": 0,
  • "EnterpriseId": 0,
  • "TicketId": 0,
  • "AuthorEnterpriseId": 0,
  • "UserId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "UrlAvatar": "string",
  • "Type": "Response",
  • "Text": "string",
  • "AttachFiles": [
    ],
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Source": "WebApp"
}

Remove attachment Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
attachementId
required
integer <int32>

Responses

Response samples

Content type
application/json
true

InitTicketTypeConfigAsync Deprecated

Authorizations:
oauth2

Responses

InitTicketTypeConfigAsync Deprecated

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UserProfile

Get user profile information

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Email": "string",
  • "EmailConfirmed": true,
  • "PhoneNumber": "string",
  • "Gender": "Mrs",
  • "FirstName": "string",
  • "LastName": "string",
  • "City": "string",
  • "Street": "string",
  • "ZipCode": "string",
  • "SocialSecurityNumber": "string",
  • "UrlAvatar": "string",
  • "TwoFactorEnabled": true,
  • "TwoFactorForced": true,
  • "ManagedAccount": true
}

Update user information

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
query Parameters
companyId
integer <int32>
Request Body schema: multipart/form-data
Logo
string or null <binary>
Gender
required
string
Enum: "Mrs" "Mr" "Ms" "None"
FirstName
required
string
LastName
required
string
Email
required
string <email>
Tel
string or null
Street
string or null
ZipCode
string or null
City
string or null
SocialSecurityNumber
string or null

Responses

Update user 2FA information

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
query Parameters
email
string
activation
boolean

Responses

Sends a link to confirm the current user's email address

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
header Parameters
Origin
string
Referer
string

Responses

UserProfile_SetUserProfileDefaultAvatar Deprecated

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
query Parameters
companyId
integer <int32>
Request Body schema:
required
FirstName
required
string non-empty

Responses

Request samples

Content type
{
  • "FirstName": "string"
}

UserRights

Check Policy Endpoint

Authorizations:
oauth2
query Parameters
actionResource
string
resourceName
string

Responses

Response samples

Content type
application/json
true

Users

Get token for an User of his Enterprise. Only admin can set a different UserId than its own

Authorizations:
oauth2
query Parameters
enterpriseId
integer <int32>
userId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "AccessToken": "string",
  • "IdentityToken": "string",
  • "TokenType": "string",
  • "RefreshToken": "string",
  • "ErrorDescription": "string",
  • "ExpiresIn": 0
}

Get claims from the current token for authenticated user.

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get static values of current user. Deprecated

Authorizations:
oauth2
query Parameters
userEmail
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get static values of current user.

Authorizations:
oauth2
query Parameters
userId
integer <int32>
enterpriseId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "ActifEnterpriseRoles": [
    ],
  • "AllRights": [
    ],
  • "AllRoles": [
    ],
  • "ActifEnterpriseRights": [
    ],
  • "CountryId": 0,
  • "CountryCode": "string",
  • "Id": 0,
  • "Email": "string",
  • "UserName": "string",
  • "PhoneNumber": "string",
  • "ActifEnterpriseId": 0,
  • "ActifEnterpriseName": "string",
  • "ActifEnterpriseType": "None",
  • "FolderId": 0,
  • "Gender": "Mrs",
  • "FirstName": "string",
  • "LastName": "string",
  • "FullName": "string",
  • "AvatarId": 0,
  • "UrlAvatar": "string",
  • "Activated": true,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "SocialSecurityNumber": "string",
  • "Street": "string",
  • "City": "string",
  • "ZipCode": "string",
  • "CreadtedAt": "2019-08-24T14:15:22Z",
  • "Affected": [
    ],
  • "TermsOfUseValidationDate": "2019-08-24T14:15:22Z"
}

Get all roles

Authorizations:
oauth2
query Parameters
type
string
Enum: "Admin" "Accounting" "Client" "ExternalService" "Fred" "Pme"
isHideRoles
boolean
Default: true

hide roles: J, G, F, SD, LR

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the personal information for a user by userId.

La Fred.Infrastructure.WebApi.Authorization.FredPolicyAttribute ne borne rien ici : UserInfo/read est accordé en base à quasiment tous les rôles seedés, y compris E (employé) et EXP (provider externe). L'autorisation réelle et la minimisation du payload sont portées par GetUserPersonalInfosQueryHandler (WI 69171 / ADR 0021).

Authorizations:
oauth2
query Parameters
userId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Email": "string",
  • "UserName": "string",
  • "PhoneNumber": "string",
  • "ActifEnterpriseId": 0,
  • "ActifEnterpriseName": "string",
  • "ActifEnterpriseType": "None",
  • "FolderId": 0,
  • "Gender": "Mrs",
  • "FirstName": "string",
  • "LastName": "string",
  • "FullName": "string",
  • "City": "string",
  • "Street": "string",
  • "ZipCode": "string",
  • "SocialSecurityNumber": "string",
  • "AvatarId": 0,
  • "UrlAvatar": "string",
  • "Activated": true,
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "CreadtedAt": "2019-08-24T14:15:22Z",
  • "TwoFactorEnabled": true,
  • "Affected": [
    ]
}

Changes the password for the current user.

Authorizations:
oauth2
Request Body schema:
CurrentPassword
string or null
NewPassword
string or null

Responses

Request samples

Content type
{
  • "CurrentPassword": "string",
  • "NewPassword": "string"
}

Get User by its Id

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "Email": "string",
  • "EmailConfirmed": true,
  • "PasswordHash": "string",
  • "SecurityStamp": "string",
  • "PhoneNumber": "string",
  • "PhoneNumberConfirmed": true,
  • "TwoFactorEnabled": true,
  • "ForceTwoFactorEnabled": true,
  • "UserType": "None",
  • "LockoutEndDateUtc": "2019-08-24T14:15:22Z",
  • "LockoutEnabled": true,
  • "AccessFailedCount": 0,
  • "Roles": [
    ],
  • "Claims": [
    ],
  • "Logins": [
    ],
  • "Id": 0,
  • "UserName": "string",
  • "Gender": "Mrs",
  • "ActifEnterpriseId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "UrlAvatar": "string",
  • "AvatarId": 0,
  • "Street": "string",
  • "Complement": "string",
  • "ZipCode": "string",
  • "City": "string",
  • "SocialSecurityNumber": "string",
  • "ActivationToken": "string",
  • "Activated": true,
  • "ActivatedAt": "2019-08-24T14:15:22Z",
  • "DeactivatedAt": "2019-08-24T14:15:22Z",
  • "ResetPasswordToken": "string",
  • "Rights": [
    ],
  • "SendGridContactId": "string",
  • "DeletedAt": "2019-08-24T14:15:22Z",
  • "IsFrench": true,
  • "HasCustomAvatar": true,
  • "BirthCountryCodeId": 0,
  • "BirthZipCode": "string",
  • "BirthCity": "string",
  • "ResidencePermitNumber": "string",
  • "ValidateResidencePermitDate": "2019-08-24T14:15:22Z",
  • "FamillySituation": "None",
  • "BirthDay": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "LastConnectionDate": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0,
  • "TermsOfUseValidationDate": "2019-08-24T14:15:22Z"
}

Returns the list of cabinets/companies to which user is assigned

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the list of dossiers for which user has access

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • 0
]

Users_GetAllUserRole

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users_GetUserRolesByEnterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a role to a user within an enterprise (admin-only legacy route).

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
enterpriseId
required
integer <int32>
query Parameters
cabinetId
integer <int32>
roleName
string
typeRelation
string
Enum: "Interne" "Externe" "Owner"

Responses

Response samples

Content type
application/json
{
  • "UserId": 0,
  • "RoleId": 0,
  • "Id": 0,
  • "CabinetId": 0,
  • "EnterpriseId": 0,
  • "TypeRelation": "Interne",
  • "User": {
    },
  • "Role": {
    },
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "UpdateByUserId": 0
}

Users_RemoveUserRoleInterneByEnterprise

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>
enterpriseId
required
integer <int32>
query Parameters
roleName
string

Responses

Create Tagger account

Authorizations:
oauth2
query Parameters
email
string
firstName
string
lastName
string

Responses

Validate acceptation of terms of use for a user

Authorizations:
oauth2
path Parameters
userId
required
integer <int32>

Responses

Supprime les avatars par défaut des utilisateurs. En mode dry-run (défaut), liste les correspondances sans effectuer de modification.

Cette opération nettoie deux catégories de liens avatar : Avatar reconnu par contenu : le blob est téléchargé, son hash correspond à un avatar généré par défaut — UrlAvatar est vidé et le blob est supprimé. Lien dangling (blob absent, HTTP 404) : UrlAvatar est vidé sans suppression blob, indépendamment de l'origine de l'avatar (défaut ou personnalisé). C'est intentionnel : un lien pointant vers un blob inexistant est cassé ; vider l'URL rétablit le fallback initiales. Le paramètre dryRun expose MissingBlobUserIds pour inspecter ces cas avant d'appliquer.

Authorizations:
oauth2
query Parameters
dryRun
boolean
Default: true

Si true (défaut), aucune modification n'est effectuée.

maxUsers
integer <int32>
Default: 500

Plafond du batch de candidats à analyser (défaut : 500, borné à [1, 5000] ; une valeur supérieure à 5000 est ramenée à 5000). L'endpoint ne pagine pas via curseur : pour traiter un volume supérieur, relancer l'endpoint successivement jusqu'à ce que MatchedCount soit nul.

Responses

Response samples

Content type
application/json
{
  • "DryRun": true,
  • "ScannedCount": 0,
  • "MatchedCount": 0,
  • "CleanedCount": 0,
  • "BlobDeletedCount": 0,
  • "MatchedUserIds": [
    ],
  • "MissingBlobCount": 0,
  • "MissingBlobUserIds": [
    ],
  • "CustomAvatarMarkedCount": 0
}

Promeut un utilisateur au rôle Admin global. Opération réservée aux super-admins (IsFredAdmin). Idempotente si l'utilisateur est déjà Admin.

L'email doit appartenir strictement au domaine @inqom.com (pas de sous-domaine). Les utilisateurs SYSTEM ne peuvent pas être promus (400).

Authorizations:
oauth2
Request Body schema:
Email
string or null

Responses

Request samples

Content type
{
  • "Email": "string"
}

UsersProvider

Rôles (avec TypeRelation) des utilisateurs demandés sur un dossier comptable. Miroir exact de M:Fred.Enterprises.UsersProvider.IUserProvider.GetUsersWithRoleAsync(System.Int32,System.Collections.Generic.List{System.Int32},Fred.Enterprises.Domain.Authorization.MembershipScope,System.Threading.CancellationToken). Node only: the cascade is served to in-process callers, never to this public contract.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
userIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rôles (avec TypeRelation) d'un utilisateur à l'échelle d'une company (cabinet). Miroir exact de M:Fred.Enterprises.UsersProvider.IUserProvider.GetUsersCompanyRoleAsync(System.Int32,System.Int32,System.Threading.CancellationToken).

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VatDeclarableEntries

Get the purchase invoices with their lettered invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EndOfDeclarationPeriod
required
string <date-time>
Array of objects or null (SupplierAccount)
VatOdsIdsInDeclarationPeriod
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "OnReceiptsSuppliersAccounts": [
    ],
  • "VatOdsIdsInDeclarationPeriod": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the sale invoices with their lettered invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
endOfDeclarationPeriod
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the on-debit sale invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the on-receipt sale invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the purchase invoices when supplier is due on debits and date is between the start of the exercise and the end of declaration

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]
Array of objects or null (SupplierAccount)
Array of objects or null (SupplierAccount)

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ],
  • "OnDebitsSuppliersAccounts": [
    ],
  • "OnReceiptsSuppliersAccounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the on-receipt purchase invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]
Array of objects or null (SupplierAccount)

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ],
  • "OnReceiptsSuppliersAccounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the categorisation entries for VAT to refund

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the categorisation entries for VAT to regularize

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>
VatOdsIdsInDeclarationPeriod
required
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z",
  • "VatOdsIdsInDeclarationPeriod": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the categorisation entries for VAT to report

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required

query parameters

EndOfDeclarationPeriod
required
string <date-time>

Responses

Request samples

Content type
{
  • "EndOfDeclarationPeriod": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Corrections : écritures à ventiler pour la Validation du cadrage

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
endOfDeclarationPeriod
required
string <date-time>

date de fin de la période de déclaration

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the entries with a deductible vat account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
endOfDeclarationPeriod
required
string <date-time>

date de fin de la période de déclaration

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the entries with a collected vat account

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
endOfDeclarationPeriod
required
string <date-time>

date de fin de la période de déclaration

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WhiteLabel

Creates a new white label.

Authorizations:
oauth2
Request Body schema:

The command object containing the details needed to create the white label, such as logo URL, portal domain, main color, footer text, and help center link.

PlatformName
required
string or null
LogoUrl
required
string or null
FaviconUrl
required
string or null
PortalDomain
string or null
MainColor
string or null
FooterText
string or null
HelpCenterLink
string or null
MailingFromName
string or null
MailingFromEmail
string or null
Deprecated
Note
string or null
TextColor
string or null
InboundParseDomain
string or null
CollaboratorHelpCenterLink
string or null
EndClientHelpCenterLink
string or null
ThemeId
integer <int32>
IsAutonomous
required
boolean
TermsOfUseUrl
string or null
Array of objects or null (SenderAddressInput)
object (MailSenderInput)
InqomTutorialEnabled
required
boolean

Responses

Request samples

Content type
{
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "Note": "string",
  • "TextColor": "string",
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "IsAutonomous": true,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailSender": {
    },
  • "InqomTutorialEnabled": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Retrieves a list of white labels.

Authorizations:
oauth2
query Parameters
all
boolean
Default: false

Get all white labels, including inactive ones, if set to true.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an existing white label configuration for the specified white label ID.

Authorizations:
oauth2
path Parameters
whiteLabelId
required
integer <int32>

The unique identifier of the white label to be updated.

Request Body schema:

The command object containing the updated details for the white label, such as logo URL, portal domain, main color, footer text, and help center link.

WhiteLabelId
required
integer <int32>
PlatformName
required
string or null
LogoUrl
required
string or null
FaviconUrl
required
string or null
PortalDomain
string or null
MainColor
string or null
FooterText
string or null
HelpCenterLink
string or null
MailingFromName
string or null
MailingFromEmail
string or null
Deprecated
Note
string or null
TextColor
string or null
InboundParseDomain
string or null
CollaboratorHelpCenterLink
string or null
EndClientHelpCenterLink
string or null
ThemeId
integer <int32>
IsAutonomous
required
boolean
TermsOfUseUrl
string or null
Array of objects or null (SenderAddressInput)
object (MailSenderInput)
InqomTutorialEnabled
boolean

Responses

Request samples

Content type
{
  • "WhiteLabelId": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "Note": "string",
  • "TextColor": "string",
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "IsAutonomous": true,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailSender": {
    },
  • "InqomTutorialEnabled": true
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Deletes an existing white label identified by its unique identifier.

Authorizations:
oauth2
path Parameters
whiteLabelId
required
integer <int32>

The unique identifier of the white label to be deleted.

Responses

Retrieves information about a specific white label using its unique identifier.

Authorizations:
oauth2
path Parameters
whiteLabelId
required
integer <int32>

The unique identifier of the white label to retrieve.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Assigns a white label to a company group, or removes the existing assignment when no white label is provided.

Authorizations:
oauth2
path Parameters
companyGroupId
required
integer <int32>

The unique identifier of the company group to which the white label will be assigned.

query Parameters
whiteLabelId
integer <int32>

The unique identifier of the white label to assign, or null to remove the existing assignment.

Responses

Assigns a white label to a company, or removes the existing assignment when no white label is provided.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The unique identifier of the company to which the white label will be assigned.

query Parameters
whiteLabelId
integer <int32>

The unique identifier of the white label to assign, or null to remove the existing assignment.

Responses

Assigns a white label to a list of accounting folders, or removes the existing assignment when no white label is provided.

Authorizations:
oauth2
query Parameters
whiteLabelId
integer <int32>

The unique identifier of the white label to assign, or null to remove the existing assignment.

Request Body schema:
required

The list of accounting folder identifiers to which the white label will be assigned.

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Activates or deactivates a white label identified by its unique identifier.

Authorizations:
oauth2
path Parameters
whiteLabelId
required
integer <int32>

The unique identifier of the white label.

isActive
required
boolean

Whether to activate or deactivate the white label.

Responses

Sets or unsets a white label as the default.

Authorizations:
oauth2
path Parameters
whiteLabelId
required
integer <int32>

The unique identifier of the white label.

isDefault
required
boolean

Whether to set or unset this white label as the default.

Responses

Retrieves the white label information associated with the specified accounting folder.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The unique identifier of the accounting folder for which the white label information is being requested.

query Parameters
onlyAssignedOnAccountingFolder
boolean
Default: false

When true, only returns the white label directly assigned to the accounting folder, without fallback to the cabinet or company group.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Retrieves the white label of several accounting folders in a single call.

Authorizations:
oauth2
Request Body schema:
required

The accounting folder identifiers, at most 200.

Array (<= 200 items)
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
{
  • "AccountingFolders": [
    ],
  • "UnresolvedAccountingFolderIds": [
    ]
}

Retrieves the white label information associated with the specified company.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The unique identifier of the company for which the white label information is being requested.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Retrieves the white label information associated with the specified company. Deprecated

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

The unique identifier of the company for which the white label information is being requested.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "PlatformName": "string",
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "PortalDomain": "string",
  • "MainColor": "string",
  • "FooterText": "string",
  • "HelpCenterLink": "string",
  • "MailingFromName": "string",
  • "MailingFromEmail": "string",
  • "IsActive": true,
  • "IsDefault": true,
  • "Note": "string",
  • "TextColor": "string",
  • "IsAutonomous": true,
  • "InboundParseDomain": "string",
  • "CollaboratorHelpCenterLink": "string",
  • "EndClientHelpCenterLink": "string",
  • "ThemeId": 0,
  • "TermsOfUseUrl": "string",
  • "SenderAddresses": [
    ],
  • "MailDomain": "string",
  • "DefaultSenderLocalPart": "string",
  • "InqomTutorialEnabled": true
}

Get the white label information based on the host from the request headers.

Authorizations:
oauth2
header Parameters
Origin
string

The origin header from the request.

Referer
string

The referer header from the request.

Responses

Response samples

Content type
application/json
{
  • "Exists": true,
  • "LogoUrl": "string",
  • "FaviconUrl": "string",
  • "HelpCenterUrl": "string",
  • "Color": "string",
  • "TextColor": "string",
  • "PlatformName": "string",
  • "ThemeId": 0
}

Get all active white labels with their assignations to companies, company groups and accounting folders. This endpoint is used to retrieve the white label information that is currently active and its associations, which can be useful for displaying the correct branding and configuration in the application based on the user's context (e.g., company, company group, or accounting folder). The response includes a list of white labels along with their assignations, allowing the client to determine which white label should be applied for a given user or context. Deprecated

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]