POST api/v1/corporate-affairs/update-workflow-detail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
JobId	integer	None.
Priority	integer	None.
Year	integer	None.
DateDue	date	None.
DateCreated	date	None.
Status	string	None.
Comment	string	None.
Outcome	string	None.
ReturnMonth	string	None.
AnnualFee	decimal number	None.
Billed	boolean	None.
AssignedTo	UserSimpleModel	None.
CreatedBy	UserSimpleModel	None.
Client	ClientDataModel	None.
Basis	string	None.
Lookup	LookupSimpleModel	None.
ReasonCancelled	string	None.
PermissionLevel	integer	None.
ClientARInfo	ClientARInfoDetailModel	None.
CompanyAssociaties	Collection of CompanyAssociateAnnualReturnModel	None.
ClientPartners	Collection of ClientPartnerAnnualReturnModel	None.
StreetAddress	AddressModel	None.
PostalAddress	AddressModel	None.
ReturnFilingCertifiedUser	UserSimpleModel	None.
ActivityHistories	Collection of JobLogModel	None.
LogSteps	Collection of LogStepModel	None.
ListJobStep	Collection of JobStepModel	None.
Timestamp	Collection of byte	None.
CreditControlBlocked	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "JobId": 1,
  "Priority": 2,
  "Year": 1,
  "DateDue": "2025-12-16T17:40:33.7859377Z",
  "DateCreated": "2025-12-16T17:40:33.7859377Z",
  "Status": "sample string 3",
  "Comment": "sample string 4",
  "Outcome": "sample string 5",
  "ReturnMonth": "sample string 6",
  "AnnualFee": 1.0,
  "Billed": true,
  "AssignedTo": {
    "UserID": 1,
    "FullName": "sample string 1"
  },
  "CreatedBy": {
    "UserID": 1,
    "FullName": "sample string 1"
  },
  "Client": {
    "ClientID": 1,
    "FirstName": "sample string 2",
    "Surname": "sample string 3",
    "FullName": "sample string 4",
    "AoClientID": "sample string 5",
    "Email": "sample string 6",
    "CGId": 1,
    "PhWork": "sample string 7",
    "PhMob": "sample string 8",
    "PhHome": "sample string 9",
    "PhFax": "sample string 10",
    "Addressee": "sample string 11",
    "Salutation": "sample string 12",
    "ContactNote": "sample string 13",
    "IRDNo": "sample string 14",
    "BusStruct": "sample string 15",
    "CompanyType": 64
  },
  "Basis": "sample string 8",
  "Lookup": {
    "LU_Id": 1,
    "Value": "sample string 2"
  },
  "ReasonCancelled": "sample string 9",
  "PermissionLevel": 10,
  "ClientARInfo": {
    "ClientId": 1,
    "CompanyNumber": "sample string 2",
    "AnnualReturnMonth": 1,
    "RegDate": "2025-12-16T17:40:33.7859377Z",
    "AGMDate": "2025-12-16T17:40:33.7859377Z",
    "LastAnnualReturnDate": "2025-12-16T17:40:33.7859377Z",
    "WeAreRegOffice": true,
    "WeAreAddressForService": true,
    "RegisteredOffice": "sample string 3",
    "AddressForService": "sample string 4",
    "AnnualReturnNoApprovalRequired": true,
    "CompanyType": 1,
    "Nzbn": "sample string 5"
  },
  "CompanyAssociaties": [
    {
      "CaId": 1,
      "ClientIdAssoc": 2,
      "IsDirector": true,
      "IsShareHolder": true,
      "FullName": "sample string 4",
      "Addr1": "sample string 5",
      "Addr2": "sample string 6",
      "Addr3": "sample string 7",
      "Addr4": "sample string 8",
      "PostCode": "sample string 9",
      "Country": "sample string 10",
      "DateOfBirth": "2025-12-16T17:40:33.8015612Z",
      "PlaceOfBirth": "sample string 11"
    },
    {
      "CaId": 1,
      "ClientIdAssoc": 2,
      "IsDirector": true,
      "IsShareHolder": true,
      "FullName": "sample string 4",
      "Addr1": "sample string 5",
      "Addr2": "sample string 6",
      "Addr3": "sample string 7",
      "Addr4": "sample string 8",
      "PostCode": "sample string 9",
      "Country": "sample string 10",
      "DateOfBirth": "2025-12-16T17:40:33.8015612Z",
      "PlaceOfBirth": "sample string 11"
    }
  ],
  "ClientPartners": [
    {
      "ClientIdPartner": 1,
      "FullName": "sample string 2",
      "Addr1": "sample string 3",
      "Addr2": "sample string 4",
      "Addr3": "sample string 5",
      "Addr4": "sample string 6",
      "PostCode": "sample string 7",
      "Country": "sample string 8",
      "DateOfBirth": "2025-12-16T17:40:33.8015612Z",
      "PlaceOfBirth": "sample string 9"
    },
    {
      "ClientIdPartner": 1,
      "FullName": "sample string 2",
      "Addr1": "sample string 3",
      "Addr2": "sample string 4",
      "Addr3": "sample string 5",
      "Addr4": "sample string 6",
      "PostCode": "sample string 7",
      "Country": "sample string 8",
      "DateOfBirth": "2025-12-16T17:40:33.8015612Z",
      "PlaceOfBirth": "sample string 9"
    }
  ],
  "StreetAddress": {
    "AddrId": 1,
    "Addr1": "sample string 2",
    "Addr2": "sample string 3",
    "Addr3": "sample string 4",
    "Addr4": "sample string 5",
    "Country": "sample string 6",
    "PostCode": "sample string 7",
    "Phone": "sample string 8",
    "Mobile": "sample string 9",
    "Fax": "sample string 10",
    "Email": "sample string 11",
    "Notes": "sample string 12",
    "AddrType": "sample string 13"
  },
  "PostalAddress": {
    "AddrId": 1,
    "Addr1": "sample string 2",
    "Addr2": "sample string 3",
    "Addr3": "sample string 4",
    "Addr4": "sample string 5",
    "Country": "sample string 6",
    "PostCode": "sample string 7",
    "Phone": "sample string 8",
    "Mobile": "sample string 9",
    "Fax": "sample string 10",
    "Email": "sample string 11",
    "Notes": "sample string 12",
    "AddrType": "sample string 13"
  },
  "ReturnFilingCertifiedUser": {
    "UserID": 1,
    "FullName": "sample string 1"
  },
  "ActivityHistories": [
    {
      "JobLogID": 1,
      "DateTime": "2025-12-16T17:40:33.8015612Z",
      "Label": "sample string 2",
      "TMSIdentifier": "sample string 3"
    },
    {
      "JobLogID": 1,
      "DateTime": "2025-12-16T17:40:33.8015612Z",
      "Label": "sample string 2",
      "TMSIdentifier": "sample string 3"
    }
  ],
  "LogSteps": [],
  "ListJobStep": [
    {
      "JobStepId": 1,
      "UserId": 1,
      "InActive": true,
      "DateCompleted": "2025-12-16T17:40:33.8015612Z",
      "Step": 1,
      "StepId": 2,
      "StepDescription": "sample string 3"
    },
    {
      "JobStepId": 1,
      "UserId": 1,
      "InActive": true,
      "DateCompleted": "2025-12-16T17:40:33.8015612Z",
      "Step": 1,
      "StepId": 2,
      "StepDescription": "sample string 3"
    }
  ],
  "Timestamp": "QEA=",
  "CreditControlBlocked": true
}

