LukeParke/speakeasy-playground
1
0
Fork 0
mirror of https://github.com/LukeHagar/speakeasy-playground.git synced 2025-12-07 04:21:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

generate sdk

Browse Source
This commit is contained in:
Mike Lueders
2024-03-01 12:52:50 -06:00
parent 9246389907
commit 14c449163c
593 changed files with 29833 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/models/components/customsdeclarationcreaterequest.md Normal file
View File

@@ -0,0 +1,30 @@
# CustomsDeclarationCreateRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `certify` | *bool* | :heavy_check_mark: | Expresses that the certify_signer has provided all information of this customs declaration truthfully. | true |
| `certify_signer` | *str* | :heavy_check_mark: | Name of the person who created the customs declaration and is responsible for the validity of all <br/>information provided. | Shawn Ippotle |
| `contents_type` | [components.CustomsDeclarationCreateRequestContentsType](../../models/components/customsdeclarationcreaterequestcontentstype.md) | :heavy_check_mark: | Type of goods of the shipment. | MERCHANDISE |
| `non_delivery_option` | [components.CustomsDeclarationCreateRequestNonDeliveryOption](../../models/components/customsdeclarationcreaterequestnondeliveryoption.md) | :heavy_check_mark: | Indicates how the carrier should proceed in case the shipment can't be delivered. | |
| `items` | List[[components.CustomsItemBase](../../models/components/customsitembase.md)] | :heavy_check_mark: | N/A | |
| `aes_itn` | *Optional[str]* | :heavy_minus_sign: | **required if eel_pfc is `AES_ITN`**<br><br/>AES / ITN reference of the shipment. | |
| `b13a_filing_option` | [Optional[components.CustomsDeclarationCreateRequestB13aFilingOption]](../../models/components/customsdeclarationcreaterequestb13afilingoption.md) | :heavy_minus_sign: | B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). <br/><a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a> | |
| `b13a_number` | *Optional[str]* | :heavy_minus_sign: | **must be provided if and only if b13a_filing_option is provided**<br><br/>Represents:<br> the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;<br> <br/>the Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;<br> <br/>or the Exemption Number when b13a_filing_option is `NOT_REQUIRED`. | |
| `certificate` | *Optional[str]* | :heavy_minus_sign: | Certificate reference of the shipment. | |
| `commercial_invoice` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `contents_explanation` | *Optional[str]* | :heavy_minus_sign: | **required if contents_type is `OTHER`**<br><br/>Explanation of the type of goods of the shipment. | T-Shirt purchase |
| `disclaimer` | *Optional[str]* | :heavy_minus_sign: | Disclaimer for the shipment and customs information that have been provided. | |
| `eel_pfc` | [Optional[components.CustomsDeclarationCreateRequestEelPfc]](../../models/components/customsdeclarationcreaterequesteelpfc.md) | :heavy_minus_sign: | EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most <br/>other shipments from the US, `NOEEI_30_37_a` is applicable. | NOEEI_30_37_a |
| `exporter_reference` | *Optional[str]* | :heavy_minus_sign: | Exporter reference of an export shipment. | |
| `importer_reference` | *Optional[str]* | :heavy_minus_sign: | Importer reference of an import shipment. | |
| `incoterm` | [Optional[components.CustomsDeclarationCreateRequestIncoterm]](../../models/components/customsdeclarationcreaterequestincoterm.md) | :heavy_minus_sign: | The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. <br/>eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.<br/>If expecting DAP for other carriers, please use DDU. | DDP |
| `is_vat_collected` | *Optional[Any]* | :heavy_minus_sign: | Indicates whether the shipment's destination VAT has been collected. May be required for some destinations. | |
| `invoice` | *Optional[str]* | :heavy_minus_sign: | Invoice reference of the shipment. | #123123 |
| `license` | *Optional[str]* | :heavy_minus_sign: | License reference of the shipment. | |
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | Order ID #123123 |
| `notes` | *Optional[str]* | :heavy_minus_sign: | Additional notes to be included in the customs declaration. | |
| `address_importer` | [Optional[components.AddressImporter]](../../models/components/addressimporter.md) | :heavy_minus_sign: | Object that represents the address of the importer | |
| `test` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |