cash-declarations

Operations addressed under /cash-declarations — 5 operations.

get-all-cash-declaration-form-list

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

get-all-cash-declaration-form-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-all-cash-declaration-form-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

create-cash-declaration-form

POST

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_37`	400	`ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS`

create-cash-declaration-form › Request Body

accountNumber

string · required

address

string · required

amount

number · decimal · required

object[] · required

cashDeclarationFormDate

string · date-time · required

city

string · required

confirmed

boolean · required

currencyCode

string · required

customerId

string · uuid · required

issuingCustomsAuthority

string · required

nbfVerificationCode

string · required

onBehalf

string · required

originCountry

string · required

purposeOfUsage

string · required

registrationNumber

string · required

taxNumber

string · required

create-cash-declaration-form › Responses

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

No data returned

POST/cash-declarations

curl https://dg-sandbox.dgpays.com/foreign-trade-service/cash-declarations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeOfUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}'

Example Request Body

{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeOfUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}

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

get-cash-declaration-form-by-id

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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 CashDeclarationDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

get-cash-declaration-form-by-id › path Parameters

id

string · uuid · required

get-cash-declaration-form-by-id › Responses

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

No data returned

update-cash-declaration-form

PUT

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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_FRGN_TRD_37`	400	`ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS`
`ERR_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

update-cash-declaration-form › path Parameters

id

string · uuid · required

update-cash-declaration-form › Request Body

accountNumber

string · required

address

string · required

amount

number · decimal · required

object[] · required

cashDeclarationFormDate

string · date-time · required

city

string · required

confirmed

boolean · required

currencyCode

string · required

customerId

string · uuid · required

issuingCustomsAuthority

string · required

nbfVerificationCode

string · required

onBehalf

string · required

originCountry

string · required

purposeofUsage

string · required

registrationNumber

string · required

taxNumber

string · required

update-cash-declaration-form › 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

PUT/cash-declarations/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/cash-declarations/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeofUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}'

Example Request Body

{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeofUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}

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-declaration-form

DELETE

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

delete-cash-declaration-form › path Parameters

id

string · uuid · required

delete-cash-declaration-form › Responses

No data returned

cash-declaration-account-activities compensating-transactions

Foreign Trade

cash-declarations

Operations addressed under /cash-declarations — 5 operations.

get-all-cash-declaration-form-list

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

get-all-cash-declaration-form-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-all-cash-declaration-form-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

create-cash-declaration-form

POST

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_37`	400	`ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS`

create-cash-declaration-form › Request Body

accountNumber

string · required

address

string · required

amount

number · decimal · required

object[] · required

cashDeclarationFormDate

string · date-time · required

city

string · required

confirmed

boolean · required

currencyCode

string · required

customerId

string · uuid · required

issuingCustomsAuthority

string · required

nbfVerificationCode

string · required

onBehalf

string · required

originCountry

string · required

purposeOfUsage

string · required

registrationNumber

string · required

taxNumber

string · required

create-cash-declaration-form › Responses

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

No data returned

POST/cash-declarations

curl https://dg-sandbox.dgpays.com/foreign-trade-service/cash-declarations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeOfUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}'

Example Request Body

{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeOfUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}

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

get-cash-declaration-form-by-id

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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 CashDeclarationDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`CustomerName`	`string`	no
`AccountNumber`	`string`	no
`RegistrationNumber`	`string`	no
`NbfVerificationCode`	`string`	no
`CashDeclarationFormDate`	`DateTime`	no
`IssuingCustomsAuthority`	`string`	no
`Amount`	`decimal`	no
`CurrencyCode`	`string`	no
`OriginCountry`	`string`	no
`OnBehalf`	`string`	no
`TaxNumber`	`string`	no
`City`	`string`	no
`Address`	`string`	no
`Confirmed`	`bool`	no
`PurposeofUsage`	`string`	no
`DepositedAmountSum`	`decimal`	no
`RemainingBalance`	`decimal`	no
`CashDeclarationAccountActivities`	`List<CashDeclarationAccountActivityDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

get-cash-declaration-form-by-id › path Parameters

id

string · uuid · required

get-cash-declaration-form-by-id › Responses

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

No data returned

update-cash-declaration-form

PUT

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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_FRGN_TRD_37`	400	`ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS`
`ERR_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

update-cash-declaration-form › path Parameters

id

string · uuid · required

update-cash-declaration-form › Request Body

accountNumber

string · required

address

string · required

amount

number · decimal · required

object[] · required

cashDeclarationFormDate

string · date-time · required

city

string · required

confirmed

boolean · required

currencyCode

string · required

customerId

string · uuid · required

issuingCustomsAuthority

string · required

nbfVerificationCode

string · required

onBehalf

string · required

originCountry

string · required

purposeofUsage

string · required

registrationNumber

string · required

taxNumber

string · required

update-cash-declaration-form › Responses

No data returned

PUT/cash-declarations/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/cash-declarations/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeofUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}'

Example Request Body

{
  "accountNumber": "",
  "address": "",
  "amount": 0,
  "cashDeclarationAccountActivityInputModelList": [
    {
      "chargedPerson": "",
      "depositedAmount": 0,
      "depositedCurrencyCode": "",
      "reference": ""
    }
  ],
  "cashDeclarationFormDate": "",
  "city": "",
  "confirmed": false,
  "currencyCode": "",
  "customerId": "",
  "issuingCustomsAuthority": "",
  "nbfVerificationCode": "",
  "onBehalf": "",
  "originCountry": "",
  "purposeofUsage": "",
  "registrationNumber": "",
  "taxNumber": ""
}

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-declaration-form

DELETE

https://dg-sandbox.dgpays.com/foreign-trade-service

/cash-declarations/{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_FRGN_TRD_38`	400	`CASH_DECLARATION_FORM_NOT_FOUND`

delete-cash-declaration-form › path Parameters

id

string · uuid · required

delete-cash-declaration-form › Responses

No data returned

cash-declaration-account-activities compensating-transactions