application/xml, text/xml

Sample:

<CorporateAffairWorkflowDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iPMS.Models.CorporateAffairs">
  <ActivityHistories xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Jobs">
    <d2p1:JobLogModel>
      <d2p1:DateTime>2025-12-16T17:40:33.8015612Z</d2p1:DateTime>
      <d2p1:JobLogID>1</d2p1:JobLogID>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:TMSIdentifier>sample string 3</d2p1:TMSIdentifier>
    </d2p1:JobLogModel>
    <d2p1:JobLogModel>
      <d2p1:DateTime>2025-12-16T17:40:33.8015612Z</d2p1:DateTime>
      <d2p1:JobLogID>1</d2p1:JobLogID>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:TMSIdentifier>sample string 3</d2p1:TMSIdentifier>
    </d2p1:JobLogModel>
  </ActivityHistories>
  <AnnualFee>1</AnnualFee>
  <AssignedTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Users">
    <d2p1:FullName>sample string 1</d2p1:FullName>
    <d2p1:UserID>1</d2p1:UserID>
  </AssignedTo>
  <Basis>sample string 8</Basis>
  <Billed>true</Billed>
  <Client xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Clients">
    <d2p1:Addressee>sample string 11</d2p1:Addressee>
    <d2p1:AoClientID>sample string 5</d2p1:AoClientID>
    <d2p1:BusStruct>sample string 15</d2p1:BusStruct>
    <d2p1:CGId>1</d2p1:CGId>
    <d2p1:ClientID>1</d2p1:ClientID>
    <d2p1:CompanyType>64</d2p1:CompanyType>
    <d2p1:ContactNote>sample string 13</d2p1:ContactNote>
    <d2p1:Email>sample string 6</d2p1:Email>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 4</d2p1:FullName>
    <d2p1:IRDNo>sample string 14</d2p1:IRDNo>
    <d2p1:PhFax>sample string 10</d2p1:PhFax>
    <d2p1:PhHome>sample string 9</d2p1:PhHome>
    <d2p1:PhMob>sample string 8</d2p1:PhMob>
    <d2p1:PhWork>sample string 7</d2p1:PhWork>
    <d2p1:Salutation>sample string 12</d2p1:Salutation>
    <d2p1:Surname>sample string 3</d2p1:Surname>
  </Client>
  <ClientARInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.ClientDetail.ClientARInfo">
    <d2p1:AGMDate>2025-12-16T17:40:33.7859377Z</d2p1:AGMDate>
    <d2p1:AddressForService>sample string 4</d2p1:AddressForService>
    <d2p1:AnnualReturnMonth>1</d2p1:AnnualReturnMonth>
    <d2p1:AnnualReturnNoApprovalRequired>true</d2p1:AnnualReturnNoApprovalRequired>
    <d2p1:ClientId>1</d2p1:ClientId>
    <d2p1:CompanyNumber>sample string 2</d2p1:CompanyNumber>
    <d2p1:CompanyType>1</d2p1:CompanyType>
    <d2p1:LastAnnualReturnDate>2025-12-16T17:40:33.7859377Z</d2p1:LastAnnualReturnDate>
    <d2p1:Nzbn>sample string 5</d2p1:Nzbn>
    <d2p1:RegDate>2025-12-16T17:40:33.7859377Z</d2p1:RegDate>
    <d2p1:RegisteredOffice>sample string 3</d2p1:RegisteredOffice>
    <d2p1:WeAreAddressForService>true</d2p1:WeAreAddressForService>
    <d2p1:WeAreRegOffice>true</d2p1:WeAreRegOffice>
  </ClientARInfo>
  <ClientPartners xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Clients">
    <d2p1:ClientPartnerAnnualReturnModel>
      <d2p1:Addr1>sample string 3</d2p1:Addr1>
      <d2p1:Addr2>sample string 4</d2p1:Addr2>
      <d2p1:Addr3>sample string 5</d2p1:Addr3>
      <d2p1:Addr4>sample string 6</d2p1:Addr4>
      <d2p1:ClientIdPartner>1</d2p1:ClientIdPartner>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:DateOfBirth>2025-12-16T17:40:33.8015612Z</d2p1:DateOfBirth>
      <d2p1:FullName>sample string 2</d2p1:FullName>
      <d2p1:PlaceOfBirth>sample string 9</d2p1:PlaceOfBirth>
      <d2p1:PostCode>sample string 7</d2p1:PostCode>
    </d2p1:ClientPartnerAnnualReturnModel>
    <d2p1:ClientPartnerAnnualReturnModel>
      <d2p1:Addr1>sample string 3</d2p1:Addr1>
      <d2p1:Addr2>sample string 4</d2p1:Addr2>
      <d2p1:Addr3>sample string 5</d2p1:Addr3>
      <d2p1:Addr4>sample string 6</d2p1:Addr4>
      <d2p1:ClientIdPartner>1</d2p1:ClientIdPartner>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:DateOfBirth>2025-12-16T17:40:33.8015612Z</d2p1:DateOfBirth>
      <d2p1:FullName>sample string 2</d2p1:FullName>
      <d2p1:PlaceOfBirth>sample string 9</d2p1:PlaceOfBirth>
      <d2p1:PostCode>sample string 7</d2p1:PostCode>
    </d2p1:ClientPartnerAnnualReturnModel>
  </ClientPartners>
  <Comment>sample string 4</Comment>
  <CompanyAssociaties xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Company">
    <d2p1:CompanyAssociateAnnualReturnModel>
      <d2p1:Addr1>sample string 5</d2p1:Addr1>
      <d2p1:Addr2>sample string 6</d2p1:Addr2>
      <d2p1:Addr3>sample string 7</d2p1:Addr3>
      <d2p1:Addr4>sample string 8</d2p1:Addr4>
      <d2p1:CaId>1</d2p1:CaId>
      <d2p1:ClientIdAssoc>2</d2p1:ClientIdAssoc>
      <d2p1:Country>sample string 10</d2p1:Country>
      <d2p1:DateOfBirth>2025-12-16T17:40:33.8015612Z</d2p1:DateOfBirth>
      <d2p1:FullName>sample string 4</d2p1:FullName>
      <d2p1:IsDirector>true</d2p1:IsDirector>
      <d2p1:IsShareHolder>true</d2p1:IsShareHolder>
      <d2p1:PlaceOfBirth>sample string 11</d2p1:PlaceOfBirth>
      <d2p1:PostCode>sample string 9</d2p1:PostCode>
    </d2p1:CompanyAssociateAnnualReturnModel>
    <d2p1:CompanyAssociateAnnualReturnModel>
      <d2p1:Addr1>sample string 5</d2p1:Addr1>
      <d2p1:Addr2>sample string 6</d2p1:Addr2>
      <d2p1:Addr3>sample string 7</d2p1:Addr3>
      <d2p1:Addr4>sample string 8</d2p1:Addr4>
      <d2p1:CaId>1</d2p1:CaId>
      <d2p1:ClientIdAssoc>2</d2p1:ClientIdAssoc>
      <d2p1:Country>sample string 10</d2p1:Country>
      <d2p1:DateOfBirth>2025-12-16T17:40:33.8015612Z</d2p1:DateOfBirth>
      <d2p1:FullName>sample string 4</d2p1:FullName>
      <d2p1:IsDirector>true</d2p1:IsDirector>
      <d2p1:IsShareHolder>true</d2p1:IsShareHolder>
      <d2p1:PlaceOfBirth>sample string 11</d2p1:PlaceOfBirth>
      <d2p1:PostCode>sample string 9</d2p1:PostCode>
    </d2p1:CompanyAssociateAnnualReturnModel>
  </CompanyAssociaties>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Users">
    <d2p1:FullName>sample string 1</d2p1:FullName>
    <d2p1:UserID>1</d2p1:UserID>
  </CreatedBy>
  <CreditControlBlocked>true</CreditControlBlocked>
  <DateCreated>2025-12-16T17:40:33.7859377Z</DateCreated>
  <DateDue>2025-12-16T17:40:33.7859377Z</DateDue>
  <JobId>1</JobId>
  <ListJobStep xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.AnnualComplianceWorkflowTotal">
    <d2p1:JobStepModel>
      <d2p1:DateCompleted>2025-12-16T17:40:33.8015612Z</d2p1:DateCompleted>
      <d2p1:InActive>true</d2p1:InActive>
      <d2p1:JobStepId>1</d2p1:JobStepId>
      <d2p1:Step>1</d2p1:Step>
      <d2p1:StepDescription>sample string 3</d2p1:StepDescription>
      <d2p1:StepId>2</d2p1:StepId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:JobStepModel>
    <d2p1:JobStepModel>
      <d2p1:DateCompleted>2025-12-16T17:40:33.8015612Z</d2p1:DateCompleted>
      <d2p1:InActive>true</d2p1:InActive>
      <d2p1:JobStepId>1</d2p1:JobStepId>
      <d2p1:Step>1</d2p1:Step>
      <d2p1:StepDescription>sample string 3</d2p1:StepDescription>
      <d2p1:StepId>2</d2p1:StepId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:JobStepModel>
  </ListJobStep>
  <LogSteps xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Commons" />
  <Lookup xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Lookup">
    <d2p1:LU_Id>1</d2p1:LU_Id>
    <d2p1:Value>sample string 2</d2p1:Value>
  </Lookup>
  <Outcome>sample string 5</Outcome>
  <PermissionLevel>10</PermissionLevel>
  <PostalAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Address">
    <d2p1:Addr1>sample string 2</d2p1:Addr1>
    <d2p1:Addr2>sample string 3</d2p1:Addr2>
    <d2p1:Addr3>sample string 4</d2p1:Addr3>
    <d2p1:Addr4>sample string 5</d2p1:Addr4>
    <d2p1:AddrId>1</d2p1:AddrId>
    <d2p1:AddrType>sample string 13</d2p1:AddrType>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:Email>sample string 11</d2p1:Email>
    <d2p1:Fax>sample string 10</d2p1:Fax>
    <d2p1:Mobile>sample string 9</d2p1:Mobile>
    <d2p1:Notes>sample string 12</d2p1:Notes>
    <d2p1:Phone>sample string 8</d2p1:Phone>
    <d2p1:PostCode>sample string 7</d2p1:PostCode>
  </PostalAddress>
  <Priority>2</Priority>
  <ReasonCancelled>sample string 9</ReasonCancelled>
  <ReturnFilingCertifiedUser xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Users">
    <d2p1:FullName>sample string 1</d2p1:FullName>
    <d2p1:UserID>1</d2p1:UserID>
  </ReturnFilingCertifiedUser>
  <ReturnMonth>sample string 6</ReturnMonth>
  <Status>sample string 3</Status>
  <StreetAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.Address">
    <d2p1:Addr1>sample string 2</d2p1:Addr1>
    <d2p1:Addr2>sample string 3</d2p1:Addr2>
    <d2p1:Addr3>sample string 4</d2p1:Addr3>
    <d2p1:Addr4>sample string 5</d2p1:Addr4>
    <d2p1:AddrId>1</d2p1:AddrId>
    <d2p1:AddrType>sample string 13</d2p1:AddrType>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:Email>sample string 11</d2p1:Email>
    <d2p1:Fax>sample string 10</d2p1:Fax>
    <d2p1:Mobile>sample string 9</d2p1:Mobile>
    <d2p1:Notes>sample string 12</d2p1:Notes>
    <d2p1:Phone>sample string 8</d2p1:Phone>
    <d2p1:PostCode>sample string 7</d2p1:PostCode>
  </StreetAddress>
  <Timestamp>QEA=</Timestamp>
  <Year>1</Year>
</CorporateAffairWorkflowDetailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.