API docs by Redocly

Fred Lease Api (v1)

Download OpenAPI specification:

Fred.Lease API

Fred.Lease is the lease management API within the Fred financial ecosystem. It handles the full lifecycle of financial leases: creation, payment schedules, accounting entries, cut-offs, document attachments, and underlying asset management.

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

  • Leases — Core lease contracts with characteristics, payment schedules, and lifecycle management.
  • Accounting Entries — Booking and bulk generation of payment schedule entries.
  • Cut-offs — Period-end cut-off calculation and status tracking.
  • Underlying Assets — Vehicle and other asset management linked to leases.
  • Documents — PDF document attachments for leases (upload, download, delete).
  • Guarantees — Guarantee records associated with leases.

Accounting

Generate entries based on payment schedule for a lease

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Dossier Id

leaseId
required
integer <int32>

Id of the lease

query Parameters
effectiveDate
string or null <date-time>

Entries will be generated starting at this date. If null, effective date is equals to initial installment date.

Responses

Response samples

Content type
[
  • "string"
]

Generates payment schedule entries in bulk for all active leases of the specified enterprise. Use either (targetExerciseStartDate + targetExerciseEndDate) for date-range mode, or generateEntryForAllOpenExercises=true for all open exercises mode. The two modes are mutually exclusive.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise. Must not be the default value.

query Parameters
targetExerciseStartDate
string or null <date-time>

The start date of the exercise period (date-range mode only).

targetExerciseEndDate
string or null <date-time>

The end date of the exercise period (date-range mode only).

generateEntryForAllOpenExercises
boolean or null

When true, generates entries for all open exercises and enables auto-generation for new exercises.

disableAutoGeneration
boolean
Default: true

When false, prevents the flag from being disabled in target exercise mode. Used by the WebJob to preserve the auto-generation setting.

Responses

Response samples

Content type
{
  • "FailedLeases": [
    ]
}

Generates cut-off records for all leases of the specified enterprise as of the given effective date.

This operation processes all leases for the specified enterprise and generates cut-off records in strict mode. If no leases are found for the given effective date, the response will indicate no content. The returned list contains the purposes of the leases that had cut-offs generated.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise for which to generate lease cut-offs. Must not be the default value.

query Parameters
effectiveDate
string <date-time>

The date on which the cut-off should be effective. Only leases active as of this date are considered.

Responses

Response samples

Content type
[
  • "string"
]

Get the cut-off status for all leases of an enterprise at a specific date

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Dossier Id

query Parameters
effectiveDate
string <date-time>

Date to check the cut-off status

Responses

Response samples

Content type
{
  • "Leases": [
    ]
}

Get the parent accounts class for charge account. There is one class for each of the 4 possibility of the Fred.Lease.Domain.General.LeaseType / Fred.Lease.Domain.General.LeasedAssetType combo. <br></br><b>Warning</b> this endpoint <b>does not</b> returns all book accounts available, only the topmost parent code for each combo.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

AKA AccountingFolderId

Responses

Response samples

Content type
[
  • {
    }
]

Retrieves the accounts associated with a specific lease for the specified enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise to which the lease belongs. Must be a valid, existing enterprise ID.

leaseId
required
integer <int32>

The unique identifier of the lease whose accounts are to be retrieved. Must be a valid, existing lease ID within the specified enterprise.

Responses

Response samples

Content type
{
  • "LessorAccount": {
    },
  • "ChargeAccount": {
    },
  • "UnderlyingAccount": {
    },
  • "MaintenanceFeesAccount": {
    },
  • "IncidentalExpensesAccount": {
    },
  • "VatAccount": {
    },
  • "InsuranceAccount": {
    }
}

Updates the accounts associated with a specified lease for an enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise to which the lease belongs. Must be a valid, existing enterprise ID.

leaseId
required
integer <int32>

The unique identifier of the lease whose accounts are to be updated. Must refer to an existing lease within the specified enterprise.

Request Body schema:
required

An object containing the updated account information for the lease. Cannot be null.

required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)
required
object (UpdateLeaseAccountCommand)

Responses

Request samples

Content type
{
  • "LessorAccountCommand": {
    },
  • "ChargeAccountCommand": {
    },
  • "UnderlyingAccountCommand": {
    },
  • "MaintenanceFeesAccountCommand": {
    },
  • "IncidentalExpensesAccountCommand": {
    },
  • "VatAccountCommand": {
    },
  • "InsuranceAccountCommand": {
    }
}

Response samples

