outgoing-distraint-files

Operations addressed under /outgoing-distraint-files — 11 operations.

create-outgoing-distraint-file

POST

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

/outgoing-distraint-files

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.

create-outgoing-distraint-file › Request Body

status

integer · int32 · required

incomingDistraintFileId

string · uuid

packageCode

string

packageDate

string · date

statusSourceOfficeCode

integer · int32

statusSourceOfficeDescription

string

create-outgoing-distraint-file › 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.

POST/outgoing-distraint-files

curl https://dg-sandbox.dgpays.com/account-service/outgoing-distraint-files \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "incomingDistraintFileId": "",
  "packageCode": "",
  "packageDate": "",
  "status": 0,
  "statusSourceOfficeCode": 0,
  "statusSourceOfficeDescription": ""
}'

Example Request Body

{
  "incomingDistraintFileId": "",
  "packageCode": "",
  "packageDate": "",
  "status": 0,
  "statusSourceOfficeCode": 0,
  "statusSourceOfficeDescription": ""
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

update-outgoing-distraint-file

PUT

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

/outgoing-distraint-files/{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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`

update-outgoing-distraint-file › path Parameters

id

string · uuid · required

update-outgoing-distraint-file › Request Body

status

integer · int32 · required

incomingDistraintFileId

string · uuid

packageCode

string

packageDate

string · date

statusSourceOfficeCode

integer · int32

statusSourceOfficeDescription

string

update-outgoing-distraint-file › 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-outgoing-distraint-file

DELETE

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

/outgoing-distraint-files/{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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`

delete-outgoing-distraint-file › path Parameters

id

string · uuid · required

delete-outgoing-distraint-file › Responses

No data returned

create-outgoing-distraint-file-detail

POST

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

/outgoing-distraint-files/{id}/details

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`

create-outgoing-distraint-file-detail › path Parameters

id

string · uuid · required

create-outgoing-distraint-file-detail › Request Body optional

amount

number · decimal

birthDate

string · date

currencyId

integer · int32

distraintNumber

string

fatherName

string

hasAvailableAccount

boolean

name

string

surname

string

taxNumber

string

taxOfficeCode

string

create-outgoing-distraint-file-detail › 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.

POST/outgoing-distraint-files/{id}/details

curl https://dg-sandbox.dgpays.com/account-service/outgoing-distraint-files/:id/details \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "birthDate": "",
  "currencyId": 0,
  "distraintNumber": "",
  "fatherName": "",
  "hasAvailableAccount": false,
  "name": "",
  "surname": "",
  "taxNumber": "",
  "taxOfficeCode": ""
}'

Example Request Body

{
  "amount": 0,
  "birthDate": "",
  "currencyId": 0,
  "distraintNumber": "",
  "fatherName": "",
  "hasAvailableAccount": false,
  "name": "",
  "surname": "",
  "taxNumber": "",
  "taxOfficeCode": ""
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-outgoing-distraint-file-detail-by-id

GET

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`DistraintNumber`	`string`	no
`TaxOfficeCode`	`string`	no
`TaxNumber`	`string`	no
`Name`	`string`	no
`Surname`	`string`	no
`FatherName`	`string`	no
`Amount`	`decimal?`	yes
`BirthDate`	`DateOnly?`	yes
`HasAvailableAccount`	`bool?`	yes
`CurrencyId`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`

get-outgoing-distraint-file-detail-by-id › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

get-outgoing-distraint-file-detail-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-outgoing-distraint-file-detail

PUT

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`

update-outgoing-distraint-file-detail › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

update-outgoing-distraint-file-detail › Request Body optional

amount

number · decimal

birthDate

string · date

currencyId

integer · int32

distraintNumber

string

fatherName

string

hasAvailableAccount

boolean

name

string

surname

string

taxNumber

string

taxOfficeCode

string

update-outgoing-distraint-file-detail › Responses

No data returned

PUT/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}

curl https://dg-sandbox.dgpays.com/account-service/outgoing-distraint-files/:id/details/:outgoingDistraintFileDetailId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "birthDate": "",
  "currencyId": 0,
  "distraintNumber": "",
  "fatherName": "",
  "hasAvailableAccount": false,
  "name": "",
  "surname": "",
  "taxNumber": "",
  "taxOfficeCode": ""
}'

Example Request Body

{
  "amount": 0,
  "birthDate": "",
  "currencyId": 0,
  "distraintNumber": "",
  "fatherName": "",
  "hasAvailableAccount": false,
  "name": "",
  "surname": "",
  "taxNumber": "",
  "taxOfficeCode": ""
}

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-outgoing-distraint-file-detail

DELETE

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`

delete-outgoing-distraint-file-detail › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

delete-outgoing-distraint-file-detail › Responses

No data returned

create-outgoing-distraint-file-salary

POST

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`

create-outgoing-distraint-file-salary › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

create-outgoing-distraint-file-salary › Request Body

salaryType

integer · int32 · required

accountNumber

string

organizationId

string · uuid

salaryAmount

number · decimal

create-outgoing-distraint-file-salary › 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-outgoing-distraint-file-salary-by-id

GET

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries/{outgoingDistraintFileSalaryId}

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

Field	Declared type	Nullable
`OutgoingDistraintFileDetailId`	`Guid`	no
`AccountNumber`	`string`	no
`OrganizationId`	`Guid?`	yes
`SalaryType`	`int`	no
`SalaryAmount`	`decimal?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`
`ERR_ACCNT_170`	400	`OUTGOING_DISTRAINT_FILE_SALARY_NOT_FOUND`

get-outgoing-distraint-file-salary-by-id › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

outgoingDistraintFileSalaryId

string · uuid · required

get-outgoing-distraint-file-salary-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-outgoing-distraint-file-salary

PUT

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries/{outgoingDistraintFileSalaryId}

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`

update-outgoing-distraint-file-salary › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

outgoingDistraintFileSalaryId

string · uuid · required

update-outgoing-distraint-file-salary › Request Body

salaryType

integer · int32 · required

accountNumber

string

organizationId

string · uuid

salaryAmount

number · decimal

update-outgoing-distraint-file-salary › Responses

No data returned

delete-outgoing-distraint-file-salary

DELETE

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

/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries/{outgoingDistraintFileSalaryId}

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
`ERR_ACCNT_167`	400	`OUTGOING_DISTRAINT_FILE_NOT_FOUND`
`ERR_ACCNT_168`	400	`OUTGOING_DISTRAINT_FILE_DETAIL_NOT_FOUND`
`ERR_ACCNT_170`	400	`OUTGOING_DISTRAINT_FILE_SALARY_NOT_FOUND`

delete-outgoing-distraint-file-salary › path Parameters

id

string · uuid · required

outgoingDistraintFileDetailId

string · uuid · required

outgoingDistraintFileSalaryId

string · uuid · required

delete-outgoing-distraint-file-salary › Responses

No data returned

matrix parameters