GET api/Candidates/{CandidateNo}/TaxDocuments/{TaxDocumentNo}

Used to get the Tax Document Details of Tax Document

Request Information

URI Parameters

Name	Description	Type	Additional information
CandidateNo	Candidate No	string	Required
TaxDocumentNo	Tax Document No	string	Required

Body Parameters

None.

Response Information

Resource Description

COMPLETE

TaxDocumentDetailsDTO

Name	Description	Type	Additional information
TaxDocumentID	This is the Id of the Tax document info	integer	None.
TaxDocSubmittedDate	This is the tax document Submitted Date	date	None.
DocumentID	This is the document Id of the sent tax document	integer	None.
TaxDocumentType	This is the tax document type (manual or edoc)	string	None.
TaxDocumentStyle	This is tax document Style (AU TFN)	string	None.
TaxDocumentStatus	This is the tax document status	string	None.
EmployeeID	This Employee Internal Id	integer	None.
CandidateID		integer	None.
CreatedOn	This is the Tax Document Created On	date	None.
EDocumentID	This is the EDocument Id	integer	None.
EntityDocumentID	This is the entity Document Id	integer	None.
AddtionalStatusData	This is the additional Data for the Tax document	string	None.
EDocumentEnvelopeID	This is eDocument EnvelopId	string	None.
DocumentName	This is the Document name	string	None.
TaxDocumentXML	This is the tax document information in XML string	string	None.
TaxDocumentProperties	This is the Tax Document properties	Collection of KeyValuePairDTOOfStringAndObject	None.

Response Formats

application/json, text/json

Sample:

{
  "TaxDocumentID": 1,
  "TaxDocSubmittedDate": "2024-06-29T07:29:47.5688291+10:00",
  "DocumentID": 1,
  "TaxDocumentType": "sample string 1",
  "TaxDocumentStyle": "sample string 2",
  "TaxDocumentStatus": "sample string 3",
  "EmployeeID": 1,
  "CandidateID": 4,
  "CreatedOn": "2024-06-29T07:29:47.5688291+10:00",
  "EDocumentID": 1,
  "EntityDocumentID": 1,
  "AddtionalStatusData": "sample string 5",
  "EDocumentEnvelopeID": "sample string 6",
  "DocumentName": "sample string 7",
  "TaxDocumentXML": "sample string 8",
  "TaxDocumentProperties": [
    {
      "Key": "sample string 1",
      "Value": {}
    },
    {
      "Key": "sample string 1",
      "Value": {}
    }
  ]
}

text/xml

Sample:

<TaxDocumentDetailsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <AddtionalStatusData>sample string 5</AddtionalStatusData>
  <CandidateID>4</CandidateID>
  <CreatedOn>2024-06-29T07:29:47.5688291+10:00</CreatedOn>
  <DocumentID>1</DocumentID>
  <DocumentName>sample string 7</DocumentName>
  <EDocumentEnvelopeID>sample string 6</EDocumentEnvelopeID>
  <EDocumentID>1</EDocumentID>
  <EmployeeID>1</EmployeeID>
  <EntityDocumentID>1</EntityDocumentID>
  <TaxDocSubmittedDate>2024-06-29T07:29:47.5688291+10:00</TaxDocSubmittedDate>
  <TaxDocumentID>1</TaxDocumentID>
  <TaxDocumentProperties>
    <KeyValuePairDTOOfstringanyType>
      <_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField />
    </KeyValuePairDTOOfstringanyType>
    <KeyValuePairDTOOfstringanyType>
      <_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField />
    </KeyValuePairDTOOfstringanyType>
  </TaxDocumentProperties>
  <TaxDocumentStatus>sample string 3</TaxDocumentStatus>
  <TaxDocumentStyle>sample string 2</TaxDocumentStyle>
  <TaxDocumentType>sample string 1</TaxDocumentType>
  <TaxDocumentXML>sample string 8</TaxDocumentXML>
</TaxDocumentDetailsDTO>

multipart/form-data

Sample:

<TaxDocumentDetailsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><AddtionalStatusData>sample string 5</AddtionalStatusData><CandidateID>4</CandidateID><CreatedOn>2024-06-29T07:29:47.5688291+10:00</CreatedOn><DocumentID>1</DocumentID><DocumentName>sample string 7</DocumentName><EDocumentEnvelopeID>sample string 6</EDocumentEnvelopeID><EDocumentID>1</EDocumentID><EmployeeID>1</EmployeeID><EntityDocumentID>1</EntityDocumentID><TaxDocSubmittedDate>2024-06-29T07:29:47.5688291+10:00</TaxDocSubmittedDate><TaxDocumentID>1</TaxDocumentID><TaxDocumentProperties><KeyValuePairDTOOfstringanyType><_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField><_x003C_Value_x003E_k__BackingField /></KeyValuePairDTOOfstringanyType><KeyValuePairDTOOfstringanyType><_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField><_x003C_Value_x003E_k__BackingField /></KeyValuePairDTOOfstringanyType></TaxDocumentProperties><TaxDocumentStatus>sample string 3</TaxDocumentStatus><TaxDocumentStyle>sample string 2</TaxDocumentStyle><TaxDocumentType>sample string 1</TaxDocumentType><TaxDocumentXML>sample string 8</TaxDocumentXML></TaxDocumentDetailsDTO>