accounting-entries
Operations addressed under /accounting-entries — 6 operations.
get-accounting-entry-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<AccountingEntryDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
UserCode | string | no |
EntryType | int? | yes |
BpmFlowCode | string | no |
TransactionDate | DateOnly | no |
Description | string | no |
AccountingEntryDefinitionCode | string | no |
IsReverse | bool? | yes |
OrganizationCode | string | no |
ReferenceNumber | string | no |
ValueDate | DateOnly | no |
AccountingEntryDetails | IEnumerable<AccountingEntryDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_160 | 400 | GL_CODE_NOT_FOUND | GL Code '{0}' is not found. |
ERR_ACCTNG_175 | 400 | END_DATE_MUST_BE_BIGGER_BEGIN_DATE | 'endDate' must be bigger than 'beginDate'. |
query Parameters
accountNumberbeginDatebpmFlowCodecorrelationIdendDateentryTypePermitted values — validated against the entry_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Engine | no label seeded |
2 | Manual | no label seeded |
3 | Logo | no label seeded |
4 | ProfitLoss | no label seeded |
5 | Closing | no label seeded |
6 | Opening | no label seeded |
gLCodeidorderByorderSortorganizationCodepageIndexpageSizereferenceNumberuserCodeget-accounting-entry-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.
accountingEntryDefinitionCodebpmFlowCodedescriptionentryTypePermitted values — validated against the entry_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Engine | no label seeded |
2 | Manual | no label seeded |
3 | Logo | no label seeded |
4 | ProfitLoss | no label seeded |
5 | Closing | no label seeded |
6 | Opening | no label seeded |
idisReverseorganizationCodereferenceNumbertransactionDateuserCodevalueDatecreate-accounting-entry
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 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_ACCTNG_169 | 400 | ACCOUNTING_ENTRY_DOES_NOT_HAVE_ANY_DETAILS | Accounting entry does not have any details. It cannot be created. |
ERR_ACCTNG_181 | 400 | THIS_API_CAN_ONLY_BE_RUN_BY_BPM | This api can only be run with BPM. |
create-accounting-entry › Request Body
descriptionentryTypePermitted values — validated against the entry_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Engine | no label seeded |
2 | Manual | no label seeded |
3 | Logo | no label seeded |
4 | ProfitLoss | no label seeded |
5 | Closing | no label seeded |
6 | Opening | no label seeded |
transactionDateaccountingEntryDefinitionCodebpmFlowCodeuserCodecreate-accounting-entry › 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.
idget-accounting-entry-list-by-correlation-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 AccountingEntryCorrelationIdDto.
| Field | Declared type | Nullable |
|---|---|---|
CorrelationId | Guid | no |
AccountingEntryList | List<AccountingEntryDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_173 | 400 | ACCOUNTING_ENTRIES_NOT_FOUND | Accounting Entries are not found with the given Correlationid : ‘{0}’. |
path Parameters
correlationIdget-accounting-entry-list-by-correlation-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.
correlationIdaccounting-entry-validation
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_ACCTNG_156 | 400 | FISCAL_PERIOD_IS_CLOSED | Fical period is closed. Accounting Entry cannot be created. |
ERR_ACCTNG_157 | 400 | IT_IS_NOT_ALLOWED_TO_CREATE_A_FUTURE_DATED_ACCOUNTING_ENTRY | It is not allowed to create a future dated accounting entry. |
ERR_ACCTNG_158 | 400 | AMOUNT_OF_THE_ENTRY_IS_ZERO | Amount of the entry is 0. Accounting entry cannot be created. Sequence:'{0}'. |
ERR_ACCTNG_159 | 400 | TOTAL_DEBIT_MUST_BE_EQUAL_TO_THE_TOTAL_CREDIT | Total Debit must be equal to the total Credit. {0} |
ERR_ACCTNG_160 | 400 | GL_CODE_NOT_FOUND | GL Code '{0}' is not found. |
ERR_ACCTNG_161 | 400 | LEDGER_IS_NOT_ACTIVE | Ledger '{0}' is not 'Active'. Accounting entry cannot be created. |
ERR_ACCTNG_162 | 400 | LEDGER_IS_WITHOUT_CUS | 'customerOption' value of the Ledger '{0}' is 'without_cus'. Accounting entry cannot be created with 'accountNumber'. |
ERR_ACCTNG_163 | 400 | LEDGER_IS_WITH_CUS | 'customerOption' value of the Ledger '{0}' is 'with_cus'. Accounting entry cannot be created without 'accountNumber'. |
ERR_ACCTNG_164 | 400 | LEDGER_CURRENCY_NOT_COMPATIBLE | Currency of the entry is not compatible with the ledger's '{0}' currency value. Accounting entry cannot be created. Sequence:'{1}'. |
ERR_ACCTNG_166 | 400 | LEDGER_NOT_NEGATIVE_BALANCE | Ledger '{0}' will have negative balance. Accounting entry cannot be created. |
ERR_ACCTNG_169 | 400 | ACCOUNTING_ENTRY_DOES_NOT_HAVE_ANY_DETAILS | Accounting entry does not have any details. It cannot be created. |
ERR_ACCTNG_170 | 400 | LEDGER_IS_CLOSED_MANUEL_ENTRY | Ledger '{0}' is closed to manual entry. Accounting entry cannot be created. |
ERR_ACCTNG_177 | 400 | LEDGER_CATEGORY_HAS_BEEN_CLOSED_FOR_FC | Ledger category has been closed. {0} |
accounting-entry-validation › Request Body
descriptionentryTypePermitted values — validated against the entry_type parameter.
| Value | Meaning |
|---|---|
1 | Engine |
2 | Manual |
3 | Logo |
4 | ProfitLoss |
5 | Closing |
6 | Opening |
Permitted values — validated against the entry_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Engine | no label seeded |
2 | Manual | no label seeded |
3 | Logo | no label seeded |
4 | ProfitLoss | no label seeded |
5 | Closing | no label seeded |
6 | Opening | no label seeded |
transactionDateaccountingEntryDefinitionCodebpmFlowCodeuserCodeaccounting-entry-validation › 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-accounting-entry-with-detail-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 AccountingEntryDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
UserCode | string | no |
EntryType | int? | yes |
BpmFlowCode | string | no |
TransactionDate | DateOnly | no |
Description | string | no |
AccountingEntryDefinitionCode | string | no |
IsReverse | bool? | yes |
OrganizationCode | string | no |
ReferenceNumber | string | no |
ValueDate | DateOnly | no |
AccountingEntryDetails | IEnumerable<AccountingEntryDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_174 | 400 | ACCOUNTING_ENTRY_NOT_FOUND | Accounting Entry is not found with the given Id : ‘{0}’. |
path Parameters
idget-accounting-entry-with-detail-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.
accountingEntryDefinitionCodebpmFlowCodedescriptionentryTypePermitted values — validated against the entry_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Engine | no label seeded |
2 | Manual | no label seeded |
3 | Logo | no label seeded |
4 | ProfitLoss | no label seeded |
5 | Closing | no label seeded |
6 | Opening | no label seeded |
idisReversetransactionDateuserCodereverse-accounting-entry
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 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_ACCTNG_174 | 400 | ACCOUNTING_ENTRY_NOT_FOUND | Accounting Entry is not found with the given Id : ‘{0}’. |
ERR_ACCTNG_191 | 400 | REVERSE_ACCOUNTING_ALREADY_EXISTS | Accounting Entry is already reversed. It cannot be reversed again. |
ERR_ACCTNG_192 | 400 | REVERSE_ACCOUNTING_BACKDATE_AUTHORITY | There is no authority to create a retroactive reverse accounting record for this accounting definition. |
path Parameters
idreverse-accounting-entry › 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.
id