export-lc-documents
Operations addressed under /export-lc-documents — 8 operations.
get-export-lCDocument-list
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<ExportLCDocumentDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
DocumentNumber | string | no |
DocumentAmount | decimal | no |
DemandedAmount | decimal | no |
DocumentSender | string | no |
SenderReference | string | no |
DocumentHolder | string | no |
CorrespondentCharge | decimal? | yes |
DocumentEntryDate | DateTime | no |
DueStartingDate | DateTime? | yes |
PaymentDueDate | DateTime | no |
OurBankCharge | decimal | no |
DocumentStatus | string | no |
ShipName | string | no |
ShipperName | string | no |
LoadingPort | string | no |
DischargePort | string | no |
Notes | string | no |
Explanations | string | no |
Status | string | no |
IsDocumentExamRequired | bool? | yes |
DiscrepancyStatus | string | no |
NegotiationStatus | string | no |
DueDateConfirmationStatus | string | no |
ExportLCId | Guid? | yes |
GroupGuid | string | no |
LcDocumentSwiftMessageType | string | no |
LcDocumentSwift34AMessage | string | no |
LcDocumentSwift34BMessage | string | no |
LcDocumentSwift71DMessage | string | no |
LcDocumentSwift77Message | string | no |
LcDocumentSwift72ZMessage | string | no |
LcDocumentSwift73AMessage | string | no |
LcDocumentSwift77JMessage | string | no |
LcDocumentSwift79Message | string | no |
ExportLCDeliveryDocumentList | List<ExportLCDeliveryDocumentDto> (collection) | no |
ExportLCDocumentGoodsDetailList | List<ExportLCDocumentGoodsDetailDto> (collection) | no |
ExportLCDocumentReserveList | List<ExportLCDocumentReserveDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-export-lCDocument-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-export-lCDocument
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 |
|---|---|---|
ERR_FRGN_TRD_51 | 400 | EXPORT_LETTER_CREDIT_NOT_FOUND |
ERR_FRGN_TRD_55 | 400 | EXCEEDING_AVAILABLE_LC_AMOUNT |
create-export-lCDocument › Request Body optional
correspondentChargedemandedAmountdischargePortdiscrepancyStatusdocumentAmountdocumentEntryDatedocumentHolderdocumentNumberdocumentSenderdocumentStatusdueDateConfirmationStatusdueStartingDateexplanationsexportLCIdgroupGuidisDocumentExamRequiredlcDocumentSwift34AMessagelcDocumentSwift34BMessagelcDocumentSwift71DMessagelcDocumentSwift72ZMessagelcDocumentSwift73AMessagelcDocumentSwift77JMessagelcDocumentSwift77MessagelcDocumentSwift79MessagelcDocumentSwiftMessageTypeloadingPortnegotiationStatusnotesourBankChargepaymentDueDatesenderReferenceshipNameshipperNamestatuscreate-export-lCDocument › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
export-lc-document-list-count
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 int, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.
export-lc-document-list-count › 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.
get-export-lCDocument-by-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 ExportLCDocumentDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
DocumentNumber | string | no |
DocumentAmount | decimal | no |
DemandedAmount | decimal | no |
DocumentSender | string | no |
SenderReference | string | no |
DocumentHolder | string | no |
CorrespondentCharge | decimal? | yes |
DocumentEntryDate | DateTime | no |
DueStartingDate | DateTime? | yes |
PaymentDueDate | DateTime | no |
OurBankCharge | decimal | no |
DocumentStatus | string | no |
ShipName | string | no |
ShipperName | string | no |
LoadingPort | string | no |
DischargePort | string | no |
Notes | string | no |
Explanations | string | no |
Status | string | no |
IsDocumentExamRequired | bool? | yes |
DiscrepancyStatus | string | no |
NegotiationStatus | string | no |
DueDateConfirmationStatus | string | no |
ExportLCId | Guid? | yes |
GroupGuid | string | no |
LcDocumentSwiftMessageType | string | no |
LcDocumentSwift34AMessage | string | no |
LcDocumentSwift34BMessage | string | no |
LcDocumentSwift71DMessage | string | no |
LcDocumentSwift77Message | string | no |
LcDocumentSwift72ZMessage | string | no |
LcDocumentSwift73AMessage | string | no |
LcDocumentSwift77JMessage | string | no |
LcDocumentSwift79Message | string | no |
ExportLCDeliveryDocumentList | List<ExportLCDeliveryDocumentDto> (collection) | no |
ExportLCDocumentGoodsDetailList | List<ExportLCDocumentGoodsDetailDto> (collection) | no |
ExportLCDocumentReserveList | List<ExportLCDocumentReserveDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_46 | 400 | EXPORT_LC_DOCUMENT_NOT_FOUND |
path Parameters
idget-export-lCDocument-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-export-lCDocument
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_46 | 400 | EXPORT_LC_DOCUMENT_NOT_FOUND |
ERR_FRGN_TRD_51 | 400 | EXPORT_LETTER_CREDIT_NOT_FOUND |
ERR_FRGN_TRD_55 | 400 | EXCEEDING_AVAILABLE_LC_AMOUNT |
path Parameters
idupdate-export-lCDocument › Request Body
correspondentChargedemandedAmountdischargePortdiscrepancyStatusdocumentAmountdocumentEntryDatedocumentHolderdocumentNumberdocumentSenderdocumentStatusdueDateConfirmationStatusdueStartingDateexplanationsexportLCIdgroupGuidisDocumentExamRequiredlcDocumentSwift34AMessagelcDocumentSwift34BMessagelcDocumentSwift71DMessagelcDocumentSwift72ZMessagelcDocumentSwift73AMessagelcDocumentSwift77JMessagelcDocumentSwift77MessagelcDocumentSwift79MessagelcDocumentSwiftMessageTypeloadingPortnegotiationStatusnotesourBankChargepaymentDueDatesenderReferenceshipNameshipperNamestatusupdate-export-lCDocument › 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.
delete-export-lCDocument
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_46 | 400 | EXPORT_LC_DOCUMENT_NOT_FOUND |
path Parameters
iddelete-export-lCDocument › 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.
set-export-lCDocument-add-due-date-confirmation
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_46 | 400 | EXPORT_LC_DOCUMENT_NOT_FOUND |
path Parameters
idset-export-lCDocument-add-due-date-confirmation › Request Body
dueDateConfirmationStatusset-export-lCDocument-add-due-date-confirmation › 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.
set-export-lCDocument-status
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_46 | 400 | EXPORT_LC_DOCUMENT_NOT_FOUND |
ERR_FRGN_TRD_56 | 400 | ARGUMENT_CANNOT_BE_NULL_OR_EMPTY |
ERR_FRGN_TRD_57 | 400 | INVALID_ARGUMENTS |
path Parameters
idset-export-lCDocument-status › 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.