GET api/Hmrc

No documentation available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "SaveId": "7362ee93-f328-4349-b957-4b3fe37b05bc",
    "Status": "sample string 2",
    "SaleOrderId": "sample string 3",
    "SaleSaveId": "82a95f0d-44b9-40d9-ad5d-554b17210c89",
    "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-03-21T21:08:26.5296205+00:00",
    "UpdatedDateTimeStamp": "2026-03-21T21:08:26.5296205+00:00",
    "HmrcAddresses": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "SaveId": "f030fb69-9884-47f3-8599-12863f36c4df",
          "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": "d5c3e68f-0331-4be2-a0f5-0b2a62dcb7bf",
          "HmrcSaveId": "a0d190c3-dbcc-4c30-b294-b47df611b0b2",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "HmrcDetailProducts": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "SaveId": "4d03fc68-2c3f-4a7a-b331-adfaa0f1f6b1",
          "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": "1c453afa-15d4-446e-be6e-184b11b65a31",
          "ProductSaveId": "02fe22f5-1dae-4400-ad40-5403b1dfcc43",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "HmrcDetail": {
      "$id": "7",
      "HmrcSaveId": "1ce7c38d-a427-4b7c-b4c1-3c8bf7398f19",
      "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": "67a44240-1d5c-4004-ade2-0c0fec6c40d1",
      "HmrcDocumnet": {
        "$ref": "2"
      }
    },
    "HmrcHeader": {
      "$id": "8",
      "HmrcSaveId": "2dcc953d-187c-4ef7-9c50-a05c824a035a",
      "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": "7c9e877a-83ef-4663-b9da-6ecc738deaba",
          "Status": "sample string 2",
          "ProcessDate": "sample string 3",
          "ProcessUser": "sample string 4",
          "UserComments": "sample string 5",
          "HmrcSaveId": "619253c6-5d41-4665-88d3-1578575e0e8e",
          "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.