gl-code-sections
Operations addressed under /gl-code-sections — 9 operations.
get-gLCode-section-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<GLCodeSectionListDto>.
| Field | Declared type | Nullable |
|---|---|---|
ParentSectionName | string | no |
Id | Guid | no |
SectionType | string | no |
Name | string | no |
SectionLength | int? | yes |
IsMainParent | bool? | yes |
IsMandatory | bool? | yes |
ParentSectionId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-gLCode-section-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.
idisMainParentisMandatorynameparentSectionIdparentSectionNamesectionLengthsectionTypecreate-gLCode-section
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_232 | 400 | SECTION_TYPES_MUST_BE_ONEOFTHE_DEFINED_TYPES | not published in this snapshot |
ERR_ACCTNG_41 | 400 | NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_SECTION | It is not allowed to create more than one section with the {0} section type. |
ERR_ACCTNG_42 | 400 | THERE_IS_A_GL_CODE_SECTION_WITH_THE_SAME_NAME | There is a GL Code Section with the same name {0}. |
ERR_ACCTNG_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_44 | 400 | GL_CODE_SECTION_HAS_ALREADY_A_CHILD_GL_CODE_SECTION | GL Code Section:{0} has already a child GL Code Section. It cannot have more than one child section. |
ERR_ACCTNG_45 | 400 | GL_CODE_SECTION_WITH_LEDGER_TYPE_CANNOT_BE_PARENT_GL_CODE_SECTION | GL Code Section with Ledger type cannot be a parent GL Code Section. |
ERR_ACCTNG_54 | 400 | MULTIPLE_MAIN_PARENT_SECTIONS_ARE_NOT_ALLOWED | It is not allowed to have more than one main parent section. |
ERR_ACCTNG_64 | 400 | PARENT_SECTION_ID_MUST_BE_PROVIDED | GL Code Section is not main parent, it is mandatory to have a parent section |
create-gLCode-section › Request Body
isMainParentisMandatorynamesectionLengthsectionTypeparentSectionIdcreate-gLCode-section › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-gLCode-section-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 GLCodeSectionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
SectionType | string | no |
Name | string | no |
SectionLength | int? | yes |
IsMainParent | bool? | yes |
IsMandatory | bool? | yes |
ParentSectionId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
path Parameters
idget-gLCode-section-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.
idisMainParentisMandatorynameparentSectionIdsectionLengthsectionTypeupdate-gLCode-section
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_232 | 400 | SECTION_TYPES_MUST_BE_ONEOFTHE_DEFINED_TYPES | not published in this snapshot |
ERR_ACCTNG_42 | 400 | THERE_IS_A_GL_CODE_SECTION_WITH_THE_SAME_NAME | There is a GL Code Section with the same name {0}. |
ERR_ACCTNG_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_44 | 400 | GL_CODE_SECTION_HAS_ALREADY_A_CHILD_GL_CODE_SECTION | GL Code Section:{0} has already a child GL Code Section. It cannot have more than one child section. |
ERR_ACCTNG_45 | 400 | GL_CODE_SECTION_WITH_LEDGER_TYPE_CANNOT_BE_PARENT_GL_CODE_SECTION | GL Code Section with Ledger type cannot be a parent GL Code Section. |
ERR_ACCTNG_47 | 400 | THE_SECTION_WITH_THE_TYPE_LEDGER_IS_DEFAULT_SECTION_IT_CANNOT_BE_UPDATED | The section with the type 'ledger' is default section. It cannot be updated. |
ERR_ACCTNG_48 | 400 | GL_CODE_SECTIONS_WITH_THE_COMPANY_BRANCH_AND_LEDGER_SECTION_TYPES_ARE_DEFAULT_SECTIONS_THEIR_TYPE_VALUE_CANNOT_BE_UPDATED | GL Code Sections with the 'Company', 'Branch' and 'Ledger' section types are default sections. Their 'Type' value cannot be updated. |
ERR_ACCTNG_49 | 400 | IT_IS_NOT_ALLOWED_TO_HAVE_MORE_THAN_ONE_SECTION_WITH_THE_COMPANY_BRANCH_AND_LEDGER_SECTION_TYPES | It is not allowed to have more than one section with the 'Company', 'Branch' and 'Ledger' section types. |
ERR_ACCTNG_54 | 400 | MULTIPLE_MAIN_PARENT_SECTIONS_ARE_NOT_ALLOWED | It is not allowed to have more than one main parent section. |
ERR_ACCTNG_55 | 400 | GL_CODE_SECTION_CANNOT_BE_ITS_OWN_PARENT_GL_CODE_SECTION | GL Code Section cannot be its own parent GL Code Section. GL Code Section : {0} |
ERR_ACCTNG_64 | 400 | PARENT_SECTION_ID_MUST_BE_PROVIDED | GL Code Section is not main parent, it is mandatory to have a parent section |
path Parameters
idupdate-gLCode-section › Request Body
isMainParentisMandatorynamesectionLengthsectionTypeparentSectionIdupdate-gLCode-section › 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.
delete-gLCode-section
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_233 | 400 | A_RECORD_WITH_SECTION_TYPE_LEDGER_CANNOT_BE_DELETED | GL code section type ledger cannot be deleted. |
ERR_ACCTNG_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_46 | 400 | GL_CODE_SECTION_USED_IN_GL_CODE_FORMAT_CANNOT_BE_DELETED | GL Code Section is used in GL Code Format. It cannot be deleted. |
ERR_ACCTNG_59 | 400 | GL_CODE_SECTION_HAVE_CHILDREN_CAN_NOT_BE_DELETED | GL Code Section is a parent section. It cannot be deleted. |
path Parameters
iddelete-gLCode-section › 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-gLCode-section-value-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<GLCodeSectionValueDto>.
| Field | Declared type | Nullable |
|---|---|---|
GLCodeSectionId | Guid? | yes |
GLCodeSectionValueId | Guid | no |
Name | string | no |
SectionValue | string | no |
ParentValueId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_65 | 400 | GET_LEDGER_METHODS_SHOULD_BE_USED_TO_GET_VALUE_OF_THE_SECTION_WHOSE_TYPE_IS_LEDGER | Get Ledger methods should be used to get value of the section whose 'type' is not 'Ledger'. |
path Parameters
idget-gLCode-section-value-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.
glCodeSectionIdglCodeSectionValueIdnameparentValueIdsectionValuecreate-gLCode-section-value
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_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_56 | 400 | SECTION_VALUE_IS_ALREADY_EXISTS | There is already a section value like {0}. |
ERR_ACCTNG_57 | 400 | VALUE_OF_THE_GL_CODE_SECTION_WHOSE_TYPE_IS_LEDGER_MUST_BE_DEFINED_WITH_THE_CREATE_LEDGER_METHOD | Value of the GL Code Section whose 'type' is 'Ledger' must be defined with the Create Ledger method. |
ERR_ACCTNG_58 | 400 | GL_CODE_SECTION_VALUE_LENGTH_CANNOT_BE_LARGER_THAN_THE_GL_CODE_SECTION_LENGTH | GL Code Section Value length cannot be larger than the GL Code Section length: {0}. |
ERR_ACCTNG_61 | 400 | GL_CODE_SECTION_VALUE_CANNOT_CONTAIN_WHITESPACE | Section value cannot contain white space. |
ERR_ACCTNG_63 | 400 | GL_CODE_SECTION_IS_IN_CHILD_SECTION_POSITION_PARENTVALUEID_MUST_BE_PROVIDED | GL Code Section:{0} is in child section position, 'parentValueId' must be provided. |
ERR_ACCTNG_69 | 400 | GL_CODE_SECTION_VALUE_NOT_FOUND_VALUE_ID | GL Code Section Value not found. GL code section value id = {0}. |
ERR_ACCTNG_91 | 400 | GL_CODE_SECTION_VALUE_IN_SECTION_IS_NOT_FOUND | GL Code Section Value {0} in {1} section is not found. |
path Parameters
idcreate-gLCode-section-value › 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-gLCode-section-value
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_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_56 | 400 | SECTION_VALUE_IS_ALREADY_EXISTS | There is already a section value like {0}. |
ERR_ACCTNG_58 | 400 | GL_CODE_SECTION_VALUE_LENGTH_CANNOT_BE_LARGER_THAN_THE_GL_CODE_SECTION_LENGTH | GL Code Section Value length cannot be larger than the GL Code Section length: {0}. |
ERR_ACCTNG_61 | 400 | GL_CODE_SECTION_VALUE_CANNOT_CONTAIN_WHITESPACE | Section value cannot contain white space. |
ERR_ACCTNG_63 | 400 | GL_CODE_SECTION_IS_IN_CHILD_SECTION_POSITION_PARENTVALUEID_MUST_BE_PROVIDED | GL Code Section:{0} is in child section position, 'parentValueId' must be provided. |
ERR_ACCTNG_69 | 400 | GL_CODE_SECTION_VALUE_NOT_FOUND_VALUE_ID | GL Code Section Value not found. GL code section value id = {0}. |
ERR_ACCTNG_70 | 400 | GL_CODE_SECTION_VALUE_IS_USED_IN_GL_CODE_IT_CANNOT_BE_UPDATED | GL Code Section value {0} is used in GL Code. It cannot be updated. |
ERR_ACCTNG_76 | 400 | SUITABLE_GL_CODE_SECTION_VALUE_NOT_FOUND | GL Code Section Value not found. GL code section value id ={0}. |
ERR_ACCTNG_91 | 400 | GL_CODE_SECTION_VALUE_IN_SECTION_IS_NOT_FOUND | GL Code Section Value {0} in {1} section is not found. |
path Parameters
idvalueIdupdate-gLCode-section-value › Request Body
namesectionValueparentValueIdupdate-gLCode-section-value › 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.
delete-gLCode-section-value
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_43 | 400 | SUITABLE_GL_CODE_SECTION_NOT_FOUND | Gl Code Section:{0} is not found. |
ERR_ACCTNG_76 | 400 | SUITABLE_GL_CODE_SECTION_VALUE_NOT_FOUND | GL Code Section Value not found. GL code section value id ={0}. |
ERR_ACCTNG_78 | 400 | SECTION_VALUE_IS_USED_CANNOT_BE_DELETED | GL Codes with the given Gl Code Section Value is used for accounting entry. It cannot be deleted. |
path Parameters
idvalueIddelete-gLCode-section-value › 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.