cashs

Operations addressed under /cashs — 14 operations.

get-cash-box-list

GET

https://dg-sandbox.dgpays.com/account-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.

get-cash-box-list › query Parameters

code

string

currencyId

integer · int32

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

object[]

Array of catalog-declared response records.

object[]

code

string

id

string · uuid

isActive

boolean

name

string

object[]

GET/cashs

curl https://dg-sandbox.dgpays.com/account-service/cashs

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

create-cash-box

POST

https://dg-sandbox.dgpays.com/account-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 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_ACCNT_84`	400	`CASH_ALSO_FOUND`	Cash definition is also found.

create-cash-box › Request Body

code

string · required

name

string · required

create-cash-box › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

get-cash-box-ledger-list

GET

https://dg-sandbox.dgpays.com/account-service

/cashs/ledgers

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

Field	Declared type	Nullable
`CashBoxId`	`Guid?`	yes
`LedgerCode`	`string`	no
`CurrencyId`	`int?`	yes

Member names are the service's declaration names.

get-cash-box-ledger-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-cash-box-ledger-list › Responses

object[]

Array of catalog-declared response records.

cashBoxId

string · uuid

currencyId

integer · int32

id

string · uuid

ledgerCode

string

get-cash-user-map-list

GET

https://dg-sandbox.dgpays.com/account-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.

get-cash-user-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-cash-user-map-list › Responses

object[]

Array of catalog-declared response records.

assignDate

string · date

cashBoxId

string · uuid

id

string · uuid

organizationId

string · uuid

releaseDate

string · date

userId

string · uuid

update-cash-box

PUT

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.

update-cash-box › path Parameters

id

string · uuid · required

update-cash-box › Request Body

isActive

boolean · required

name

string · required

update-cash-box › 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

delete-cash-box

DELETE

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.

delete-cash-box › path Parameters

id

string · uuid · required

delete-cash-box › Responses

No data returned

create-cash-box-ledger

POST

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}/ledgers

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

Response body, read from the service source

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_89`	400	`LEDGER_ALREADY_EXIST`	Cash ledger also found.

create-cash-box-ledger › path Parameters

id

string · uuid · required

create-cash-box-ledger › Request Body

currencyId

integer · int32 · required

ledgerCode

string · required

create-cash-box-ledger › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

get-cash-box-ledger-by-id

GET

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}/ledgers/{cashLedgerId}

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

Field	Declared type	Nullable
`CashBoxId`	`Guid?`	yes
`LedgerCode`	`string`	no
`CurrencyId`	`int?`	yes

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.
`ERR_ACCNT_90`	400	`LEDGER_NOT_FOUND`	Cash Ledger is not found.

get-cash-box-ledger-by-id › path Parameters

id

string · uuid · required

cashLedgerId

string · uuid · required

get-cash-box-ledger-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.

cashBoxId

string · uuid

currencyId

integer · int32

id

string · uuid

ledgerCode

string

update-cash-box-ledger

PUT

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}/ledgers/{cashLedgerId}

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_89`	400	`LEDGER_ALREADY_EXIST`	Cash ledger also found.
`ERR_ACCNT_90`	400	`LEDGER_NOT_FOUND`	Cash Ledger is not found.

update-cash-box-ledger › path Parameters

id

string · uuid · required

cashLedgerId

string · uuid · required

update-cash-box-ledger › Request Body

currencyId

integer · int32 · required

ledgerCode

string · required

update-cash-box-ledger › Responses

No data returned

delete-cash-box-ledger

DELETE

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}/ledgers/{cashLedgerId}

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_90`	400	`LEDGER_NOT_FOUND`	Cash Ledger is not found.

delete-cash-box-ledger › path Parameters

id

string · uuid · required

cashLedgerId

string · uuid · required

delete-cash-box-ledger › Responses

No data returned

create-cash-box-user-map

POST

https://dg-sandbox.dgpays.com/account-service

/cashs/{id}/user-map

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

Response body, read from the service source

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_86`	400	`CASH_USER_MAP_ALREADY_EXIST`	Cash User Map also found

create-cash-box-user-map › path Parameters

id

string · uuid · required

create-cash-box-user-map › Request Body

assignDate

string · date · required

organizationId

string · uuid · required

userId

string · uuid · required

create-cash-box-user-map › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

get-cash-user-map-by-id

GET

https://dg-sandbox.dgpays.com/account-service

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

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

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_87`	400	`CASH_USER_MAP_NOT_FOUND`	Cash User Map not found.

get-cash-user-map-by-id › path Parameters

id

string · uuid · required

cashAccountUserMapId

string · uuid · required

get-cash-user-map-by-id › Responses

assignDate

string · date

cashBoxId

string · uuid

id

string · uuid

organizationId

string · uuid

releaseDate

string · date

userId

string · uuid

update-cash-box-user-map

PUT

https://dg-sandbox.dgpays.com/account-service

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

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_87`	400	`CASH_USER_MAP_NOT_FOUND`	Cash User Map not found.

update-cash-box-user-map › path Parameters

id

string · uuid · required

cashAccountUserMapId

string · uuid · required

update-cash-box-user-map › Request Body

assignDate

string · date · required

organizationId

string · uuid · required

releaseDate

string · date · required

userId

string · uuid · required

update-cash-box-user-map › Responses

No data returned

delete-cash-box-user-map

DELETE

https://dg-sandbox.dgpays.com/account-service

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

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_ACCNT_85`	400	`CASH_NOT_FOUND`	Cash definition is not found.
`ERR_ACCNT_87`	400	`CASH_USER_MAP_NOT_FOUND`	Cash User Map not found.

delete-cash-box-user-map › path Parameters

id

string · uuid · required

cashAccountUserMapId

string · uuid · required

delete-cash-box-user-map › Responses

No data returned

cashbox-transfer compensating-transactions