transactions
Operations addressed under /transactions — 10 operations.
get accrual transaction list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the get-accrual-transaction-list service definition through GET /transactions.
Response body, read from the service source
The route declares its response as IEnumerable<AccrualTransactionDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccrualType | int? | yes |
AccrualProductId | Guid? | yes |
ProductTransactionId | Guid? | yes |
TransactionOrganizationCode | string | no |
TransactionDate | DateOnly? | yes |
MaturityBeginDate | DateOnly? | yes |
MaturityEndDate | DateOnly? | yes |
YearlyProfitRate | decimal? | yes |
IsActive | bool? | yes |
TransactionProductLedgerCode | string | no |
CustomerAccountId | Guid? | yes |
Xirr | decimal | no |
EffectiveProfitRate | decimal | no |
EarlyPaymentDiscountRate | decimal | no |
CashFlows | List<AccrualCashFlowDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget accrual transaction 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.
accrualProductIdaccrualTypePermitted values — validated against the accrual_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Income | no label seeded |
2 | Expense | no label seeded |
customerAccountIdearlyPaymentDiscountRateeffectiveProfitRateidisActivematurityBeginDatematurityEndDateproductTransactionIdtransactionDatetransactionOrganizationCodetransactionProductLedgerCodexirryearlyProfitRateSave Transaction
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the create-accrual-transaction service definition through POST /transactions.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | 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_25 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION_EARLYPAYMENT_AND_EARLY_CALCULATION_AND_PERIODICAL | not published in this snapshot |
ERR_ACCRL_5 | 400 | IT_IS_NOT_ALLOWED_TO_SAVE_TRANSACTION_WITH_THE_SAME_PRODUCT_TRANSACTION_ID | It is not allowed to save transaction with the same Product Transaction:{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} |
Save Transaction › Request Body
accrualProductIdaccrualTypePermitted values — validated against the accrual_type parameter.
| Value | Meaning |
|---|---|
1 | Income |
2 | Expense |
Permitted values — validated against the accrual_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Income | no label seeded |
2 | Expense | no label seeded |
earlyPaymentDiscountRateeffectiveProfitRatematurityBeginDatematurityEndDateproductTransactionIdtransactionDatetransactionOrganizationCodetransactionProductLedgerCodexirryearlyProfitRatecustomerAccountIdSave Transaction › 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.
get-accrual-transaction-by-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 AccrualTransactionDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualType | int? | yes |
AccrualProductId | Guid? | yes |
ProductTransactionId | Guid? | yes |
TransactionOrganizationCode | string | no |
TransactionDate | DateOnly? | yes |
MaturityBeginDate | DateOnly? | yes |
MaturityEndDate | DateOnly? | yes |
YearlyProfitRate | decimal? | yes |
IsActive | bool? | yes |
TransactionProductLedgerCode | string | no |
CustomerAccountId | Guid? | yes |
Xirr | decimal | no |
EffectiveProfitRate | decimal | no |
EarlyPaymentDiscountRate | decimal | no |
CashFlows | List<AccrualCashFlowDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idget-accrual-transaction-by-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.
accrualProductIdaccrualTypePermitted values — validated against the accrual_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Income | no label seeded |
2 | Expense | no label seeded |
customerAccountIdearlyPaymentDiscountRateeffectiveProfitRateidisActivematurityBeginDatematurityEndDateproductTransactionIdtransactionDatetransactionOrganizationCodetransactionProductLedgerCodexirryearlyProfitRateupdate-accrual-transaction
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_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idupdate-accrual-transaction › Request Body
accrualTypePermitted values — validated against the accrual_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Income | no label seeded |
2 | Expense | no label seeded |
customerAccountIdearlyPaymentDiscountRateeffectiveProfitRatematurityBeginDatematurityEndDatetransactionDatetransactionProductLedgerCodexirryearlyProfitRateupdate-accrual-transaction › 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.
get-accrual-transaction-cash-flow
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 AccrualTransactionCashFlowDto.
| Field | Declared type | Nullable |
|---|---|---|
CashFlows | IEnumerable<AccrualCashFlowDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idquery 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 |
minOrdinalPositionget-accrual-transaction-cash-flow › 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.
update-accrual-cash-flow
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_10 | 400 | CASH_FLOW_IS_NOT_FOUND | Cash flow is cannot be found with given Cash Flow: {0} |
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_8 | 400 | PRODUCT_FIELD_IS_NOT_ACTIVE_OR_NOT_BELONG | Field is not active or not belong to the product. FieldId: {0} |
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idcashFlowIdupdate-accrual-cash-flow › Request Body
accrualStatusPermitted values — validated against the accrual_status parameter.
| Value | Meaning |
|---|---|
1 | Accrual |
2 | NonAccrual |
3 | Accrued |
4 | Cancelled |
5 | Calculated |
Permitted values — validated against the accrual_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Accrual | no label seeded |
2 | NonAccrual | no label seeded |
3 | Accrued | no label seeded |
4 | Cancelled | no label seeded |
5 | Calculated | ar: محسوب |
amountcurrencyNumberdirectionPermitted values — validated against the flow_direction parameter.
| Value | Meaning |
|---|---|
1 | Incoming |
2 | Outgoing |
Permitted 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 |
monthDayBasisprincipalAmountprofitAmountyearDayBasisupdate-accrual-cash-flow › 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.
update-accrual-cash-flow-entry
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_10 | 400 | CASH_FLOW_IS_NOT_FOUND | Cash flow is cannot be found with given Cash Flow: {0} |
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idcashFlowIdupdate-accrual-cash-flow-entry › Request Body
paymentDatepaymentTypeaccrualAccountingEntryupdate-accrual-cash-flow-entry › 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.
update-accrual-cash-flow-status
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_10 | 400 | CASH_FLOW_IS_NOT_FOUND | Cash flow is cannot be found with given Cash Flow: {0} |
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idcashFlowIdupdate-accrual-cash-flow-status › Request Body
accrualStatusPermitted values — validated against the accrual_status parameter.
| Value | Meaning |
|---|---|
1 | Accrual |
2 | NonAccrual |
3 | Accrued |
4 | Cancelled |
5 | Calculated |
Permitted values — validated against the accrual_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Accrual | no label seeded |
2 | NonAccrual | no label seeded |
3 | Accrued | no label seeded |
4 | Cancelled | no label seeded |
5 | Calculated | ar: محسوب |
paymentDatepaymentTypeupdate-accrual-cash-flow-status › 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.
update-accrual-cash-flow-status-multiple
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_10 | 400 | CASH_FLOW_IS_NOT_FOUND | Cash flow is cannot be found with given Cash Flow: {0} |
ERR_ACCRL_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
cashFlowIdPresent in the route template but not declared as a Route-bound field in the catalog.
update-accrual-cash-flow-status-multiple › 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.
update-accrual-transaction-status
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_9 | 400 | TRANSACTION_IS_NOT_FOUND | Transaction is cannot be found with given transaction: {0}. |
path Parameters
idupdate-accrual-transaction-status › 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.