POST api/Principal/Save?accountID={accountID}&mediaID={mediaID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

integer

Required

mediaID

integer

Required

Body Parameters

PrincipalModel
NameDescriptionTypeAdditional information
PrincipalID

integer

None.

AccountID

integer

None.

ContactID

integer

None.

TransactionDate

date

None.

TransactionAmount

decimal number

None.

TransactionDesc

string

None.

COAStartDate

date

None.

COAEndDate

date

None.

PlacementDate

date

None.

CauseOfActionID

integer

None.

ClientTransactionReference

string

None.

ClientTransactionID

integer

None.

IsContact

integer

None.

InvoiceAttention

string

None.

AddressID

integer

None.

Phone

string

None.

Fax

string

None.

Email

string

None.

ActionBaseDate

date

None.

LUPAllocatedAmount

decimal number

None.

LUPBalance

decimal number

None.

CreateID

integer

None.

CreateSessionID

integer

None.

CreateTS

date

None.

ModifyID

integer

None.

ModifySessionID

integer

None.

ModifyTS

date

None.

InactiveID

integer

None.

InactiveSessionID

integer

None.

InactiveTS

date

None.

StatusID

integer

None.

Z_DB

integer

None.

Z_ID

integer

None.

AccountingBatchID

integer

None.

Reversed_PrincipalID

integer

None.

Reversed

boolean

None.

Z_IDSTR

string

None.

Z_REF

string

None.

Z_REF2

string

None.

Z_REF3

string

None.

Source_AccountID

integer

None.

Source_PrincipalID

integer

None.

Commission_CostID

integer

None.

LoadID

integer

None.

PrincipalTypeID

integer

None.

MediaID

integer

None.

PrincipalStatusID

integer

None.

WorkflowLineID

integer

None.

COAStartLocationOfService

string

None.

COAEndLocationOfService

string

None.

COADistanceTravelled

integer

None.

FeeRecoveryOrderTypeOfServiceID

integer

None.

InvoiceNumberClient

string

None.

DebtNoticeIssueDate

date

None.

LUPBalanceThirdParty

decimal number

None.

LUPLastCurrentDue

decimal number

None.

LUPReportBalanceThirdParty

decimal number

None.

AccountNumberClient

string

None.

LUPFollowUpDate

date

None.

FinancialEntryID

integer

None.

Transferred_PrincipalID

integer

None.

IsTransferred

boolean

None.

PrincipalCostList

Collection of PrincipalCost

None.

PrincipalOffenceList

Collection of PrincipalOffence

None.

FileSequenceNo

integer

None.

FileRegistry

string

None.

FileYear

integer

None.

FileYearSequenceNo

integer

None.

Issuing_EntityID

integer

None.

PrincipalGroupID

integer

None.

AdultIndicator

boolean

None.

LUPContactMatchLiabilityTypeOutcomeID

integer

None.

Outsource_EntityID

integer

None.

External_RefNo

string

None.

External_ReturnToSenderCode

string

None.

External_PreviousContact

boolean

None.

External_Review

boolean

None.

Initiating_EntityCategoryID

integer

None.

NextActionDate

date

None.

IssueDate

date

None.

DueDate

date

None.

OriginalDueDate

date

None.

EnforceDate

date

None.

Aggregated

boolean

None.

AggregationDate

date

None.

CauseOfActionTypeID

integer

None.

ReminderNoticeDate

date

None.

EnforcementWarningDate

date

None.

InactiveReasonID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PrincipalID": 1,
  "AccountID": 1,
  "ContactID": 1,
  "TransactionDate": "2025-09-02T23:07:15.9099912+00:00",
  "TransactionAmount": 1.0,
  "TransactionDesc": "sample string 2",
  "COAStartDate": "2025-09-02T23:07:15.9099912+00:00",
  "COAEndDate": "2025-09-02T23:07:15.9099912+00:00",
  "PlacementDate": "2025-09-02T23:07:15.9099912+00:00",
  "CauseOfActionID": 1,
  "ClientTransactionReference": "sample string 3",
  "ClientTransactionID": 1,
  "IsContact": 1,
  "InvoiceAttention": "sample string 4",
  "AddressID": 1,
  "Phone": "sample string 5",
  "Fax": "sample string 6",
  "Email": "sample string 7",
  "ActionBaseDate": "2025-09-02T23:07:15.9099912+00:00",
  "LUPAllocatedAmount": 1.0,
  "LUPBalance": 1.0,
  "CreateID": 1,
  "CreateSessionID": 1,
  "CreateTS": "2025-09-02T23:07:15.9099912+00:00",
  "ModifyID": 1,
  "ModifySessionID": 1,
  "ModifyTS": "2025-09-02T23:07:15.9099912+00:00",
  "InactiveID": 1,
  "InactiveSessionID": 1,
  "InactiveTS": "2025-09-02T23:07:15.9099912+00:00",
  "StatusID": 1,
  "Z_DB": 1,
  "Z_ID": 1,
  "AccountingBatchID": 1,
  "Reversed_PrincipalID": 1,
  "Reversed": true,
  "Z_IDSTR": "sample string 8",
  "Z_REF": "sample string 9",
  "Z_REF2": "sample string 10",
  "Z_REF3": "sample string 11",
  "Source_AccountID": 1,
  "Source_PrincipalID": 1,
  "Commission_CostID": 1,
  "LoadID": 1,
  "PrincipalTypeID": 1,
  "MediaID": 1,
  "PrincipalStatusID": 1,
  "WorkflowLineID": 1,
  "COAStartLocationOfService": "sample string 12",
  "COAEndLocationOfService": "sample string 13",
  "COADistanceTravelled": 1,
  "FeeRecoveryOrderTypeOfServiceID": 1,
  "InvoiceNumberClient": "sample string 14",
  "DebtNoticeIssueDate": "2025-09-02T23:07:15.9099912+00:00",
  "LUPBalanceThirdParty": 1.0,
  "LUPLastCurrentDue": 1.0,
  "LUPReportBalanceThirdParty": 1.0,
  "AccountNumberClient": "sample string 15",
  "LUPFollowUpDate": "2025-09-02T23:07:15.9099912+00:00",
  "FinancialEntryID": 1,
  "Transferred_PrincipalID": 1,
  "IsTransferred": true,
  "PrincipalCostList": [
    {
      "PrincipalID": 1,
      "CostID": "sample string 1",
      "Cost": 1.1,
      "CostTypeID": 2,
      "Description": "sample string 3",
      "CostTypeList": [
        {
          "CostTypeID": 1,
          "CostType": "sample string 2",
          "IsDebtorCost": true
        },
        {
          "CostTypeID": 1,
          "CostType": "sample string 2",
          "IsDebtorCost": true
        }
      ]
    },
    {
      "PrincipalID": 1,
      "CostID": "sample string 1",
      "Cost": 1.1,
      "CostTypeID": 2,
      "Description": "sample string 3",
      "CostTypeList": [
        {
          "CostTypeID": 1,
          "CostType": "sample string 2",
          "IsDebtorCost": true
        },
        {
          "CostTypeID": 1,
          "CostType": "sample string 2",
          "IsDebtorCost": true
        }
      ]
    }
  ],
  "PrincipalOffenceList": [
    {
      "PrincipalID": 1,
      "OffenceID": "sample string 1",
      "Offence": "sample string 2",
      "OffenceCode": "sample string 3",
      "OffenceStartDate": "2025-09-02T23:07:15.9099912+00:00",
      "OffenceEndDate": "2025-09-02T23:07:15.9099912+00:00",
      "Location": "sample string 4",
      "Description": "sample string 5",
      "Source": "sample string 6",
      "LoadID": 1,
      "LawCode": "sample string 7",
      "MotifyingLowCode": "sample string 8",
      "StatisticOffenceCode": "sample string 9",
      "VehicleRegNumber": "sample string 10",
      "VehicleDescription": "sample string 11",
      "StateVehicleRegistered": "sample string 12",
      "SourceList": [
        "sample string 1",
        "sample string 2"
      ],
      "StateList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "PrincipalID": 1,
      "OffenceID": "sample string 1",
      "Offence": "sample string 2",
      "OffenceCode": "sample string 3",
      "OffenceStartDate": "2025-09-02T23:07:15.9099912+00:00",
      "OffenceEndDate": "2025-09-02T23:07:15.9099912+00:00",
      "Location": "sample string 4",
      "Description": "sample string 5",
      "Source": "sample string 6",
      "LoadID": 1,
      "LawCode": "sample string 7",
      "MotifyingLowCode": "sample string 8",
      "StatisticOffenceCode": "sample string 9",
      "VehicleRegNumber": "sample string 10",
      "VehicleDescription": "sample string 11",
      "StateVehicleRegistered": "sample string 12",
      "SourceList": [
        "sample string 1",
        "sample string 2"
      ],
      "StateList": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "FileSequenceNo": 1,
  "FileRegistry": "sample string 16",
  "FileYear": 1,
  "FileYearSequenceNo": 1,
  "Issuing_EntityID": 1,
  "PrincipalGroupID": 1,
  "AdultIndicator": true,
  "LUPContactMatchLiabilityTypeOutcomeID": 1,
  "Outsource_EntityID": 1,
  "External_RefNo": "sample string 17",
  "External_ReturnToSenderCode": "sample string 18",
  "External_PreviousContact": true,
  "External_Review": true,
  "Initiating_EntityCategoryID": 1,
  "NextActionDate": "2025-09-02T23:07:15.9099912+00:00",
  "IssueDate": "2025-09-02T23:07:15.9099912+00:00",
  "DueDate": "2025-09-02T23:07:15.9099912+00:00",
  "OriginalDueDate": "2025-09-02T23:07:15.9099912+00:00",
  "EnforceDate": "2025-09-02T23:07:15.9099912+00:00",
  "Aggregated": true,
  "AggregationDate": "2025-09-02T23:07:15.9099912+00:00",
  "CauseOfActionTypeID": 1,
  "ReminderNoticeDate": "2025-09-02T23:07:15.9099912+00:00",
  "EnforcementWarningDate": "2025-09-02T23:07:15.9099912+00:00",
  "InactiveReasonID": 1
}

application/xml, text/xml

Sample:
<PrincipalModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
  <AccountID>1</AccountID>
  <AccountNumberClient>sample string 15</AccountNumberClient>
  <AccountingBatchID>1</AccountingBatchID>
  <ActionBaseDate>2025-09-02T23:07:15.9099912+00:00</ActionBaseDate>
  <AddressID>1</AddressID>
  <AdultIndicator>true</AdultIndicator>
  <Aggregated>true</Aggregated>
  <AggregationDate>2025-09-02T23:07:15.9099912+00:00</AggregationDate>
  <COADistanceTravelled>1</COADistanceTravelled>
  <COAEndDate>2025-09-02T23:07:15.9099912+00:00</COAEndDate>
  <COAEndLocationOfService>sample string 13</COAEndLocationOfService>
  <COAStartDate>2025-09-02T23:07:15.9099912+00:00</COAStartDate>
  <COAStartLocationOfService>sample string 12</COAStartLocationOfService>
  <CauseOfActionID>1</CauseOfActionID>
  <CauseOfActionTypeID>1</CauseOfActionTypeID>
  <ClientTransactionID>1</ClientTransactionID>
  <ClientTransactionReference>sample string 3</ClientTransactionReference>
  <Commission_CostID>1</Commission_CostID>
  <ContactID>1</ContactID>
  <CreateID>1</CreateID>
  <CreateSessionID>1</CreateSessionID>
  <CreateTS>2025-09-02T23:07:15.9099912+00:00</CreateTS>
  <DebtNoticeIssueDate>2025-09-02T23:07:15.9099912+00:00</DebtNoticeIssueDate>
  <DueDate>2025-09-02T23:07:15.9099912+00:00</DueDate>
  <Email>sample string 7</Email>
  <EnforceDate>2025-09-02T23:07:15.9099912+00:00</EnforceDate>
  <EnforcementWarningDate>2025-09-02T23:07:15.9099912+00:00</EnforcementWarningDate>
  <External_PreviousContact>true</External_PreviousContact>
  <External_RefNo>sample string 17</External_RefNo>
  <External_ReturnToSenderCode>sample string 18</External_ReturnToSenderCode>
  <External_Review>true</External_Review>
  <Fax>sample string 6</Fax>
  <FeeRecoveryOrderTypeOfServiceID>1</FeeRecoveryOrderTypeOfServiceID>
  <FileRegistry>sample string 16</FileRegistry>
  <FileSequenceNo>1</FileSequenceNo>
  <FileYear>1</FileYear>
  <FileYearSequenceNo>1</FileYearSequenceNo>
  <FinancialEntryID>1</FinancialEntryID>
  <InactiveID>1</InactiveID>
  <InactiveReasonID>1</InactiveReasonID>
  <InactiveSessionID>1</InactiveSessionID>
  <InactiveTS>2025-09-02T23:07:15.9099912+00:00</InactiveTS>
  <Initiating_EntityCategoryID>1</Initiating_EntityCategoryID>
  <InvoiceAttention>sample string 4</InvoiceAttention>
  <InvoiceNumberClient>sample string 14</InvoiceNumberClient>
  <IsContact>1</IsContact>
  <IsTransferred>true</IsTransferred>
  <IssueDate>2025-09-02T23:07:15.9099912+00:00</IssueDate>
  <Issuing_EntityID>1</Issuing_EntityID>
  <LUPAllocatedAmount>1</LUPAllocatedAmount>
  <LUPBalance>1</LUPBalance>
  <LUPBalanceThirdParty>1</LUPBalanceThirdParty>
  <LUPContactMatchLiabilityTypeOutcomeID>1</LUPContactMatchLiabilityTypeOutcomeID>
  <LUPFollowUpDate>2025-09-02T23:07:15.9099912+00:00</LUPFollowUpDate>
  <LUPLastCurrentDue>1</LUPLastCurrentDue>
  <LUPReportBalanceThirdParty>1</LUPReportBalanceThirdParty>
  <LoadID>1</LoadID>
  <MediaID>1</MediaID>
  <ModifyID>1</ModifyID>
  <ModifySessionID>1</ModifySessionID>
  <ModifyTS>2025-09-02T23:07:15.9099912+00:00</ModifyTS>
  <NextActionDate>2025-09-02T23:07:15.9099912+00:00</NextActionDate>
  <OriginalDueDate>2025-09-02T23:07:15.9099912+00:00</OriginalDueDate>
  <Outsource_EntityID>1</Outsource_EntityID>
  <Phone>sample string 5</Phone>
  <PlacementDate>2025-09-02T23:07:15.9099912+00:00</PlacementDate>
  <PrincipalCostList>
    <PrincipalCost>
      <Cost>1.1</Cost>
      <CostID>sample string 1</CostID>
      <CostTypeID>2</CostTypeID>
      <CostTypeList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.CostType">
        <d4p1:CostTypeForList>
          <d4p1:CostType>sample string 2</d4p1:CostType>
          <d4p1:CostTypeID>1</d4p1:CostTypeID>
          <d4p1:IsDebtorCost>true</d4p1:IsDebtorCost>
        </d4p1:CostTypeForList>
        <d4p1:CostTypeForList>
          <d4p1:CostType>sample string 2</d4p1:CostType>
          <d4p1:CostTypeID>1</d4p1:CostTypeID>
          <d4p1:IsDebtorCost>true</d4p1:IsDebtorCost>
        </d4p1:CostTypeForList>
      </CostTypeList>
      <Description>sample string 3</Description>
      <PrincipalID>1</PrincipalID>
    </PrincipalCost>
    <PrincipalCost>
      <Cost>1.1</Cost>
      <CostID>sample string 1</CostID>
      <CostTypeID>2</CostTypeID>
      <CostTypeList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.CostType">
        <d4p1:CostTypeForList>
          <d4p1:CostType>sample string 2</d4p1:CostType>
          <d4p1:CostTypeID>1</d4p1:CostTypeID>
          <d4p1:IsDebtorCost>true</d4p1:IsDebtorCost>
        </d4p1:CostTypeForList>
        <d4p1:CostTypeForList>
          <d4p1:CostType>sample string 2</d4p1:CostType>
          <d4p1:CostTypeID>1</d4p1:CostTypeID>
          <d4p1:IsDebtorCost>true</d4p1:IsDebtorCost>
        </d4p1:CostTypeForList>
      </CostTypeList>
      <Description>sample string 3</Description>
      <PrincipalID>1</PrincipalID>
    </PrincipalCost>
  </PrincipalCostList>
  <PrincipalGroupID>1</PrincipalGroupID>
  <PrincipalID>1</PrincipalID>
  <PrincipalOffenceList>
    <PrincipalOffence>
      <Description>sample string 5</Description>
      <LawCode>sample string 7</LawCode>
      <LoadID>1</LoadID>
      <Location>sample string 4</Location>
      <MotifyingLowCode>sample string 8</MotifyingLowCode>
      <Offence>sample string 2</Offence>
      <OffenceCode>sample string 3</OffenceCode>
      <OffenceEndDate>2025-09-02T23:07:15.9099912+00:00</OffenceEndDate>
      <OffenceID>sample string 1</OffenceID>
      <OffenceStartDate>2025-09-02T23:07:15.9099912+00:00</OffenceStartDate>
      <PrincipalID>1</PrincipalID>
      <Source>sample string 6</Source>
      <SourceList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SourceList>
      <StateList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StateList>
      <StateVehicleRegistered>sample string 12</StateVehicleRegistered>
      <StatisticOffenceCode>sample string 9</StatisticOffenceCode>
      <VehicleDescription>sample string 11</VehicleDescription>
      <VehicleRegNumber>sample string 10</VehicleRegNumber>
    </PrincipalOffence>
    <PrincipalOffence>
      <Description>sample string 5</Description>
      <LawCode>sample string 7</LawCode>
      <LoadID>1</LoadID>
      <Location>sample string 4</Location>
      <MotifyingLowCode>sample string 8</MotifyingLowCode>
      <Offence>sample string 2</Offence>
      <OffenceCode>sample string 3</OffenceCode>
      <OffenceEndDate>2025-09-02T23:07:15.9099912+00:00</OffenceEndDate>
      <OffenceID>sample string 1</OffenceID>
      <OffenceStartDate>2025-09-02T23:07:15.9099912+00:00</OffenceStartDate>
      <PrincipalID>1</PrincipalID>
      <Source>sample string 6</Source>
      <SourceList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SourceList>
      <StateList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StateList>
      <StateVehicleRegistered>sample string 12</StateVehicleRegistered>
      <StatisticOffenceCode>sample string 9</StatisticOffenceCode>
      <VehicleDescription>sample string 11</VehicleDescription>
      <VehicleRegNumber>sample string 10</VehicleRegNumber>
    </PrincipalOffence>
  </PrincipalOffenceList>
  <PrincipalStatusID>1</PrincipalStatusID>
  <PrincipalTypeID>1</PrincipalTypeID>
  <ReminderNoticeDate>2025-09-02T23:07:15.9099912+00:00</ReminderNoticeDate>
  <Reversed>true</Reversed>
  <Reversed_PrincipalID>1</Reversed_PrincipalID>
  <Source_AccountID>1</Source_AccountID>
  <Source_PrincipalID>1</Source_PrincipalID>
  <StatusID>1</StatusID>
  <TransactionAmount>1</TransactionAmount>
  <TransactionDate>2025-09-02T23:07:15.9099912+00:00</TransactionDate>
  <TransactionDesc>sample string 2</TransactionDesc>
  <Transferred_PrincipalID>1</Transferred_PrincipalID>
  <WorkflowLineID>1</WorkflowLineID>
  <Z_DB>1</Z_DB>
  <Z_ID>1</Z_ID>
  <Z_IDSTR>sample string 8</Z_IDSTR>
  <Z_REF>sample string 9</Z_REF>
  <Z_REF2>sample string 10</Z_REF2>
  <Z_REF3>sample string 11</Z_REF3>
</PrincipalModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>