POST api/Letter/Deactivate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccountID	integer	None.
LetterID	integer	None.
Document	string	None.
CommunicationID	integer	None.
DocumentID	integer	None.
DocumentTemplateID	integer	None.
DocumentTemplateTypeID	integer	None.
HasArrangement	boolean	None.
HasContact	boolean	None.
HasCost	boolean	None.
HasPayment	boolean	None.
HasLegal	boolean	None.
HasAccountIncident	boolean	None.
HasWorkflowLine	boolean	None.
ContactID	integer	None.
PaymentID	integer	None.
CostID	integer	None.
LegalID	integer	None.
ArrangementID	integer	None.
WorkflowLineID	integer	None.
AccountIncidentID	integer	None.
PrintStatusID	integer	None.
SkipAddressesWithNoBarcode	boolean	None.
AddressStatusIDsFilter	string	None.
SkipIfAddressDoesNotExist	boolean	None.
ContactList	Collection of ContactForList	None.
ArrangementList	Collection of ArrangementForList	None.
WorkflowLineList	Collection of WorkflowLineForList	None.
LegalList	Collection of LegalForList	None.
AccountIncidentList	Collection of AccountIncidentForList	None.
CommunicationContactList	Collection of ContactForList	None.
DocumentTemplateTypeList	Collection of DocumentTemplateTypeForList	None.
DocumentTemplateList	Collection of DocumentTemplateForList	None.
PrincipalList	Collection of PrincipalSelectableVM	None.
PrintStatusList	Collection of PrintStatusForlist	None.
DisplaySettings	LetterDisplaySettings	None.
StopActionFlowIfLetterINotSent	boolean	None.
Response	IResponse	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountID": 1,
  "LetterID": 1,
  "Document": "sample string 1",
  "CommunicationID": 1,
  "DocumentID": 1,
  "DocumentTemplateID": 1,
  "DocumentTemplateTypeID": 1,
  "HasArrangement": true,
  "HasContact": true,
  "HasCost": true,
  "HasPayment": true,
  "HasLegal": true,
  "HasAccountIncident": true,
  "HasWorkflowLine": true,
  "ContactID": 1,
  "PaymentID": 1,
  "CostID": 1,
  "LegalID": 1,
  "ArrangementID": 1,
  "WorkflowLineID": 1,
  "AccountIncidentID": 1,
  "PrintStatusID": 1,
  "SkipAddressesWithNoBarcode": true,
  "AddressStatusIDsFilter": "sample string 10",
  "SkipIfAddressDoesNotExist": true,
  "ContactList": [
    {
      "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
    }
  ],
  "ArrangementList": [
    {
      "ArrangementID": 1,
      "Arrangement": "sample string 2",
      "IsChecked": true
    },
    {
      "ArrangementID": 1,
      "Arrangement": "sample string 2",
      "IsChecked": true
    }
  ],
  "WorkflowLineList": [
    {
      "WorkflowLineID": 1,
      "WorkflowLine": "sample string 2"
    },
    {
      "WorkflowLineID": 1,
      "WorkflowLine": "sample string 2"
    }
  ],
  "LegalList": [
    {
      "LegalID": 1,
      "Legal": "sample string 1"
    },
    {
      "LegalID": 1,
      "Legal": "sample string 1"
    }
  ],
  "AccountIncidentList": [
    {
      "AccountIncidentID": 1,
      "IncidentDescription": "sample string 1"
    },
    {
      "AccountIncidentID": 1,
      "IncidentDescription": "sample string 1"
    }
  ],
  "CommunicationContactList": [
    {
      "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
    }
  ],
  "DocumentTemplateTypeList": [
    {
      "DocumentTemplateTypeID": 1,
      "DocumentTemplateType": "sample string 2"
    },
    {
      "DocumentTemplateTypeID": 1,
      "DocumentTemplateType": "sample string 2"
    }
  ],
  "DocumentTemplateList": [
    {
      "DocumentTemplateID": 1,
      "Parent_DocumentTemplateID": 1,
      "DocumentTemplate": "sample string 2"
    },
    {
      "DocumentTemplateID": 1,
      "Parent_DocumentTemplateID": 1,
      "DocumentTemplate": "sample string 2"
    }
  ],
  "PrincipalList": [
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2026-01-15T08:39:43.7254559+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    },
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2026-01-15T08:39:43.7254559+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    }
  ],
  "PrintStatusList": [
    {
      "PrintStatusID": 1,
      "PrintStatus": "sample string 2"
    },
    {
      "PrintStatusID": 1,
      "PrintStatus": "sample string 2"
    }
  ],
  "DisplaySettings": {
    "UsePrincipalBasedLetter": true
  },
  "StopActionFlowIfLetterINotSent": true,
  "Response": null
}

application/xml, text/xml

Sample:

<LetterEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Letter">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <AccountID>1</AccountID>
  <AccountIncidentID>1</AccountIncidentID>
  <AccountIncidentList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AccountIncident">
    <d2p1:AccountIncidentForList>
      <d2p1:AccountIncidentID>1</d2p1:AccountIncidentID>
      <d2p1:IncidentDescription>sample string 1</d2p1:IncidentDescription>
    </d2p1:AccountIncidentForList>
    <d2p1:AccountIncidentForList>
      <d2p1:AccountIncidentID>1</d2p1:AccountIncidentID>
      <d2p1:IncidentDescription>sample string 1</d2p1:IncidentDescription>
    </d2p1:AccountIncidentForList>
  </AccountIncidentList>
  <AddressStatusIDsFilter>sample string 10</AddressStatusIDsFilter>
  <ArrangementID>1</ArrangementID>
  <ArrangementList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Arrangement">
    <d2p1:ArrangementForList>
      <d2p1:Arrangement>sample string 2</d2p1:Arrangement>
      <d2p1:ArrangementID>1</d2p1:ArrangementID>
      <d2p1:IsChecked>true</d2p1:IsChecked>
    </d2p1:ArrangementForList>
    <d2p1:ArrangementForList>
      <d2p1:Arrangement>sample string 2</d2p1:Arrangement>
      <d2p1:ArrangementID>1</d2p1:ArrangementID>
      <d2p1:IsChecked>true</d2p1:IsChecked>
    </d2p1:ArrangementForList>
  </ArrangementList>
  <CommunicationContactList 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>
  </CommunicationContactList>
  <CommunicationID>1</CommunicationID>
  <ContactID>1</ContactID>
  <ContactList 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>
  </ContactList>
  <CostID>1</CostID>
  <DisplaySettings>
    <UsePrincipalBasedLetter>true</UsePrincipalBasedLetter>
  </DisplaySettings>
  <Document>sample string 1</Document>
  <DocumentID>1</DocumentID>
  <DocumentTemplateID>1</DocumentTemplateID>
  <DocumentTemplateList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.DocumentTemplate">
    <d2p1:DocumentTemplateForList>
      <d2p1:DocumentTemplate>sample string 2</d2p1:DocumentTemplate>
      <d2p1:DocumentTemplateID>1</d2p1:DocumentTemplateID>
      <d2p1:Parent_DocumentTemplateID>1</d2p1:Parent_DocumentTemplateID>
    </d2p1:DocumentTemplateForList>
    <d2p1:DocumentTemplateForList>
      <d2p1:DocumentTemplate>sample string 2</d2p1:DocumentTemplate>
      <d2p1:DocumentTemplateID>1</d2p1:DocumentTemplateID>
      <d2p1:Parent_DocumentTemplateID>1</d2p1:Parent_DocumentTemplateID>
    </d2p1:DocumentTemplateForList>
  </DocumentTemplateList>
  <DocumentTemplateTypeID>1</DocumentTemplateTypeID>
  <DocumentTemplateTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.DocumentTemplateType">
    <d2p1:DocumentTemplateTypeForList>
      <d2p1:DocumentTemplateType>sample string 2</d2p1:DocumentTemplateType>
      <d2p1:DocumentTemplateTypeID>1</d2p1:DocumentTemplateTypeID>
    </d2p1:DocumentTemplateTypeForList>
    <d2p1:DocumentTemplateTypeForList>
      <d2p1:DocumentTemplateType>sample string 2</d2p1:DocumentTemplateType>
      <d2p1:DocumentTemplateTypeID>1</d2p1:DocumentTemplateTypeID>
    </d2p1:DocumentTemplateTypeForList>
  </DocumentTemplateTypeList>
  <HasAccountIncident>true</HasAccountIncident>
  <HasArrangement>true</HasArrangement>
  <HasContact>true</HasContact>
  <HasCost>true</HasCost>
  <HasLegal>true</HasLegal>
  <HasPayment>true</HasPayment>
  <HasWorkflowLine>true</HasWorkflowLine>
  <LegalID>1</LegalID>
  <LegalList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Legal">
    <d2p1:LegalForList>
      <d2p1:Legal>sample string 1</d2p1:Legal>
      <d2p1:LegalID>1</d2p1:LegalID>
    </d2p1:LegalForList>
    <d2p1:LegalForList>
      <d2p1:Legal>sample string 1</d2p1:Legal>
      <d2p1:LegalID>1</d2p1:LegalID>
    </d2p1:LegalForList>
  </LegalList>
  <LetterID>1</LetterID>
  <PaymentID>1</PaymentID>
  <PrincipalList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal">
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2026-01-15T08:39:43.7254559+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2026-01-15T08:39:43.7254559+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
  </PrincipalList>
  <PrintStatusID>1</PrintStatusID>
  <PrintStatusList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PrintStatus">
    <d2p1:PrintStatusForlist>
      <d2p1:PrintStatus>sample string 2</d2p1:PrintStatus>
      <d2p1:PrintStatusID>1</d2p1:PrintStatusID>
    </d2p1:PrintStatusForlist>
    <d2p1:PrintStatusForlist>
      <d2p1:PrintStatus>sample string 2</d2p1:PrintStatus>
      <d2p1:PrintStatusID>1</d2p1:PrintStatusID>
    </d2p1:PrintStatusForlist>
  </PrintStatusList>
  <SkipAddressesWithNoBarcode>true</SkipAddressesWithNoBarcode>
  <SkipIfAddressDoesNotExist>true</SkipIfAddressDoesNotExist>
  <StopActionFlowIfLetterINotSent>true</StopActionFlowIfLetterINotSent>
  <WorkflowLineID>1</WorkflowLineID>
  <WorkflowLineList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.WorkflowLine">
    <d2p1:WorkflowLineForList>
      <d2p1:WorkflowLine>sample string 2</d2p1:WorkflowLine>
      <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
    </d2p1:WorkflowLineForList>
    <d2p1:WorkflowLineForList>
      <d2p1:WorkflowLine>sample string 2</d2p1:WorkflowLine>
      <d2p1:WorkflowLineID>1</d2p1:WorkflowLineID>
    </d2p1:WorkflowLineForList>
  </WorkflowLineList>
</LetterEditVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActionResultVM

Name	Description	Type	Additional information
Response		IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": null
}

application/xml, text/xml

Sample:

<ActionResultVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels">
  <Response i:nil="true" />
</ActionResultVM>