cashs

Operations addressed under /cashs — 7 operations.

aurax-bff-redirect-get-cash-box-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs

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<CashBoxDto>.

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`IsActive`	`bool`	no
`UserMaps`	`List<CashBoxAssignmentDto>` (collection)	no
`CashBoxLedgers`	`List<CashBoxLedgerDto>` (collection)	no

Member names are the service's declaration names.

aurax-bff-redirect-get-cash-box-list › 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.

No data returned

create-cash-box

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-bff-redirect-create-cash-box-ui service definition through POST /cashs.

Request and response fields are declared on the routing target create-cash-box-ui; this entry declares none of its own.

create-cash-box › Request Body

code

string · required

name

string · required

object[]

create-cash-box › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

aurax-bff-redirect-get-cash-user-map-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs/user-map

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<CashBoxAssignmentDto>.

Field	Declared type	Nullable
`CashBoxId`	`Guid`	no
`OrganizationId`	`Guid`	no
`UserId`	`Guid?`	yes
`AssignDate`	`DateOnly?`	yes
`ReleaseDate`	`DateOnly?`	yes

Member names are the service's declaration names.

aurax-bff-redirect-get-cash-user-map-list › Responses

No data returned

aurax-bff-redirect-get-cash-box-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs/{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-cash-box-by-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CashBoxDto.

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`IsActive`	`bool`	no
`UserMaps`	`List<CashBoxAssignmentDto>` (collection)	no
`CashBoxLedgers`	`List<CashBoxLedgerDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.

aurax-bff-redirect-get-cash-box-by-id › path Parameters

id

string · uuid · required

aurax-bff-redirect-get-cash-box-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.

object[]

code

string

id

string · uuid

isActive

boolean

name

string

object[]

GET/cashs/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/cashs/:id

Example Responses

{
  "cashBoxLedgers": [
    {
      "cashBoxId": "00000000-0000-0000-0000-000000000000",
      "currencyId": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerCode": "ledgerCode"
    }
  ],
  "code": "code",
  "id": "00000000-0000-0000-0000-000000000000",
  "isActive": true,
  "name": "name",
  "userMaps": [
    {
      "assignDate": "2024-08-25",
      "cashBoxId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "releaseDate": "2024-08-25",
      "userId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

json

application/json

update-cash-box

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-bff-redirect-update-cash-box-ui service definition through PUT /cashs/{id}.

Request and response fields are declared on the routing target update-cash-box-ui; this entry declares none of its own.

update-cash-box › path Parameters

id

string · required

Present in this route template but not among the Route-bound fields of the routing target update-cash-box-ui, whose own path is decoupled from this one.

update-cash-box › Request Body

code

string · required

id

string · uuid · required

isActive

boolean · required

name

string · required

object[]

update-cash-box › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

PUT/cashs/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/cashs/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "id": "",
  "isActive": false,
  "name": "",
  "userMaps": [
    {
      "_rowStatus": 0,
      "assignDate": "",
      "id": "",
      "organizationId": "",
      "releaseDate": "",
      "userId": ""
    }
  ]
}'

Example Request Body

{
  "code": "",
  "id": "",
  "isActive": false,
  "name": "",
  "userMaps": [
    {
      "_rowStatus": 0,
      "assignDate": "",
      "id": "",
      "organizationId": "",
      "releaseDate": "",
      "userId": ""
    }
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

delete-cash-box

DELETE

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-bff-redirect-delete-cash-box-ui service definition through DELETE /cashs/{id}.

Request and response fields are declared on the routing target delete-cash-box-ui; this entry declares none of its own.

Request body description

The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit id, which this document nevertheless marks required because the catalog declares it so.

delete-cash-box › path Parameters

id

string · required

Present in this route template but not among the Route-bound fields of the routing target delete-cash-box-ui, whose own path is decoupled from this one.

delete-cash-box › Request Body

id

string · uuid · required

delete-cash-box › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

aurax-bff-redirect-get-cash-with-user-map

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/cashs/{id}/with-user-map

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-cash-with-user-map; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CashBoxDto.

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`IsActive`	`bool`	no
`UserMaps`	`List<CashBoxAssignmentDto>` (collection)	no
`CashBoxLedgers`	`List<CashBoxLedgerDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.

aurax-bff-redirect-get-cash-with-user-map › path Parameters

id

string · uuid · required

aurax-bff-redirect-get-cash-with-user-map › Responses

object[]

code

string

id

string · uuid

isActive

boolean

name

string

object[]

GET/cashs/{id}/with-user-map

curl https://dg-sandbox.dgpays.com/aurax-bff-service/cashs/:id/with-user-map

Example Responses

{
  "cashBoxLedgers": [
    {
      "cashBoxId": "00000000-0000-0000-0000-000000000000",
      "currencyId": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerCode": "ledgerCode"
    }
  ],
  "code": "code",
  "id": "00000000-0000-0000-0000-000000000000",
  "isActive": true,
  "name": "name",
  "userMaps": [
    {
      "assignDate": "2024-08-25",
      "cashBoxId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "releaseDate": "2024-08-25",
      "userId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

json

application/json

cashbox-transfer central-bank-transaction-limits