export-binders

Operations addressed under /export-binders — 5 operations.

get-export-binder-list

GET

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

/export-binders

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

get-export-binder-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-export-binder-list › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

binderAmount

number · decimal

binderStatus

string

currencyCode

string

customDeclerationFOBAmount

number · decimal

customDeclerationsNumber

string

customerId

string · uuid

exportPeriod

integer · int32

exporterAddress

string

exporterName

string

featuredTransactionType

string

goodType

string

id

string · uuid

importerAddress

string

importerName

string

loadingCountryCode

string

paymentType

referenceNumber

string

shipmentType

string

unLoadingCountryCode

string

GET/export-binders

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

Example Responses

{
  "binderAmount": 0,
  "binderStatus": "binderStatus",
  "currencyCode": "currencyCode",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "customDeclerationsNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "exportPeriod": 0,
  "exporterAddress": "exporterAddress",
  "exporterName": "exporterName",
  "featuredTransactionType": "featuredTransactionType",
  "goodType": "goodType",
  "id": "00000000-0000-0000-0000-000000000000",
  "importerAddress": "importerAddress",
  "importerName": "importerName",
  "loadingCountryCode": "loadingCountryCode",
  "paymentType": {},
  "referenceNumber": "referenceNumber",
  "shipmentType": "shipmentType",
  "unLoadingCountryCode": "unLoadingCountryCode"
}

json

application/json

create-export-binder

POST

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

/export-binders

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

create-export-binder › Request Body

binderAmount

number · decimal · required

binderStatus

string · required

currencyCode

string · required

customDeclerationFOBAmount

number · decimal · required

customDeclerationsNumber

string · required

customerId

string · uuid · required

exportPeriod

integer · int32 · required

exporterAddress

string · required

exporterName

string · required

featuredTransactionType

string · required

goodType

string · required

importerAddress

string · required

importerName

string · required

loadingCountryCode

string · required

paymentType

required

referenceNumber

string · required

shipmentType

string · required

unLoadingCountryCode

string · required

create-export-binder › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

POST/export-binders

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}'

Example Request Body

{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}

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-export-binder-by-id

GET

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

/export-binders/{id}

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

get-export-binder-by-id › path Parameters

id

string · uuid · required

get-export-binder-by-id › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

binderAmount

number · decimal

binderStatus

string

currencyCode

string

customDeclerationFOBAmount

number · decimal

customDeclerationsNumber

string

customerId

string · uuid

exportPeriod

integer · int32

exporterAddress

string

exporterName

string

featuredTransactionType

string

goodType

string

id

string · uuid

importerAddress

string

importerName

string

loadingCountryCode

string

paymentType

referenceNumber

string

shipmentType

string

unLoadingCountryCode

string

GET/export-binders/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders/:id

Example Responses

{
  "binderAmount": 0,
  "binderStatus": "binderStatus",
  "currencyCode": "currencyCode",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "customDeclerationsNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "exportPeriod": 0,
  "exporterAddress": "exporterAddress",
  "exporterName": "exporterName",
  "featuredTransactionType": "featuredTransactionType",
  "goodType": "goodType",
  "id": "00000000-0000-0000-0000-000000000000",
  "importerAddress": "importerAddress",
  "importerName": "importerName",
  "loadingCountryCode": "loadingCountryCode",
  "paymentType": {},
  "referenceNumber": "referenceNumber",
  "shipmentType": "shipmentType",
  "unLoadingCountryCode": "unLoadingCountryCode"
}

json

application/json

update-export-binder

PUT

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

/export-binders/{id}

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

update-export-binder › path Parameters

id

string · uuid · required

update-export-binder › Request Body

binderAmount

number · decimal · required

binderStatus

string · required

currencyCode

string · required

customDeclerationFOBAmount

number · decimal · required

customDeclerationsNumber

string · required

customerId

string · uuid · required

exportPeriod

integer · int32 · required

exporterAddress

string · required

exporterName

string · required

featuredTransactionType

string · required

goodType

string · required

importerAddress

string · required

importerName

string · required

loadingCountryCode

string · required

paymentType

required

referenceNumber

string · required

shipmentType

string · required

unLoadingCountryCode

string · required

update-export-binder › Responses

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

No data returned

PUT/export-binders/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}'

Example Request Body

{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}

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-export-binder

DELETE

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

/export-binders/{id}

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

delete-export-binder › path Parameters

id

string · uuid · required

delete-export-binder › Responses

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

No data returned

custom-declarations export-document-customs

Foreign Trade

export-binders

Operations addressed under /export-binders — 5 operations.

get-export-binder-list

GET

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

/export-binders

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

get-export-binder-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-export-binder-list › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

binderAmount

number · decimal

binderStatus

string

currencyCode

string

customDeclerationFOBAmount

