POST api/Candidates/{CandidateNo}/TaxDocuments/TaxeDocumentRequest

Used to send Tax eDocument request to the candidate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CandidateNo

string

Required

Body Parameters

TaxDocumentRequestDTO
NameDescriptionTypeAdditional information
TaxFileName

This is Tax File Name

string

None.

TaxDocumentStyle

This is TaxDocumentStyle (AUTFN)

string

None.

Content

This is document Content

Collection of byte

None.

IsOverrideValidationCheck

This flag is used to override the validation and sends the request

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "TaxFileName": "sample string 1",
  "TaxDocumentStyle": "sample string 2",
  "Content": "QEA=",
  "IsOverrideValidationCheck": true
}

text/xml

Sample:
<TaxDocumentRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <Content>QEA=</Content>
  <IsOverrideValidationCheck>true</IsOverrideValidationCheck>
  <TaxDocumentStyle>sample string 2</TaxDocumentStyle>
  <TaxFileName>sample string 1</TaxFileName>
</TaxDocumentRequestDTO>

multipart/form-data

Sample:
<TaxDocumentRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><Content>QEA=</Content><IsOverrideValidationCheck>true</IsOverrideValidationCheck><TaxDocumentStyle>sample string 2</TaxDocumentStyle><TaxFileName>sample string 1</TaxFileName></TaxDocumentRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

COMPLETE

TaxDocCheckandSendRequestResultDTO
NameDescriptionTypeAdditional information
DuplicateValue

This is the duplicate Value if the tax document was already sent

integer

None.

DuplicateSubject

This is the message subject if the tax document was already sent

string

None.

DuplicateMessage

This is the message if the tax document was already sent

string

None.

Response Formats

application/json, text/json

Sample:
{
  "DuplicateValue": 1,
  "DuplicateSubject": "sample string 1",
  "DuplicateMessage": "sample string 2"
}

text/xml

Sample:
<TaxDocCheckandSendRequestResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <DuplicateMessage>sample string 2</DuplicateMessage>
  <DuplicateSubject>sample string 1</DuplicateSubject>
  <DuplicateValue>1</DuplicateValue>
</TaxDocCheckandSendRequestResultDTO>

multipart/form-data

Sample:
<TaxDocCheckandSendRequestResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><DuplicateMessage>sample string 2</DuplicateMessage><DuplicateSubject>sample string 1</DuplicateSubject><DuplicateValue>1</DuplicateValue></TaxDocCheckandSendRequestResultDTO>