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": "ff2f66d3-53d8-4be7-b988-66c5a22808f9",
  "Status": "sample string 2",
  "SaleOrderId": "sample string 3",
  "SaleSaveId": "e979913c-fe64-44da-84d4-7307f2b612f9",
  "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": "2025-09-18T03:37:45.8481058+00:00",
  "UpdatedDateTimeStamp": "2025-09-18T03:37:45.8481058+00:00",
  "HmrcAddresses": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "SaveId": "eaf1030f-fe31-4920-ada8-f82b08fab02d",
        "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": "25b8c1d8-51ef-4a05-b050-019429368692",
        "HmrcSaveId": "e21d0826-18cf-447a-a224-be97e2b2850b",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "HmrcDetailProducts": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "SaveId": "9e7676c2-8111-47ad-9442-e9ed81906bb2",
        "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": "8ffa5f50-4daa-468e-a259-efec637a0cd6",
        "ProductSaveId": "0604b25e-5140-4777-8630-f6601fd15bdb",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "HmrcDetail": {
    "$id": "6",
    "HmrcSaveId": "d7de98f2-8a14-4058-9355-be1c9298053f",
    "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": "7714c95f-2dda-4572-afdf-d8d16d26ba4f",
    "HmrcDocumnet": {
      "$ref": "1"
    }
  },
  "HmrcHeader": {
    "$id": "7",
    "HmrcSaveId": "74c1509a-2086-487f-918d-ded44bd6c038",
    "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": "e96a6cec-8b74-4b20-8df6-5105f5136dab",
        "Status": "sample string 2",
        "ProcessDate": "sample string 3",
        "ProcessUser": "sample string 4",
        "UserComments": "sample string 5",
        "HmrcSaveId": "be807237-2113-4f08-bcd1-632ea3053060",
        "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.