number · decimal

customDeclerationsNumber

string

customerId

string · uuid

exportPeriod

integer · int32

exporterAddress

string

exporterName

string

featuredTransactionType

string

goodType

string

id

string · uuid

importerAddress

string

importerName

string

loadingCountryCode

string

paymentType

referenceNumber

string

shipmentType

string

unLoadingCountryCode

string

GET/export-binders

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

Example Responses

{
  "binderAmount": 0,
  "binderStatus": "binderStatus",
  "currencyCode": "currencyCode",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "customDeclerationsNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "exportPeriod": 0,
  "exporterAddress": "exporterAddress",
  "exporterName": "exporterName",
  "featuredTransactionType": "featuredTransactionType",
  "goodType": "goodType",
  "id": "00000000-0000-0000-0000-000000000000",
  "importerAddress": "importerAddress",
  "importerName": "importerName",
  "loadingCountryCode": "loadingCountryCode",
  "paymentType": {},
  "referenceNumber": "referenceNumber",
  "shipmentType": "shipmentType",
  "unLoadingCountryCode": "unLoadingCountryCode"
}

json

application/json

create-export-binder

POST

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

/export-binders

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

create-export-binder › Request Body

binderAmount

number · decimal · required

binderStatus

string · required

currencyCode

string · required

customDeclerationFOBAmount

number · decimal · required

customDeclerationsNumber

string · required

customerId

string · uuid · required

exportPeriod

integer · int32 · required

exporterAddress

string · required

exporterName

string · required

featuredTransactionType

string · required

goodType

string · required

importerAddress

string · required

importerName

string · required

loadingCountryCode

string · required

paymentType

required

referenceNumber

string · required

shipmentType

string · required

unLoadingCountryCode

string · required

create-export-binder › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

POST/export-binders

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}'

Example Request Body

{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}

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-export-binder-by-id

GET

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

/export-binders/{id}

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

get-export-binder-by-id › path Parameters

id

string · uuid · required

get-export-binder-by-id › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

binderAmount

number · decimal

binderStatus

string

currencyCode

string

customDeclerationFOBAmount

number · decimal

customDeclerationsNumber

string

customerId

string · uuid

exportPeriod

integer · int32

exporterAddress

string

exporterName

string

featuredTransactionType

string

goodType

string

id

string · uuid

importerAddress

string

importerName

string

loadingCountryCode

string

paymentType

referenceNumber

string

shipmentType

string

unLoadingCountryCode

string

GET/export-binders/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders/:id

Example Responses

{
  "binderAmount": 0,
  "binderStatus": "binderStatus",
  "currencyCode": "currencyCode",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "customDeclerationsNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "exportPeriod": 0,
  "exporterAddress": "exporterAddress",
  "exporterName": "exporterName",
  "featuredTransactionType": "featuredTransactionType",
  "goodType": "goodType",
  "id": "00000000-0000-0000-0000-000000000000",
  "importerAddress": "importerAddress",
  "importerName": "importerName",
  "loadingCountryCode": "loadingCountryCode",
  "paymentType": {},
  "referenceNumber": "referenceNumber",
  "shipmentType": "shipmentType",
  "unLoadingCountryCode": "unLoadingCountryCode"
}

json

application/json

update-export-binder

PUT

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

/export-binders/{id}

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

update-export-binder › path Parameters

id

string · uuid · required

update-export-binder › Request Body

binderAmount

number · decimal · required

binderStatus

string · required

currencyCode

string · required

customDeclerationFOBAmount

number · decimal · required

customDeclerationsNumber

string · required

customerId

string · uuid · required

exportPeriod

integer · int32 · required

exporterAddress

string · required

exporterName

string · required

featuredTransactionType

string · required

goodType

string · required

importerAddress

string · required

importerName

string · required

loadingCountryCode

string · required

paymentType

required

referenceNumber

string · required

shipmentType

string · required

unLoadingCountryCode

string · required

update-export-binder › Responses

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

No data returned

PUT/export-binders/{id}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/export-binders/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}'

Example Request Body

{
  "binderAmount": 0,
  "binderStatus": "",
  "currencyCode": "",
  "customDeclerationFOBAmount": 0,
  "customDeclerationsNumber": "",
  "customerId": "",
  "exportPeriod": 0,
  "exporterAddress": "",
  "exporterName": "",
  "featuredTransactionType": "",
  "goodType": "",
  "importerAddress": "",
  "importerName": "",
  "loadingCountryCode": "",
  "paymentType": "",
  "referenceNumber": "",
  "shipmentType": "",
  "unLoadingCountryCode": ""
}

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-export-binder

DELETE

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

/export-binders/{id}

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

delete-export-binder › path Parameters

id

string · uuid · required

delete-export-binder › Responses

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

No data returned

custom-declarations export-document-customs