Content type
{
  • "LessorAccount": {
    },
  • "ChargeAccount": {
    },
  • "UnderlyingAccount": {
    },
  • "MaintenanceFeesAccount": {
    },
  • "IncidentalExpensesAccount": {
    },
  • "VatAccount": {
    },
  • "InsuranceAccount": {
    }
}

Retrieves the list of available lessor charge accounts for the specified enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise for which to retrieve available lessor charge accounts. Must not be the default value.

Responses

Response samples

Content type
[
  • {
    }
]

Deletes a sub-account identified by the specified sub-account ID within the given enterprise.

The caller must have the FredAdmin role and appropriate permissions to perform this operation.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise to which the sub-account belongs. This value must not be the default value.

subAccountId
required
integer <int32>

The unique identifier of the sub-account to delete. This value must not be the default value.

Request Body schema:
required

An object containing the details required to delete the sub-account. Must be provided in the request body.

AccountId
required
integer <int32>
SubAccountName
required
string

Responses

Request samples

Content type
{
  • "AccountId": 0,
  • "SubAccountName": "string"
}

Document

Get all documents associated with a specific lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
[
  • {
    }
]

Add a new document to a specific lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema: multipart/form-data
attachmentFile
string or null <binary>

The document file to be uploaded.

Responses

Response samples

Content type
0
0

Get a temporary public URL for a specific document.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

documentId
required
integer <int32>

The ID of the document.

Responses

Response samples

Content type
"string"

Delete a specific document from a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

documentId
required
integer <int32>

The ID of the document to be deleted.

Responses

Lease

Retrieves the general information for a lease identified by its ID within the specified enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise that owns the lease.

leaseId
required
integer <int32>

The unique identifier of the lease to retrieve. Must not be the default value.

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EnterpriseId": 0,
  • "LeasePurpose": "string",
  • "LeaseType": "string",
  • "LeaseAssetType": "string",
  • "HasValidChargeAccount": true
}

Updates the general information of an existing lease for the specified enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise to which the lease belongs.

leaseId
required
integer <int32>

The unique identifier of the lease to update. Must be a non-default, valid lease ID.

Request Body schema:
required

An object containing the updated general information for the lease. Cannot be null.

LeasePurpose
required
string
LeaseType
required
string
Enum: "Unknown" "LongTerm" "WithPurchaseOption"
LeasedAssetType
required
string
Enum: "Unknown" "Movable" "Immovable"

Responses

Request samples

Content type
{
  • "LeasePurpose": "string",
  • "LeaseType": "Unknown",
  • "LeasedAssetType": "Unknown"
}

Delete a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Delete all leases for enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

Responses

Retrieves a collection of leases for the specified enterprise, filtered by lease status and an optional date.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise for which to retrieve leases.

query Parameters
leaseStatus
string
Enum: "All" "Active" "Completed"

A filter specifying the lease status to include in the results.

filterDate
string or null <date-time>

An optional date used to filter leases. If not specified, the current date is used.

Responses

Response samples

Content type
[
  • {
    }
]

Create a new lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

Request Body schema:
required

The command containing the lease details to create.

LeasePurpose
required
string
required
object (AccountCommand)
required
object (AccountCommand)
LeaseType
required
string
Enum: "Unknown" "LongTerm" "WithPurchaseOption"
LeasedAssetType
required
string
Enum: "Unknown" "Movable" "Immovable"

Responses

Request samples

Content type
{
  • "LeasePurpose": "string",
  • "Lessor": {
    },
  • "Charge": {
    },
  • "LeaseType": "Unknown",
  • "LeasedAssetType": "Unknown"
}

Response samples

Content type
0
0

Get the characteristics of a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
{
  • "Financials": {
    },
  • "Dates": {
    },
  • "VAT": {
    },
  • "Insurance": {
    },
  • "Fees": {
    }
}

Update the characteristics of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the lease characteristics to update.

LeaseId
required
integer <int32>
EnterpriseId
required
integer <int32>
InstallmentAmount
required
number <decimal>
FirstInstallmentAmount
number or null <double>
IsFirstInstallmentSpread
required
boolean
LeaseDurationInMonths
required
integer <int32>
LeasePeriodicity
required
string
Enum: "Unknown" "Annual" "Biannually" "Quarterly" "Monthly"
InitialInstallmentDate
required
string <date-time>
InstallmentPaymentPeriod
required
string
Enum: "Unknown" "Start" "End"
OptionExerciseDate
string or null <date-time>
VATRate
required
number <decimal>
InsuranceRateType
required
string
Enum: "Unknown" "Fixed" "Variable" "None"
InsuranceRate
required
number <decimal>
InsuranceAmount
required
number <decimal>
MaintenanceFeesAmount
number or null <double>
StarterFeesAmount
number or null <double>

