POST api/AnnualisedSalImportHeader

POST a new AnnualisedSalImportHeader into payroll database.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

None.

Body Parameters

AnnualisedSalImportHeaderView
NameDescriptionTypeAdditional information
AnnualisedSal
 ImportHeaderId

The unique id assigned to this AnnualisedSalImportHeader request once it is validated and saved.

integer

None.
ChangeStatus

Indicates the status of the current request.

Leave blank when submitting a new request.

ReadOnly

 string

Matching: ([^'"])*

Max length: 20
ImportSource

Name of the provider.

string

Max length: 20
Payload

Json formatted annualised salary data.

string

None.
DatabaseType

Type of database: Meridian, WageEasy, EasyPay. Default to Meridian

string

None.
ReceivedDate
 Time

Set when a validated request is saved.

ReadOnly

 date

None.
PickedUpDate
 Time

Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table.

ReadOnly

 date

None.
RejectedDate
 Time

Set when a validated request is accepted and implemented by payroll.

ReadOnly

 date

None.
ErrorMessage

May contain errors identified when the request is processed by payroll. ReadOnly

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "annualisedSalImportHeaderId": 1,
  "changeStatus": "sample string 1",
  "importSource": "sample string 2",
  "payload": "sample string 3",
  "databaseType": "sample string 4",
  "receivedDateTime": "2025-10-27T21:21:02.6125796+11:00",
  "pickedUpDateTime": "2025-10-27T21:21:02.6125796+11:00",
  "rejectedDateTime": "2025-10-27T21:21:02.6125796+11:00",
  "errorMessage": "sample string 5"
}

application/xml, text/xml

Sample: 
<AnnualisedSalImportHeaderView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AnnualisedSalImportHeaderId>1</AnnualisedSalImportHeaderId>
  <ChangeStatus>sample string 1</ChangeStatus>
  <ImportSource>sample string 2</ImportSource>
  <Payload>sample string 3</Payload>
  <DatabaseType>sample string 4</DatabaseType>
  <ReceivedDateTime>2025-10-27T21:21:02.6125796+11:00</ReceivedDateTime>
  <PickedUpDateTime>2025-10-27T21:21:02.6125796+11:00</PickedUpDateTime>
  <RejectedDateTime>2025-10-27T21:21:02.6125796+11:00</RejectedDateTime>
  <ErrorMessage>sample string 5</ErrorMessage>
</AnnualisedSalImportHeaderView>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AnnualisedSalImportHeaderResponseView
NameDescriptionTypeAdditional information
AnnualisedSal
 ImportHeaderId

integer

None.
ChangeStatus

string

None.
Error

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "annualisedSalImportHeaderId": 1,
  "changeStatus": "sample string 2",
  "error": "sample string 3"
}

application/xml, text/xml

Sample: 
<AnnualisedSalImportHeaderResponseView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AnnualisedSalImportHeaderId>1</AnnualisedSalImportHeaderId>
  <ChangeStatus>sample string 2</ChangeStatus>
  <Error>sample string 3</Error>
</AnnualisedSalImportHeaderResponseView>