POST api/cost/externalimport

Import costs from any source.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PlanExternalId	string	None.
CostTypeId	globally unique identifier	None.
CostTypeName	string	None.
CustomCategories	Collection of ImportCostCustom	None.
DetailCategories	Collection of ImportCostDetail	None.
Costs	Collection of ImportCostObject	None.
Fields	Collection of ImportCostFields	None.
Delete	ImportDeleteCosts	None.

Request Formats

application/json, text/json

Sample:

{
  "PlanExternalId": "sample string 1",
  "CostTypeId": "87525fde-5f7e-4792-9f04-56bab4f7f1c0",
  "CostTypeName": "sample string 3",
  "CustomCategories": [
    {
      "CostName": "sample string 1",
      "CostExternalId": "sample string 2",
      "ParentCostExternalId": "sample string 3"
    },
    {
      "CostName": "sample string 1",
      "CostExternalId": "sample string 2",
      "ParentCostExternalId": "sample string 3"
    }
  ],
  "DetailCategories": [
    {
      "CostCategoryExternalId": "sample string 1",
      "DetailExternalId": "sample string 2",
      "Costs": [
        {
          "CostDate": "2025-10-30T12:42:05.7247757+00:00",
          "CostValue": 2.0
        },
        {
          "CostDate": "2025-10-30T12:42:05.7247757+00:00",
          "CostValue": 2.0
        }
      ],
      "Fields": [
        {
          "Fields": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "Fields": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "CostCategoryExternalId": "sample string 1",
      "DetailExternalId": "sample string 2",
      "Costs": [
        {
          "CostDate": "2025-10-30T12:42:05.7247757+00:00",
          "CostValue": 2.0
        },
        {
          "CostDate": "2025-10-30T12:42:05.7247757+00:00",
          "CostValue": 2.0
        }
      ],
      "Fields": [
        {
          "Fields": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "Fields": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "Costs": [
    {
      "CostExternalId": "sample string 1",
      "CostDate": "2025-10-30T12:42:05.7247757+00:00",
      "CostValue": 3.0
    },
    {
      "CostExternalId": "sample string 1",
      "CostDate": "2025-10-30T12:42:05.7247757+00:00",
      "CostValue": 3.0
    }
  ],
  "Fields": [
    {
      "CostExternalId": "sample string 1",
      "Fields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "CostExternalId": "sample string 1",
      "Fields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "Delete": {
    "StartDate": "2025-10-30T12:42:05.7247757+00:00",
    "EndDate": "2025-10-30T12:42:05.7247757+00:00",
    "Scope": 0
  }
}

Response Information

Resource Description

ImportResult

Name	Description	Type	Additional information
Status		ImportResultStatus	None.
Message		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Message": "sample string 1"
}