eledger-requests
Operations addressed under /eledger-requests — 5 operations.
aurax-bff-redirect-get-eledger-request-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-eledger-request-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<EledgerRequestDto>.
| Field | Declared type | Nullable |
|---|---|---|
BeginDate | DateOnly | no |
EndDate | DateOnly | no |
LastEntryNumber | string | no |
LastLineNumber | string | no |
Description | string | no |
FileFormat | int | no |
FileName | string | no |
Status | int | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-eledger-request-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
aurax-bff-redirect-create-eledger-request
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target create-eledger-request; this entry declares none of its own.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | 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_234 | 400 | REQUEST_IS_ALREADY_EXISTING_WITH_GIVEN_BEGIN_AND_END_DATE | Request is already existing with given begin and end date |
ERR_ACCTNG_237 | 400 | BEGIN_DATE_CONNNOT_BE_GREATER_THAN_END_DATE | Begin date cannot be greater than end date |
ERR_ACCTNG_238 | 400 | PREVIOUS_ELEDGER_REQUEST_MUST_BE_READY | Previous eledger request must be ready |
aurax-bff-redirect-create-eledger-request › Request Body
beginDatedescriptionendDatefileFormatPermitted values — validated against the file_format parameter.
| Value | Meaning |
|---|---|
1 | xml |
2 | csv |
3 | json |
aurax-bff-redirect-create-eledger-request › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
aurax-bff-redirect-get-eledger-request-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-eledger-request-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as EledgerRequestDto.
| Field | Declared type | Nullable |
|---|---|---|
BeginDate | DateOnly | no |
EndDate | DateOnly | no |
LastEntryNumber | string | no |
LastLineNumber | string | no |
Description | string | no |
FileFormat | int | no |
FileName | string | no |
Status | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_236 | 400 | ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID | Eledger request is not exists for given id |
path Parameters
idaurax-bff-redirect-get-eledger-request-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.
beginDatedescriptionendDatefileFormatfileNamelastEntryNumberlastLineNumberstatusaurax-bff-redirect-update-eledger-request
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target update-eledger-request; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_234 | 400 | REQUEST_IS_ALREADY_EXISTING_WITH_GIVEN_BEGIN_AND_END_DATE | Request is already existing with given begin and end date |
ERR_ACCTNG_236 | 400 | ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID | Eledger request is not exists for given id |
ERR_ACCTNG_237 | 400 | BEGIN_DATE_CONNNOT_BE_GREATER_THAN_END_DATE | Begin date cannot be greater than end date |
ERR_ACCTNG_238 | 400 | PREVIOUS_ELEDGER_REQUEST_MUST_BE_READY | Previous eledger request must be ready |
path Parameters
idaurax-bff-redirect-update-eledger-request › Request Body optional
beginDatedescriptionendDatefileFormatPermitted values — validated against the file_format parameter.
| Value | Meaning |
|---|---|
1 | xml |
2 | csv |
3 | json |
fileNamelastEntryNumberlastLineNumberaurax-bff-redirect-update-eledger-request › 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.
aurax-bff-redirect-update-eledger-request-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target update-eledger-request-status; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_236 | 400 | ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID | Eledger request is not exists for given id |
path Parameters
idaurax-bff-redirect-update-eledger-request-status › Request Body
statusPermitted values — validated against the eledger_request_status parameter.
| Value | Meaning |
|---|---|
0 | Requested |
1 | Preparing |
2 | Ready |
3 | Cancelled |
4 | Error Received |
aurax-bff-redirect-update-eledger-request-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.