POST api/Hmrc

No documentation available.

Request Information

Parameters

Name	Description	Additional information
hmrcDocumnet	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "SaveId": "1dfa1bed-e737-42ae-b10e-8d7b2bdcd093",
  "Status": "sample string 2",
  "SaleOrderId": "sample string 3",
  "SaleSaveId": "b082ae59-eded-42a8-a91f-130263be6275",
  "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.4345699+00:00",
  "UpdatedDateTimeStamp": "2026-11-05T05:20:54.4345699+00:00",
  "HmrcAddresses": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "SaveId": "1d937290-d269-4f62-a31e-79c3b00c97b4",
        "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": "82e49d09-60c5-404b-a645-356789a04756",
        "HmrcSaveId": "3be25eec-9ca3-45fc-90b1-1b8d9af44392",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "HmrcDetailProducts": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "SaveId": "4912ee8b-2218-4696-9c88-bd390372f417",
        "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": "20368253-e556-4057-9093-a14ddd3cd977",
        "ProductSaveId": "ec8cc15d-969b-4f59-8dcb-3d17b716602f",
        "HmrcDocumnet": {
          "$ref": "1"
        }
      },
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "HmrcDetail": {
    "$id": "6",
    "HmrcSaveId": "845092f4-732b-4711-9ab6-bbb9f02c11d9",
    "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": "c2c1d59d-50f7-4f66-b47c-0dac77953d7d",
    "HmrcDocumnet": {
      "$ref": "1"
    }
  },
  "HmrcHeader": {
    "$id": "7",
    "HmrcSaveId": "a921fe07-3e00-4ac8-8b19-31a87c846080",
    "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": "8a6b3e72-298b-4d23-aa29-13a2e9cf1978",
        "Status": "sample string 2",
        "ProcessDate": "sample string 3",
        "ProcessUser": "sample string 4",
        "UserComments": "sample string 5",
        "HmrcSaveId": "3eaf1b30-6fd2-4c9b-8e7e-56d2df91e7ae",
        "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.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'HmrcDocumnet'.

Response Information

No documentation available.

Response body formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.