API docs by Redocly

Fred CutOff Api (v1)

Download OpenAPI specification:

Fred.CutOff API

Fred.CutOff is the cut-off management API within the Fred financial ecosystem. It handles period-end cut-off calculations: CAP/PAR provisioning, CCA/PCA prepaid and accrued charges, comparison tables, exports, and accounting entry generation.

Authentication

All endpoints are secured with Azure Active Directory (Azure AD) / OAuth2.

To call any endpoint, obtain a Bearer token from Azure AD:

Authorization: Bearer <access_token>

The API uses custom Fred claim policies (FredPolicy) that enforce resource-level access control (Read / Write) on top of standard Azure AD authentication.

Key Resources

  • CutOff — Core cut-off operations: launch, status tracking, and accounting entry generation.
  • CAP/PAR — Charges constatées d'avance / Produits constatés d'avance provisioning.
  • CCA/PCA — Charges à payer / Produits à recevoir prepaid and accrued charges.
  • Comparison Tables — Period comparison tables for cut-off analysis.
  • Exports — Data export operations for cut-off results.

CapPar

Get the accounts that may be used to be set as primary Account according to the specified Cap/Par type

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
type
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"

Responses

Response samples

Content type
[
  • {
    }
]

Get the accounts that may be used to be set as vat Account according to the specified Cap/Par type

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
type
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"

Responses

Response samples

Content type
[
  • {
    }
]

Get the accounts that may be used to be set as third party Account according to the specified Cap/Par type

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
type
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"

Responses

Response samples

Content type
[
  • {
    }
]

Create a CarPar

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
object (AccountLightCommandModel)
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Label
string
ExcludingTaxesAmount
number <double>
VatAmount
number <double>
AccountingDate
string <date-time>
CancellationDate
string <date-time>
Type
required
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"
SourceId
string
SourceType
string
Enum: "None" "Loan" "Lease" "Entry"

Responses

Request samples

Content type
{
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "VatAccount": {
    },
  • "Label": "string",
  • "ExcludingTaxesAmount": 0.1,
  • "VatAmount": 0.1,
  • "AccountingDate": "2019-08-24T14:15:22Z",
  • "CancellationDate": "2019-08-24T14:15:22Z",
  • "Type": "FNP",
  • "SourceId": "string",
  • "SourceType": "None"
}

Response samples

Content type
0
0

Get CarPars

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
type
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"
periodBeginDate
string <date-time>
periodEndDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Create multiple CarPars

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array
object (AccountLightCommandModel)
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Label
string
ExcludingTaxesAmount
number <double>
VatAmount
number <double>
AccountingDate
string <date-time>
CancellationDate
string <date-time>
Type
required
string
Enum: "FNP" "FAE" "AAE" "AAR" "CAP" "PAR"
SourceId
string
SourceType
string
Enum: "None" "Loan" "Lease" "Entry"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • 0
]

Create a CarPar

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
object (AccountLightCommandModel)
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Label
string
ExcludingTaxesAmount
number <double>
VatAmount
number <double>
AccountingDate
string <date-time>
CancellationDate
string <date-time>
EntryId
required
integer <int32>
EntryLineId
required
integer <int64>
VatRate
required
number <decimal>

Responses

Request samples

Content type
{
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "VatAccount": {
    },
  • "Label": "string",
  • "ExcludingTaxesAmount": 0.1,
  • "VatAmount": 0.1,
  • "AccountingDate": "2019-08-24T14:15:22Z",
  • "CancellationDate": "2019-08-24T14:15:22Z",
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "VatRate": 0
}

Response samples

Content type
0
0

Update the specified CapPar

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cutOffId
required
integer <int32>
Request Body schema:
required
object (AccountLightCommandModel)
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Label
string
ExcludingTaxesAmount
number <double>
VatAmount
number <double>
AccountingDate
string <date-time>
CancellationDate
string <date-time>
EnterpriseId
required
integer <int32>
CutOffId
required
integer <int32>

Responses

Request samples

Content type
{
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "VatAccount": {
    },
  • "Label": "string",
  • "ExcludingTaxesAmount": 0.1,
  • "VatAmount": 0.1,
  • "AccountingDate": "2019-08-24T14:15:22Z",
  • "CancellationDate": "2019-08-24T14:15:22Z",
  • "EnterpriseId": 0,
  • "CutOffId": 0
}

Response samples

Content type
0
0

Delete the specified cut off

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

Responses

Delete cut off by ids

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

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "CutOffIds": [
    ]
}

Response samples

Content type
{
  • "RemovedCount": 0,
  • "CutOffNotRemoved": [
    ]
}

Get cut offs by source Id

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

Responses

Response samples

Content type
[
  • {
    }
]

Delete the cut offs by source id

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

Responses

Response samples

Content type
{
  • "RemovedCount": 0,
  • "CutOffNotRemoved": [
    ]
}

CcaPca

Get the specified CcaPca based on the entry line it's associated with

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryLineId
required
integer <int64>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "Label": "string",
  • "UpdatedByUserId": 0,
  • "HasValidatedEntry": true,
  • "Analytics": {
    },
  • "Date": "2019-08-24T14:15:22Z",
  • "Amount": 0,
  • "CcaPcaType": "CCA",
  • "ProrataType": "Temporis",
  • "ExploitationPeriod": {
    },
  • "IsValid": true,
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "ErrorMessage": "string",
  • "SourceId": "string",
  • "SourceType": "None"
}

Get CcaPcas

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
type
string
Enum: "CCA" "PCA"
periodBeginDate
string <date-time>
periodEndDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

CutOffCcaPca_GetReportTable

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

Responses

Response samples

Content type
[
  • {
    }
]

