GET api/Hmrc

No documentation available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "SaveId": "95b57cd7-c7c9-440d-8551-c9c41cb43b72",
    "Status": "sample string 2",
    "SaleOrderId": "sample string 3",
    "SaleSaveId": "95c1c334-a31e-4f8e-9054-b7383fe0ca41",
    "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-08-04T21:56:09.5075353+00:00",
    "UpdatedDateTimeStamp": "2026-08-04T21:56:09.5075353+00:00",
    "HmrcAddresses": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "SaveId": "8252a8a1-2f22-4603-9338-2cfa67daddca",
          "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": "3a12f1e3-0b8b-46da-8497-aec6d2799f2a",
          "HmrcSaveId": "3491d7fa-fde8-4810-927d-9821c3fb2b01",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "HmrcDetailProducts": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "SaveId": "d1e8f40a-aaeb-474f-9698-a0f842eac215",
          "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": "2040eee6-2bde-406d-8180-eb5849691966",
          "ProductSaveId": "25c03d7f-b785-4958-9e8e-0ff200cf46b9",
          "HmrcDocumnet": {
            "$ref": "2"
          }
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "HmrcDetail": {
      "$id": "7",
      "HmrcSaveId": "855fa857-cd2d-4164-9386-fa5e69ddeaa3",
      "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": "1a98f9b9-affa-471a-a801-538000d27bb5",
      "HmrcDocumnet": {
        "$ref": "2"
      }
    },
    "HmrcHeader": {
      "$id": "8",
      "HmrcSaveId": "768d88ad-cb5b-44e8-be20-782ddf124a0e",
      "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": "1e387723-1942-40fd-8da2-0c811d518547",
          "Status": "sample string 2",
          "ProcessDate": "sample string 3",
          "ProcessUser": "sample string 4",
          "UserComments": "sample string 5",
          "HmrcSaveId": "36a44b2b-a50f-4933-a18f-38e7c33b1fa6",
          "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.