Responses

Request samples

Content type
{
  • "LeaseId": 0,
  • "EnterpriseId": 0,
  • "InstallmentAmount": 0,
  • "FirstInstallmentAmount": 0.1,
  • "IsFirstInstallmentSpread": true,
  • "LeaseDurationInMonths": 0,
  • "LeasePeriodicity": "Unknown",
  • "InitialInstallmentDate": "2019-08-24T14:15:22Z",
  • "InstallmentPaymentPeriod": "Unknown",
  • "OptionExerciseDate": "2019-08-24T14:15:22Z",
  • "VATRate": 0,
  • "InsuranceRateType": "Unknown",
  • "InsuranceRate": 0,
  • "InsuranceAmount": 0,
  • "MaintenanceFeesAmount": 0.1,
  • "StarterFeesAmount": 0.1
}

Get the guarantee details of a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
{
  • "SecurityRights": [
    ],
  • "BankGuarantees": [
    ],
  • "TotalAmount": 0
}

Update the guarantee details of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the guarantee details to update.

LeaseId
required
integer <int32>
EnterpriseId
required
integer <int32>
Array of objects or null (UpdateSecurityRight)
Array of objects or null (UpdateBankGuarantee)

Responses

Request samples

Content type
{
  • "LeaseId": 0,
  • "EnterpriseId": 0,
  • "SecurityRights": [
    ],
  • "BankGuarantees": [
    ]
}

Delete the guarantee details of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Get the underlying details of a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
{
  • "Type": "Unknown",
  • "SourceId": "string",
  • "TaxDeductibilityLimit": 0.1,
  • "OverAmortization": 0.1,
  • "AssetLifespanInMonths": 0,
  • "AssetValue": 0.1,
  • "ResidualAssetValue": 0.1
}

Update the underlying details of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the underlying details to update.

LeaseId
required
integer <int32>
EnterpriseId
required
integer <int32>
Type
required
string
Enum: "Unknown" "Vehicle" "Other"
SourceId
string or null
TaxDeductibilityLimit
number or null <double>
OverAmortization
number or null <double>
AssetLifespanInMonths
integer or null <int32>
AssetValue
required
number <decimal>
ResidualAssetValue
number or null <double>

Responses

Request samples

Content type
{
  • "LeaseId": 0,
  • "EnterpriseId": 0,
  • "Type": "Unknown",
  • "SourceId": "string",
  • "TaxDeductibilityLimit": 0.1,
  • "OverAmortization": 0.1,
  • "AssetLifespanInMonths": 0,
  • "AssetValue": 0,
  • "ResidualAssetValue": 0.1
}

Delete the underlying details of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Deny the option for a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Exercise the option for a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
0
0

Get the payment schedule for a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
{
  • "Periods": [
    ],
  • "EntrySynchronization": {
    },
  • "HasCustomPeriods": true
}

Get the events for a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
{
  • "RepaymentsDeferrals": [
    ]
}

Update the events for a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the events to update.

LeaseId
required
integer <int32>
EnterpriseId
required
integer <int32>
Array of objects or null (RepaymentDeferralModel)

Responses

Request samples

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

Simulate the events for a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the events to simulate.

LeaseId
required
integer <int32>
EnterpriseId
required
integer <int32>
Array of objects or null (RepaymentDeferralModel)

Responses

Request samples

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

Response samples

Content type
{
  • "Periods": [
    ],
  • "EntrySynchronization": {
    },
  • "HasCustomPeriods": true
}

Revert the last event for a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Get the history of a lease by its ID.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

Content type
[
  • {
    }
]

Add a new period to the payment schedule of a lease, inserted after the specified reference period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

referencePeriodId
required
integer <int32>

The zero-based index of the period after which the new period will be inserted.

Request Body schema:
required

The command containing the details for the new payment schedule period.

StartDate
required
string <date-time>
EndDate
required
string <date-time>
InstallmentAmount
required
number <decimal>
MaintenanceFeesAmount
required
number <decimal>
StarterFeesAmount
required
number <decimal>
InsuranceAmount
required
number <decimal>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "InstallmentAmount": 0,
  • "MaintenanceFeesAmount": 0,
  • "StarterFeesAmount": 0,
  • "InsuranceAmount": 0
}

Update a specific installment in the payment schedule of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

periodId
required
integer <int32>

The zero-based index of the period to update.