Create a CcaPca with a prorata temporis

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EnterpriseId
required
integer <int32>
EntryLineId
required
integer <int64>
EntryId
required
integer <int32>
SourceId
string
SourceType
string
Enum: "None" "Lease"
required
object (ExploitationPeriod)

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "EntryLineId": 0,
  • "EntryId": 0,
  • "SourceId": "string",
  • "SourceType": "None",
  • "ExploitationPeriod": {
    }
}

Response samples

Content type
0
0

Create a Cca with a prorata variable

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
EnterpriseId
required
integer <int32>
EntryLineId
required
integer <int64>
EntryId
required
integer <int32>
SourceId
string
SourceType
string
Enum: "None" "Lease"

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "EntryLineId": 0,
  • "EntryId": 0,
  • "SourceId": "string",
  • "SourceType": "None"
}

Response samples

Content type
0
0

Update a CcaPca with a prorata temporis

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cutOffId
required
integer <int32>
Request Body schema:
required
Id
required
integer <int32>
EnterpriseId
required
integer <int32>
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Amount
number <double>
Label
string
required
object (ExploitationPeriod)

Responses

Request samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "Amount": 0.1,
  • "Label": "string",
  • "ExploitationPeriod": {
    }
}

Update a Cca with a prorata variable

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
cutOffId
required
integer <int32>
Request Body schema:
required
Id
required
integer <int32>
EnterpriseId
required
integer <int32>
object (AccountLightCommandModel)
object (AccountLightCommandModel)
Amount
number <double>
Label
string
Array of objects (ReportTableRowCommand)

Responses

Request samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "Amount": 0.1,
  • "Label": "string",
  • "ReportPeriods": [
    ]
}

Response samples

Content type
0
0

Delete CCA/PCA

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

Responses

Response samples

Content type
0
0

Delete cut off by ids

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

Responses

Request samples

Content type
{
  • "EnterpriseId": 0,
  • "CutOffIds": [
    ]
}

Response samples

Content type
{
  • "RemovedCount": 0,
  • "CutOffNotRemoved": [
    ]
}

Get cut offs by source Id

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

Responses

Response samples

Content type
[
  • {
    }
]

Delete the cut offs by source id

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

Responses

Response samples

Content type
{
  • "RemovedCount": 0,
  • "CutOffNotRemoved": [
    ]
}

ComparisonTable

CutOffComparisonTable_GetVatAccountComparisonTable

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

Responses

Response samples

Content type
{
  • "Items": [
    ]
}

CutOffComparisonTable_GetThirdPartyAccountComparisonTable

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

Responses

Response samples

Content type
{
  • "Category": {
    }
}

CutOff

CutOffCutOff_GetCutOffById

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

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Account": {
    },
  • "ThirdPartyAccount": {
    },
  • "Label": "string",
  • "UpdatedByUserId": 0,
  • "HasValidatedEntry": true,
  • "Analytics": {
    }
}

Get the status (count, has error) for each category

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

Status will be relevant to the specified period

periodEndDate
string <date-time>

Status will be relevant to the specified period

Responses

Response samples

Content type
{
  • "FNP": {
    },
  • "AAR": {
    },
  • "FAE": {
    },
  • "AAE": {
    },
  • "CAP": {
    },
  • "PAR": {
    },
  • "CCA": {
    },
  • "PCA": {
    }
}

Get the status (count, has error) for the specified category

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
requestedCategory
required
string
Enum: "FNP" "AAR" "FAE" "AAE" "CAP" "PAR" "CCA" "PCA"

FNP,AAR,FAE,AAE,CAP,PAR,CCA,PCA

query Parameters
periodBeginDate
string <date-time>

Status will be relevant to the specified period

periodEndDate
string <date-time>

Status will be relevant to the specified period

Responses

Response samples

Content type
{
  • "HasError": true,
  • "Count": 0
}

Returns a list of cut off for a specified category and period

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
requestedCategory
required
string
Enum: "FNP" "AAR" "FAE" "AAE" "CAP" "PAR" "CCA" "PCA"

FNP,AAR,FAE,AAE,CAP,PAR,CCA,PCA

query Parameters
periodBeginDate
string <date-time>

List will be relevant to the specified period

periodEndDate
string <date-time>

List will be relevant to the specified period

Responses

Response samples

Content type
[
  • {
    }
]

Create entries for the specified Period and Journal

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

Responses

Request samples

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

Response samples

Content type
{
  • "EntryGeneratedCount": 0,
  • "EntryLineGeneratedCount": 0,
  • "EntryDeletedCount": 0,
  • "EntryLineDeletedCount": 0
}

Get entries for the specified Period and Journal

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

Responses

Response samples

Content type
{
  • "EntryGeneratedCount": 0,
  • "EntryLineGeneratedCount": 0,
  • "EntryDeletedCount": 0,
  • "EntryLineDeletedCount": 0,
  • "CreateEntryCommands": [
    ]
}

Returns the list of cutoffs with fiscal information for a specific period

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

List will be relevant to the specified period

periodEndDate
string <date-time>

List will be relevant to the specified period

Responses

Response samples

Content type
{
  • "CAP": [
    ],
  • "PAR": [
    ],
  • "CCA": [
    ],
  • "PCA": [
    ]
}

Exports

CutOffExports_ExportThirdPartyComparison

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
ExportType
required
string
Enum: "Pdf" "Html"

Responses

Request samples

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

Response samples

Content type
"string"

CutOffExports_ExportVatComparison

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
ExportType
required
string
Enum: "Pdf" "Html"

Responses

Request samples

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

Response samples

Content type
"string"

CutOffExports_ExportList

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
StartDate
required
string <date-time>
EndDate
required
string <date-time>
ExportType
required
string
Enum: "Pdf" "Html"

Responses

Request samples

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

Response samples

Content type
"string"