GET api/Hmrc

No documentation available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "SaveId": "cae5e530-a3a2-41fb-a82e-d63ec0f642bb",
    "Status": "sample string 2",
    "SaleOrderId": "sample string 3",
    "SaleSaveId": "87ead300-d070-4a87-a4f0-d5cd66a8cbaa",
    "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-11-05T05:20:54.4033099+00:00",
    "UpdatedDateTimeStamp": "2026-11-05T05:20:54.4033099+00:00",
    "HmrcAddresses": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "SaveId": "52756cd2-942c-41a4-97c2-0b84a380a246",
          "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": "ff3ee358-2954-42a1-862f-2f1d36aeb480",
          "HmrcSaveId": "d40bbab9-78a1-44c6-b81d-35c1cea907f7",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "HmrcDetailProducts": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "SaveId": "e1b507bf-a055-4cc5-a0c2-ab301aeeb8b5",
          "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": "0e951f03-a180-494f-b31e-2edb2b01ee1f",
          "ProductSaveId": "2a5a8b26-ad94-4373-ab59-ba803a86a029",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "HmrcDetail": {
      "$id": "7",
      "HmrcSaveId": "2ee1a2a4-f0ac-4cc0-a500-e82c8c6dff88",
      "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": "1b97c71f-10c8-497e-af55-3b30c833cd22",
      "HmrcDocumnet": {
        "$ref": "2"
      }
    },
    "HmrcHeader": {
      "$id": "8",
      "HmrcSaveId": "a9ab4744-deb7-42ce-a4a7-6766d6cacbf8",
      "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": "2"
      }
    },
    "HmrcHistories": {
      "$id": "9",
      "$values": [
        {
          "$id": "10",
          "SaveId": "00a5305d-f869-4653-b877-e15841ded2cc",
          "Status": "sample string 2",
          "ProcessDate": "sample string 3",
          "ProcessUser": "sample string 4",
          "UserComments": "sample string 5",
          "HmrcSaveId": "933f6d72-a484-4c9f-8cee-54c9c3a920a6",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "10"
        },
        {
          "$ref": "10"
        }
      ]
    }
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

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.