GET api/Cost/GetCostByCostID?costID={costID}&showInactive={showInactive}

Request Information

URI Parameters

Name	Description	Type	Additional information
costID		integer	Required
showInactive		boolean	Required

Body Parameters

None.

Response Information

Resource Description

CostEditVM

Name	Type	Additional information
Cost	CostModel	None.
CostChargingOption	AccountCostChargingOption	None.
MasterCostList	Collection of MasterCostForList	None.
MasterCostCategoryList	Collection of MasterCostCategoryForList	None.
CostTypeList	Collection of CostTypeForList	None.
SupplierList	Collection of ContactForList	None.
Response	IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Cost": {
    "CostID": 1,
    "EntityID": 1,
    "AccountID": 1,
    "InvoiceID": 1,
    "Reversed_CostID": 1,
    "InternalCost": 1.0,
    "AccountCost": 1.0,
    "EntityCost": 1.0,
    "InternalTax": 1.0,
    "AccountTax": 1.0,
    "EntityTax": 1.0,
    "InternalTaxRate": 1.0,
    "AccountTaxRate": 1.0,
    "EntityTaxRate": 1.0,
    "InternalReference": "sample string 1",
    "EntityReference": "sample string 2",
    "AccountReference": "sample string 3",
    "CostDate": "2025-09-02T23:09:32.4451019+00:00",
    "CurrencyID": 1,
    "CurrencyRate": 1.0,
    "ForeignInternalCost": 1.0,
    "ForeignInternalTax": 1.0,
    "Supplier_ContactID": 1,
    "NonClientVisible": true,
    "RemoveAtLegalIssue": true,
    "ToHost": true,
    "Deferred": true,
    "IncursInterest": true,
    "Recoverable": true,
    "LoadID": 1,
    "CreateID": 1,
    "CreateSessionID": 1,
    "CreateTS": "2025-09-02T23:09:32.4451019+00:00",
    "ModifyID": 1,
    "ModifySessionID": 1,
    "ModifyTS": "2025-09-02T23:09:32.4451019+00:00",
    "InactiveID": 1,
    "InactiveSessionID": 1,
    "InactiveTS": "2025-09-02T23:09:32.4451019+00:00",
    "StatusID": 1,
    "Z_DB": 1,
    "Z_ID": 1,
    "Reversed": true,
    "AccountingBatchID": 1,
    "MasterCostID": 1,
    "CostTypeID": 1,
    "UnDeferredTS": "2025-09-02T23:09:32.4451019+00:00",
    "Z_IDSTR": "sample string 4",
    "Z_REF": "sample string 5",
    "Z_REF2": "sample string 6",
    "Z_REF3": "sample string 7",
    "CostCategoryID": 1,
    "Source_AccountID": 1,
    "Source_CostID": 1,
    "MasterCostChargeID": 1,
    "RecoveredCostToEntity_CostID": 1,
    "ChargeRecoveredCostToEntity": true,
    "RecoveredCostToEntity_PaymentID": 1,
    "PaymentFees_PaymentID": 1,
    "DishonourFees_PaymentID": 1,
    "Supplier": "sample string 8",
    "ClientTransactionReference": "sample string 9",
    "ClientTransactionID": 1,
    "LUPPaidByCredit": true,
    "Deferred_Legal_Approval": true,
    "UndeferredTS_Legal_Approval": "2025-09-02T23:09:32.4451019+00:00",
    "Solicitor_ContactID": 1,
    "SolicitorInvoiceNo": "sample string 10",
    "SolicitorInvoiceNoUpdatedBy": 1,
    "SolicitorInvoiceNoUpdatedTS": "2025-09-02T23:09:32.4451019+00:00",
    "WorkflowLineID": 1,
    "InternalDescription": "sample string 11",
    "AccountDescription": "sample string 12",
    "EntityDescription": "sample string 13",
    "EnforceableTS": "2025-09-02T23:09:32.4451019+00:00",
    "ReverseReason": "sample string 14",
    "PresetReversalReasonID": 1,
    "PresetReversalType": "sample string 15",
    "PresetReverseReason": "sample string 16",
    "PresetReverseCode": "sample string 17",
    "ReviewID": 1,
    "IsEnforceable": true
  },
  "CostChargingOption": {
    "AccountID": 1,
    "CostChargingOption": 1,
    "IsIneheritedFromEntity": 2
  },
  "MasterCostList": [
    {
      "MasterCostID": 1,
      "MasterCost": "sample string 2"
    },
    {
      "MasterCostID": 1,
      "MasterCost": "sample string 2"
    }
  ],
  "MasterCostCategoryList": [
    {
      "MasterCostCategoryID": 1,
      "MasterCostCategory": "sample string 2"
    },
    {
      "MasterCostCategoryID": 1,
      "MasterCostCategory": "sample string 2"
    }
  ],
  "CostTypeList": [
    {
      "CostTypeID": 1,
      "CostType": "sample string 2",
      "IsDebtorCost": true
    },
    {
      "CostTypeID": 1,
      "CostType": "sample string 2",
      "IsDebtorCost": true
    }
  ],
  "SupplierList": [
    {
      "ContactID": 1,
      "Name": "sample string 2",
      "IsChecked": true,
      "ContactIDEncrypted": "sample string 4",
      "RelationshipID": 5
    },
    {
      "ContactID": 1,
      "Name": "sample string 2",
      "IsChecked": true,
      "ContactIDEncrypted": "sample string 4",
      "RelationshipID": 5
    }
  ],
  "Response": null
}