Request Body schema:
required

The command containing the new amounts for the installment.

StartDate
required
string <date-time>
EndDate
required
string <date-time>
InstallmentAmount
required
number <decimal>
MaintenanceFeesAmount
required
number <decimal>
StarterFeesAmount
required
number <decimal>
InsuranceAmount
required
number <decimal>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "InstallmentAmount": 0,
  • "MaintenanceFeesAmount": 0,
  • "StarterFeesAmount": 0,
  • "InsuranceAmount": 0
}

Delete a specific period from the payment schedule of a lease.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

leaseId
required
integer <int32>

The ID of the lease.

periodId
required
integer <int32>

The ID of the period to delete.

Responses

LeaseV2

Set the payment schedule for a specific lease.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

leaseId
required
integer <int32>

The ID of the lease.

Request Body schema:
required

The command containing the payment schedule details.

AccountingFolderId
required
integer <int32>
LeaseId
required
integer <int32>
object (PaymentScheduleV2)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "LeaseId": 0,
  • "PaymentSchedule": {
    }
}

Remove the payment schedule for a specific lease.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Import a payment schedule from a file for a specific lease.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

leaseId
required
integer <int32>

The ID of the lease.

query Parameters
provider
string
Value: "Inqom"

The provider for importing the payment schedule.

Request Body schema: multipart/form-data
attachmentFile
string or null <binary>

The file containing the payment schedule.

Responses

Export the payment schedule for a specific lease to a CSV file.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

leaseId
required
integer <int32>

The ID of the lease.

Responses

Response samples

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

Import leases from a file.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

query Parameters
provider
required
string
Value: "Agiris"

The provider for importing the leases.

Request Body schema: multipart/form-data
attachmentFile
required
string <binary>

The file containing the leases.

Responses

Import leases and payment schedule from a file.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The ID of the accounting folder.

query Parameters
provider
required
string
Enum: "Agiris" "Cegid"

The provider for importing the leases.

Request Body schema: multipart/form-data
attachmentFile
required
string <binary>

The file containing the leases.

Responses

Report

Generate a simulation report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

The start date of the report.

endDate
required
string <date-time>

The end date of the report.

leaseType
string
Default: "Unknown"
Enum: "Unknown" "LongTerm" "WithPurchaseOption"

The type of lease to filter by.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Generate a future installment report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

The start date of the report.

endDate
required
string <date-time>

The end date of the report.

leaseType
string
Default: "Unknown"
Enum: "Unknown" "LongTerm" "WithPurchaseOption"

The type of lease to filter by.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Generate an engagement report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

The start date of the report.

endDate
required
string <date-time>

The end date of the report.

leaseType
string
Default: "Unknown"
Enum: "Unknown" "LongTerm" "WithPurchaseOption"

The type of lease to filter by.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Generate a tax deductibility report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
string <date-time>

The start date of the report.

endDate
string <date-time>

The end date of the report.

leaseType
string
Default: "Unknown"
Enum: "Unknown" "LongTerm" "WithPurchaseOption"

The type of lease to filter by.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Generate an over-amortization report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
string <date-time>

The start date of the report.

endDate
string <date-time>

The end date of the report.

leaseType
string
Default: "Unknown"
Enum: "Unknown" "LongTerm" "WithPurchaseOption"

The type of lease to filter by.

Responses

Response samples

Content type
{
  • "Rows": [
    ],
  • "Total": {
    }
}

Generate a fiscal summary report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

The start date of the report.

endDate
required
string <date-time>

The end date of the report.

Responses

Response samples

Content type
{
  • "AssetsValueAmount": 0,
  • "MovableInstallmentsAmount": 0,
  • "ImmovableInstallmentsAmount": 0
}

Generate a forecast report for leases within a specified date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

The start date of the report.

endDate
required
string <date-time>

The end date of the report.

Responses

Response samples

Content type
{
  • "DotationYears": [
    ],
  • "Categories": [
    ],
  • "Total": {
    }
}

Exports the forecast table for a specific enterprise and period to a file

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise

query Parameters
exportType
required
string
Enum: "Html" "Pdf" "Csv" "Excel"

Type of export file (PDF by default)

startDate
required
string <date-time>

Start date of the period

endDate
required
string <date-time>

End date of the period

Responses

Response samples

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

Retrieves the forecast table section for a specified enterprise within a given date range.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The ID of the enterprise.

query Parameters
startDate
required
string <date-time>

Start date of the period.

endDate
required
string <date-time>

End date of the period.

Responses

Response samples

Content type
"string"