Portuguese Payroll | Tax Data Work Location

Service to manage entities of type 'TaxDataWorkLocation'.

This service extends WorkLocations.

Overview

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations

URL	api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxDataWorkLocations
- POST TaxDataWorkLocations (with ApiBaseTaxDataWorkLocation)
PUT:
DELETE:
- DELETE TaxDataWorkLocation by identifier
- DELETE TaxDataWorkLocation by key

All Resources

This service uses the following resources:

ApiBaseTaxDataWorkLocationResource
ApiTaxDataWorkLocationResource
BaseTaxDataWorkLocationResource
TaxDataWorkLocationResource

GET Operations

GET TaxDataWorkLocations

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See TaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/extension

GET /payrollPT/taxDataWorkLocations/extension

GET TaxDataWorkLocations (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See TaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/extension?page={page}&pageSize={pageSize}

GET /payrollPT/taxDataWorkLocations/extension?page={page}&pageSize={pageSize}

GET TaxDataWorkLocation by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See TaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{id}/extension

GET /payrollPT/taxDataWorkLocations/{id}/extension

GET TaxDataWorkLocation by key

Returns the entity record that matches the specified key.

The following elements are required:

workLocationKey

(string) Work Location.

Response:

When successful, the response body contains the entity record. See TaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/extension

GET /payrollPT/taxDataWorkLocations/{workLocationKey}/extension

GET TaxDataWorkLocations (with WorkLocation)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

When successful, the response body contains the list of records available. See BaseTaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations

GET /payrollPT/taxDataWorkLocations

GET TaxDataWorkLocations (with WorkLocation) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BaseTaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations?page={page}&pageSize={pageSize}

GET /payrollPT/taxDataWorkLocations?page={page}&pageSize={pageSize}

GET TaxDataWorkLocation (with WorkLocation) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See BaseTaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{id}

GET /payrollPT/taxDataWorkLocations/{id}

GET TaxDataWorkLocation (with WorkLocation) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

workLocationKey

(string) Work Location.

Response:

When successful, the response body contains the entity record. See BaseTaxDataWorkLocationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}

GET /payrollPT/taxDataWorkLocations/{workLocationKey}

POST Operations

POST TaxDataWorkLocations

Creates a new entity record.

The following elements are required:

taxDataWorkLocationResource

(ApiTaxDataWorkLocationResource) The request body should contain the entity record that should be created.
See ApiTaxDataWorkLocationResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiTaxDataWorkLocationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/extension

POST /payrollPT/taxDataWorkLocations/extension

POST TaxDataWorkLocations (with ApiBaseTaxDataWorkLocation)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

taxDataWorkLocationResource

(ApiTaxDataWorkLocationResource) The request body should contain the entity record that should be created.
See ApiTaxDataWorkLocationResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseTaxDataWorkLocationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations

POST /payrollPT/taxDataWorkLocations

PUT Operations

PUT Set ActivityStartDate TaxDataWorkLocation

Updates the value of attribute 'ActivityStartDate' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/activityStartDate

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/activityStartDate

PUT Set EconomicActivityClassification TaxDataWorkLocation

Updates the value of attribute 'EconomicActivityClassification' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/economicActivityClassification

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/economicActivityClassification

PUT Set IsActive TaxDataWorkLocation

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/isActive

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/isActive

PUT Set Location TaxDataWorkLocation

Updates the value of attribute 'Location' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/location

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/location

PUT Set NISS TaxDataWorkLocation

Updates the value of attribute 'NISS' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/nISS

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/nISS

PUT Set SingleReportCode TaxDataWorkLocation

Updates the value of attribute 'SingleReportCode' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/singleReportCode

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/singleReportCode

PUT Set WorkLocationCode TaxDataWorkLocation

Updates the value of attribute 'WorkLocationCode' in the specified entity record.

The following elements are required:

workLocationKey	(string) Work Location.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}/workLocationCode

PUT /payrollPT/taxDataWorkLocations/{workLocationKey}/workLocationCode

DELETE Operations

DELETE TaxDataWorkLocation by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{id}

DELETE /payrollPT/taxDataWorkLocations/{id}

DELETE TaxDataWorkLocation by key

Deletes the entity record that matches the specified key.

The following elements are required:

workLocationKey

(string) Work Location.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/taxDataWorkLocations/{workLocationKey}

DELETE /payrollPT/taxDataWorkLocations/{workLocationKey}

Resources

ApiBaseTaxDataWorkLocationResource

The following elements are required:

workLocationKey	(string) Work Location.
country	(string) Country.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
cityName	(string) City Name.
postalZone	(string) Postal Zone.
company	(string) Company.
isHeadQuarter	(bool) Is Headquarters.

The following elements are optional:

nISS	(string) NISS.
workLocationCode	(string) Work Location Code.
location	(string) Location.
economicActivityClassification	(string) CAE.
activityStartDate	(DateTime) Start of Activity.
singleReportCode	(string) Single Report Code.
name	(string) Name.
contactName	(string) Contact Name.
contactTitle	(string) Contact Title.
formattedAddress	(string) Formatted Address.
address	(string) Address.
electronicMail	(string) Email.
fax	(string) Fax.
telephone	(string) Telephone.
mobile	(string) Mobile.
contact	(string) Contact.

ApiTaxDataWorkLocationResource

The following elements are required:

workLocationKey

(string) Work Location.

The following elements are optional:

nISS	(string) NISS.
workLocationCode	(string) Work Location Code.
location	(string) Location.
economicActivityClassification	(string) CAE.
activityStartDate	(DateTime) Start of Activity.
singleReportCode	(string) Single Report Code.

BaseTaxDataWorkLocationResource

The following elements are required:

workLocationKey	(string) Work Location.
country	(string) Country.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
cityName	(string) City Name.
postalZone	(string) Postal Zone.
company	(string) Company.
isHeadQuarter	(bool) Is Headquarters.

The following elements are optional:

nISS	(string) NISS.
workLocationCode	(string) Work Location Code.
location	(string) Location.
economicActivityClassification	(string) CAE.
activityStartDate	(DateTime) Start of Activity.
singleReportCode	(string) Single Report Code.
name	(string) Name.
contactName	(string) Contact Name.
contactTitle	(string) Contact Title.
formattedAddress	(string) Formatted Address.
address	(string) Address.
electronicMail	(string) Email.
fax	(string) Fax.
telephone	(string) Telephone.
mobile	(string) Mobile.
contact	(string) Contact.

TaxDataWorkLocationResource

The following elements are required:

workLocationKey

(string) Work Location.

The following elements are optional:

nISS	(string) NISS.
workLocationCode	(string) Work Location Code.
location	(string) Location.
economicActivityClassification	(string) CAE. (fk) Allowed value: the natural key of a record of type EconomicActivityClassification.
activityStartDate	(DateTime) Start of Activity.
singleReportCode	(string) Single Report Code.