GET api/Hmrc/GetHmrcDocumnet/{ucr}

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
ucr
No documentation available.

Define this parameter in the request URI.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "SaveId": "9bb153fb-d5fc-475f-876f-a1117204fc94",
  "Status": "sample string 2",
  "SaleOrderId": "sample string 3",
  "SaleSaveId": "b1ac0185-7fde-4663-8d44-47e6906504ad",
  "DocumentDate": "sample string 4",
  "DocumentNo": "sample string 5",
  "TenantId": "sample string 6",
  "DeclarantOrganisation": "sample string 7",
  "DeclarantTelelephone": "sample string 8",
  "DeclarationPlace": "sample string 9",
  "ChamberLaunched": true,
  "DeclarationDate": "sample string 11",
  "DeclarantName": "sample string 12",
  "DeclarantJoTitle": "sample string 13",
  "DeclarantSignature": "sample string 14",
  "PdfReport": "sample string 15",
  "CreatedDateTimeStamp": "2026-09-20T10:19:09.7855889+00:00",
  "UpdatedDateTimeStamp": "2026-09-20T10:19:09.7855889+00:00",
  "HmrcAddresses": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "SaveId": "6a5da853-66f5-48fd-9a6d-858a82042884",
        "NAType": "sample string 2",
        "LongName": "sample string 3",
        "ShortName": "sample string 4",
        "CountryId": "sample string 5",
        "CountryName": "sample string 6",
        "AddressLine1": "sample string 7",
        "AddressLine2": "sample string 8",
        "TownLocality": "sample string 9",
        "CityRegion": "sample string 10",
        "PostalZipCode": "sample string 11",
        "State": "sample string 12",
        "VATNumber": "sample string 13",
        "EORINumber": "sample string 14",
        "ContactSaveId": "a71d7583-e699-4eb9-b5c9-9d57f9edcb54",
        "HmrcSaveId": "12ecf832-8690-4d74-a4b1-45e995043736",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "HmrcDetailProducts": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "SaveId": "0686f24a-6147-4a34-a728-beda84ce98bd",
        "ProductId": "sample string 2",
        "CustomsProcedureCode": "sample string 3",
        "NetWeight": "sample string 4",
        "GoodsDescription": "sample string 5",
        "CommodityCode": "sample string 6",
        "GrossWeight": "sample string 7",
        "SupplementryUnits": "sample string 8",
        "StatedValue": "sample string 9",
        "ItemPrice": "sample string 10",
        "UNDGNCode": "sample string 11",
        "AICode": "sample string 12",
        "AIStatement": "sample string 13",
        "HmrcSaveId": "68c316c5-f949-4bc4-a2a1-e1ef5049b6bd",
        "ProductSaveId": "eb8e36e3-9913-4cb2-aa9a-4b398f850f10",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "HmrcDetail": {
    "$id": "6",
    "HmrcSaveId": "5296bd24-4446-4ff7-bc8e-b7ae1556d23c",
    "PackageType": "sample string 2",
    "PackageMarks": "sample string 3",
    "PackageCount": "sample string 4",
    "DocumentType": "sample string 5",
    "DocumentRefId": "sample string 6",
    "DocumentExportClass": "sample string 7",
    "DocumentLongName": "sample string 8",
    "CommercialInvoice": "sample string 9",
    "InvoiceSaveId": "40288269-c7bb-413e-bce8-942af5ac1bd7",
    "HmrcDocumnet": {
      "$ref": "1"
    }
  },
  "HmrcHeader": {
    "$id": "7",
    "HmrcSaveId": "106af52a-3911-43b8-8de4-8f609d36707a",
    "ClientRef": "sample string 2",
    "MessageType": "sample string 3",
    "DeclarationCcy": "sample string 4",
    "DeclarationRep": "sample string 5",
    "DeclarationUCR": "sample string 6",
    "DeparturePort": "sample string 7",
    "DestinationCountry": "sample string 8",
    "ConsignorId": "sample string 9",
    "ConsigneeId": "sample string 10",
    "TotalPackages": "sample string 11",
    "GoodsDepartureDate": "sample string 12",
    "SpecialCircimstances": "sample string 13",
    "InvoiceCcy": "sample string 14",
    "ExitOffice": "sample string 15",
    "MasterUCR": "sample string 16",
    "TransportModeCode": "sample string 17",
    "TrnasportModeInland": "sample string 18",
    "TransportCharges": "sample string 19",
    "SingleTransportContract": "sample string 20",
    "UKExportOffice": "sample string 21",
    "HmrcDocumnet": {
      "$ref": "1"
    }
  },
  "HmrcHistories": {
    "$id": "8",
    "$values": [
      {
        "$id": "9",
        "SaveId": "5906e9e5-4e5d-4bd5-95ad-12252b1c07e4",
        "Status": "sample string 2",
        "ProcessDate": "sample string 3",
        "ProcessUser": "sample string 4",
        "UserComments": "sample string 5",
        "HmrcSaveId": "9ab57032-45bd-4b53-8fa6-a04fce5347a2",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ]
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.