application/xml, text/xml

Sample:

<CostEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Cost">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <Cost xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Cost">
    <d2p1:AccountCost>1</d2p1:AccountCost>
    <d2p1:AccountDescription>sample string 12</d2p1:AccountDescription>
    <d2p1:AccountID>1</d2p1:AccountID>
    <d2p1:AccountReference>sample string 3</d2p1:AccountReference>
    <d2p1:AccountTax>1</d2p1:AccountTax>
    <d2p1:AccountTaxRate>1</d2p1:AccountTaxRate>
    <d2p1:AccountingBatchID>1</d2p1:AccountingBatchID>
    <d2p1:ChargeRecoveredCostToEntity>true</d2p1:ChargeRecoveredCostToEntity>
    <d2p1:ClientTransactionID>1</d2p1:ClientTransactionID>
    <d2p1:ClientTransactionReference>sample string 9</d2p1:ClientTransactionReference>
    <d2p1:CostCategoryID>1</d2p1:CostCategoryID>
    <d2p1:CostDate>2025-09-02T23:09:32.4451019+00:00</d2p1:CostDate>
    <d2p1:CostID>1</d2p1:CostID>
    <d2p1:CostTypeID>1</d2p1:CostTypeID>
    <d2p1:CreateID>1</d2p1:CreateID>
    <d2p1:CreateSessionID>1</d2p1:CreateSessionID>
    <d2p1:CreateTS>2025-09-02T23:09:32.4451019+00:00</d2p1:CreateTS>
    <d2p1:CurrencyID>1</d2p1:CurrencyID>
    <d2p1:CurrencyRate>1</d2p1:CurrencyRate>
    <d2p1:Deferred>true</d2p1:Deferred>
    <d2p1:Deferred_Legal_Approval>true</d2p1:Deferred_Legal_Approval>
    <d2p1:DishonourFees_PaymentID>1</d2p1:DishonourFees_PaymentID>
    <d2p1:EnforceableTS>2025-09-02T23:09:32.4451019+00:00</d2p1:EnforceableTS>
    <d2p1:EntityCost>1</d2p1:EntityCost>
    <d2p1:EntityDescription>sample string 13</d2p1:EntityDescription>
    <d2p1:EntityID>1</d2p1:EntityID>
    <d2p1:EntityReference>sample string 2</d2p1:EntityReference>
    <d2p1:EntityTax>1</d2p1:EntityTax>
    <d2p1:EntityTaxRate>1</d2p1:EntityTaxRate>
    <d2p1:ForeignInternalCost>1</d2p1:ForeignInternalCost>
    <d2p1:ForeignInternalTax>1</d2p1:ForeignInternalTax>
    <d2p1:InactiveID>1</d2p1:InactiveID>
    <d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
    <d2p1:InactiveTS>2025-09-02T23:09:32.4451019+00:00</d2p1:InactiveTS>
    <d2p1:IncursInterest>true</d2p1:IncursInterest>
    <d2p1:InternalCost>1</d2p1:InternalCost>
    <d2p1:InternalDescription>sample string 11</d2p1:InternalDescription>
    <d2p1:InternalReference>sample string 1</d2p1:InternalReference>
    <d2p1:InternalTax>1</d2p1:InternalTax>
    <d2p1:InternalTaxRate>1</d2p1:InternalTaxRate>
    <d2p1:InvoiceID>1</d2p1:InvoiceID>
    <d2p1:IsEnforceable>true</d2p1:IsEnforceable>
    <d2p1:LUPPaidByCredit>true</d2p1:LUPPaidByCredit>
    <d2p1:LoadID>1</d2p1:LoadID>
    <d2p1:MasterCostChargeID>1</d2p1:MasterCostChargeID>
    <d2p1:MasterCostID>1</d2p1:MasterCostID>
    <d2p1:ModifyID>1</d2p1:ModifyID>
    <d2p1:ModifySessionID>1</d2p1:ModifySessionID>
    <d2p1:ModifyTS>2025-09-02T23:09:32.4451019+00:00</d2p1:ModifyTS>
    <d2p1:NonClientVisible>true</d2p1:NonClientVisible>
    <d2p1:PaymentFees_PaymentID>1</d2p1:PaymentFees_PaymentID>
    <d2p1:PresetReversalReasonID>1</d2p1:PresetReversalReasonID>
    <d2p1:PresetReversalType>sample string 15</d2p1:PresetReversalType>
    <d2p1:PresetReverseCode>sample string 17</d2p1:PresetReverseCode>
    <d2p1:PresetReverseReason>sample string 16</d2p1:PresetReverseReason>
    <d2p1:Recoverable>true</d2p1:Recoverable>
    <d2p1:RecoveredCostToEntity_CostID>1</d2p1:RecoveredCostToEntity_CostID>
    <d2p1:RecoveredCostToEntity_PaymentID>1</d2p1:RecoveredCostToEntity_PaymentID>
    <d2p1:RemoveAtLegalIssue>true</d2p1:RemoveAtLegalIssue>
    <d2p1:ReverseReason>sample string 14</d2p1:ReverseReason>
    <d2p1:Reversed>true</d2p1:Reversed>
    <d2p1:Reversed_CostID>1</d2p1:Reversed_CostID>
    <d2p1:ReviewID>1</d2p1:ReviewID>
    <d2p1:SolicitorInvoiceNo>sample string 10</d2p1:SolicitorInvoiceNo>
    <d2p1:SolicitorInvoiceNoUpdatedBy>1</d2p1:SolicitorInvoiceNoUpdatedBy>
    <d2p1:SolicitorInvoiceNoUpdatedTS>2025-09-02T23:09:32.4451019+00:00</d2p1:SolicitorInvoiceNoUpdatedTS>
    <d2p1:Solicitor_ContactID>1</d2p1:Solicitor_ContactID>
    <d2p1:Source_AccountID>1</d2p1:Source_AccountID>
    <d2p1:Source_CostID>1</d2p1:Source_CostID>
    <d2p1:StatusID>1</d2p1:StatusID>
    <d2p1:Supplier>sample string 8</d2p1:Supplier>
    <d2p1:Supplier_ContactID>1</d2p1:Supplier_ContactID>
    <d2p1:ToHost>true</d2p1:ToHost>
    <d2p1:UnDeferredTS>2025-09-02T23:09:32.4451019+00:00</d2p1:UnDeferredTS>
    <d2p1:UndeferredTS_Legal_Approval>2025-09-02T23:09:32.4451019+00:00</d2p1:UndeferredTS_Legal_Approval>
    <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
    <d2p1:Z_DB>1</d2p1:Z_DB>
    <d2p1:Z_ID>1</d2p1:Z_ID>
    <d2p1:Z_IDSTR>sample string 4</d2p1:Z_IDSTR>
    <d2p1:Z_REF>sample string 5</d2p1:Z_REF>
    <d2p1:Z_REF2>sample string 6</d2p1:Z_REF2>
    <d2p1:Z_REF3>sample string 7</d2p1:Z_REF3>
  </Cost>
  <CostChargingOption xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Account">
    <d2p1:AccountID>1</d2p1:AccountID>
    <d2p1:CostChargingOption>1</d2p1:CostChargingOption>
    <d2p1:IsIneheritedFromEntity>2</d2p1:IsIneheritedFromEntity>
  </CostChargingOption>
  <CostTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.CostType">
    <d2p1:CostTypeForList>
      <d2p1:CostType>sample string 2</d2p1:CostType>
      <d2p1:CostTypeID>1</d2p1:CostTypeID>
      <d2p1:IsDebtorCost>true</d2p1:IsDebtorCost>
    </d2p1:CostTypeForList>
    <d2p1:CostTypeForList>
      <d2p1:CostType>sample string 2</d2p1:CostType>
      <d2p1:CostTypeID>1</d2p1:CostTypeID>
      <d2p1:IsDebtorCost>true</d2p1:IsDebtorCost>
    </d2p1:CostTypeForList>
  </CostTypeList>
  <MasterCostCategoryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.MasterCostCategory">
    <d2p1:MasterCostCategoryForList>
      <d2p1:MasterCostCategory>sample string 2</d2p1:MasterCostCategory>
      <d2p1:MasterCostCategoryID>1</d2p1:MasterCostCategoryID>
    </d2p1:MasterCostCategoryForList>
    <d2p1:MasterCostCategoryForList>
      <d2p1:MasterCostCategory>sample string 2</d2p1:MasterCostCategory>
      <d2p1:MasterCostCategoryID>1</d2p1:MasterCostCategoryID>
    </d2p1:MasterCostCategoryForList>
  </MasterCostCategoryList>
  <MasterCostList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.MasterCost">
    <d2p1:MasterCostForList>
      <d2p1:MasterCost>sample string 2</d2p1:MasterCost>
      <d2p1:MasterCostID>1</d2p1:MasterCostID>
    </d2p1:MasterCostForList>
    <d2p1:MasterCostForList>
      <d2p1:MasterCost>sample string 2</d2p1:MasterCost>
      <d2p1:MasterCostID>1</d2p1:MasterCostID>
    </d2p1:MasterCostForList>
  </MasterCostList>
  <SupplierList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact">
    <d2p1:ContactForList>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RelationshipID>5</d2p1:RelationshipID>
    </d2p1:ContactForList>
    <d2p1:ContactForList>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RelationshipID>5</d2p1:RelationshipID>
    </d2p1:ContactForList>
  </SupplierList>
</CostEditVM>