calculations
Operations addressed under /calculations — 10 operations.
get-accrual-calculation-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<AccrualCalculationDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccrualDate | DateOnly? | yes |
AccrualTransactionId | Guid? | yes |
AccrualCashFlowId | Guid? | yes |
PeriodAccruedAmount | decimal? | yes |
AccountingEntryProcessType | int? | yes |
AccountingEntryId | Guid? | yes |
ReversalAccountingEntryId | Guid? | yes |
DayCount | int? | yes |
AccrualProductFormulaId | Guid? | yes |
CalculationType | int? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-accrual-calculation-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountingEntryIdaccountingEntryProcessTypePermitted values — validated against the acc_entry_process_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Mass | no label seeded |
2 | Single | no label seeded |
accrualCashFlowIdaccrualDateaccrualProductFormulaIdaccrualTransactionIddayCountperiodAccruedAmountreversalAccountingEntryIdcalculate-accrual
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CalculateAccrualDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualCalculationPeriod | int | no |
Periods | List<PeriodItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_14 | 400 | FIELD_DATA_TYPE_NOT_VALID | Data type of the value given into field: {0} is not in correct format. It should be in {1} format. |
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_7 | 400 | ALL_ACCRUAL_PRODUCT_FIELDS_MUST_BE_PROVIDED | Fields are not fully provided for the given product. |
ERR_ACCRL_8 | 400 | PRODUCT_FIELD_IS_NOT_ACTIVE_OR_NOT_BELONG | Field is not active or not belong to the product. FieldId: {0} |
calculate-accrual › Request Body
accrualProductIdearlyPaymentDiscountRateeffectiveProfitRatematurityBeginDatematurityEndDatetransactionDatexirryearlyProfitRatecalculate-accrual › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
calculate-accrued-amount-by-accrual-product-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CalculateAccruedAmountByAccrualProductIdDto>.
| Field | Declared type | Nullable |
|---|---|---|
PreviousAccountingEntryId | Guid? | yes |
PreviousAccrualDate | DateOnly? | yes |
ReversePreviousAccountingEntry | bool | no |
CalculatedTransactions | List<CalculatedTransactionItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_6 | 400 | PRODUCT_ENTRY_TYPE_MUST_BE_MASS | It is not allowed to calculate accrual for products whose accounting entry process type is Single with mass calculation method. accrual Product: {0}. |
path Parameters
accrualProductIdcalculate-accrued-amount-by-accrual-product-id › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
previousAccountingEntryIdpreviousAccrualDatereversePreviousAccountingEntrycalculate-accrued-amount-by-accrual-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CalculateAccrualByAccrualTransactionIdDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualDate | DateOnly | no |
AccrualTransactionId | Guid | no |
AccrualCashFlowId | Guid | no |
AccrualProductType | int | no |
AccrualType | int | no |
AccountingEntryProcessType | int | no |
IsLastDay | bool | no |
TransactionProductLedgerCode | string | no |
TransactionOrganizationCode | string | no |
AccrualStatus | int | no |
CustomerAccountId | Guid? | yes |
IsEarlyClosure | bool | no |
IsEarlyPayment | bool | no |
IsForceRecalculate | bool | no |
PrincipalAmount | decimal | no |
ProfitAmount | decimal | no |
AccrualCalculations | List<AccrualCalculationByTransactionDto> (collection) | no |
AccountingEntriesToBeReversed | List<AccountingEntryToBeReversed> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_11 | 400 | MASS_ENTRY_TYPE_CANNOT_BE_SINGLE_TRANSACTION | It is not allowed to calculate accrual for products whose accounting entry process type is mass with single transaction calculation method. |
ERR_ACCRL_16 | 400 | CASH_FLOW_STATUS_NOT_VALID_FOR_CALCULATION | Cash flow {0} which covers the given accrual date is at {1} status. Accrual cannot be calculated. |
ERR_ACCRL_26 | 400 | TRANSACTION_ISEARLYPAYMENT_AND_ISEARLYCLOSURE_TRUE | not published in this snapshot |
ERR_ACCRL_29 | 400 | ACCRUED_AMOUNT_BYACCRUAL_TRANSACTION_CALCULATION_COULDNOT_MADE | Calculation could not made. {0} is not due date of the cash flow. |
path Parameters
accrualTransactionIdcalculate-accrued-amount-by-accrual-transaction-id › Request Body
accrualDateisEarlyClosureisEarlyPaymentisForceRecalculateisAccruedCalculationcalculate-accrued-amount-by-accrual-transaction-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
calculate-accrual-by-accrual-product-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CalculateAccrualByAccrualProductIdDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualDate | DateOnly? | yes |
AccrualProductType | int? | yes |
AccrualType | int? | yes |
Organizations | List<OrganizationItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_6 | 400 | PRODUCT_ENTRY_TYPE_MUST_BE_MASS | It is not allowed to calculate accrual for products whose accounting entry process type is Single with mass calculation method. accrual Product: {0}. |
path Parameters
accrualProductIdcalculate-accrual-by-accrual-product-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-accrual-calculation-by-product-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AccrualCalculationByProductTransactionIdDto.
| Field | Declared type | Nullable |
|---|---|---|
QueryDate | DateOnly? | yes |
ProductTransactionId | Guid? | yes |
OrdinalPosition | int? | yes |
FlowDate | DateOnly? | yes |
AccruedAmount | decimal? | yes |
AcccrualStatus | int? | yes |
CashFlowId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_28 | 400 | ACCRUAL_CALCULATION_QUERY_FIELD_BOOL_CONTROL | Only one of the following values can be true at the same time: Early Payment, Early Closure, Due Collection. |
path Parameters
productTransactionIdquery Parameters
flowDatePermitted values — validated against the flow_direction parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Incoming | no label seeded |
2 | Outgoing | no label seeded |
isDueCollectionisEarlyClosureisEarlyPaymentqueryDateget-accrual-calculation-by-product-transaction-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
acccrualStatusaccruedAmountcashFlowIdflowDatePermitted values — validated against the flow_direction parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Incoming | no label seeded |
2 | Outgoing | no label seeded |
ordinalPositionproductTransactionIdqueryDateget-accrual-calculation-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AccrualCalculationByTransactionIdDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualProductType | int? | yes |
AccrualType | int? | yes |
AccountingEntryProcessType | int? | yes |
LastDayAccountingType | int? | yes |
IsActive | bool? | yes |
CashFlows | List<CashFlowItem> (collection) | no |
Member names are the service's declaration names.
path Parameters
accrualTransactionIdget-accrual-calculation-by-transaction-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-accrual-calculation-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_18 | 400 | ACCRUAL_CALCULATION_NOT_FOUND_BY_TRANSACTION_ID_AND_ACCRUAL_DATE | Period is cannot be found with given:{0} and date {1}. |
path Parameters
accrualTransactionIdupdate-accrual-calculation-by-transaction-id › Request Body
accrualDateaccountingEntryIdaccrualCashFlowIdaccrualProductFormulaIdreversalAccountingEntryIdupdate-accrual-calculation-by-transaction-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
calculate-accrual-by-accrual-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CalculateAccrualByAccrualTransactionIdDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualDate | DateOnly | no |
AccrualTransactionId | Guid | no |
AccrualCashFlowId | Guid | no |
AccrualProductType | int | no |
AccrualType | int | no |
AccountingEntryProcessType | int | no |
IsLastDay | bool | no |
TransactionProductLedgerCode | string | no |
TransactionOrganizationCode | string | no |
AccrualStatus | int | no |
CustomerAccountId | Guid? | yes |
IsEarlyClosure | bool | no |
IsEarlyPayment | bool | no |
IsForceRecalculate | bool | no |
PrincipalAmount | decimal | no |
ProfitAmount | decimal | no |
AccrualCalculations | List<AccrualCalculationByTransactionDto> (collection) | no |
AccountingEntriesToBeReversed | List<AccountingEntryToBeReversed> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_11 | 400 | MASS_ENTRY_TYPE_CANNOT_BE_SINGLE_TRANSACTION | It is not allowed to calculate accrual for products whose accounting entry process type is mass with single transaction calculation method. |
ERR_ACCRL_16 | 400 | CASH_FLOW_STATUS_NOT_VALID_FOR_CALCULATION | Cash flow {0} which covers the given accrual date is at {1} status. Accrual cannot be calculated. |
path Parameters
accrualTransactionIdcalculate-accrual-by-accrual-transaction-id › Request Body
accrualDateisForceRecalculatecalculate-accrual-by-accrual-transaction-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-accrual-last-accounting-entry-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as List<AccrualLastAccountingEntryDto>.
| Field | Declared type | Nullable |
|---|---|---|
LastAccountingEntryId | Guid? | yes |
OtherTransactions | List<AccrualCalculationDto> (collection) | no |
Member names are the service's declaration names.
path Parameters
accrualTransactionIdget-accrual-last-accounting-entry-by-transaction-id › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
lastAccountingEntryId