Taxes | AT Communication Request

The Authority Communication Request endpoint is used to get information about the result of the communication with the Portuguese Tax Authority (AT).(RESERVED FOR INTERNAL USE.).

Overview

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests

URL	api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST AuthorityCommunicationRequests
PUT:
DELETE:
- DELETE AuthorityCommunicationRequest by identifier
- DELETE AuthorityCommunicationRequest by key

All Resources

This service uses the following resources:

ApiAuthorityCommunicationRequestResource
AuthorityCommunicationRequestResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AuthorityCommunicationState
AuthorityDeclarationType
AuthorityOperationType

GET Operations

GET AuthorityCommunicationRequests

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests

GET /taxesCore/authorityCommunicationRequests

GET AuthorityCommunicationRequests (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 AuthorityCommunicationRequestResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests?page={page}&pageSize={pageSize}

GET /taxesCore/authorityCommunicationRequests?page={page}&pageSize={pageSize}

GET AuthorityCommunicationRequest 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 AuthorityCommunicationRequestResource.

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}/taxesCore/authorityCommunicationRequests/{id}

GET /taxesCore/authorityCommunicationRequests/{id}

GET AuthorityCommunicationRequest by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
requestKey	(int) The request's key. It is an auto number.

Response:

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

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}

GET /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}

GET Print AuthorityCommunicationRequest by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests/{id}/print?template={template}

GET /taxesCore/authorityCommunicationRequests/{id}/print?template={template}

GET Print AuthorityCommunicationRequest by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
requestKey	(int) The request's key. It is an auto number.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/print

GET /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/print

GET Original Print AuthorityCommunicationRequestOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests/{id}/printOriginal?template={template}

GET /taxesCore/authorityCommunicationRequests/{id}/printOriginal?template={template}

GET Original Print AuthorityCommunicationRequest by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
requestKey	(int) The request's key. It is an auto number.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/printOriginal

GET /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/printOriginal

POST Operations

POST AuthorityCommunicationRequests

Creates a new entity record.

The following elements are required:

authorityCommunicationRequestResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiAuthorityCommunicationRequestResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequests

POST /taxesCore/authorityCommunicationRequests

PUT Operations

PUT Set CommunicationAttempts AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(int) 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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/communicationAttempts

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/communicationAttempts

PUT Set CommunicationStatus AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(enum AuthorityCommunicationState) The request body should contain the new value for the attribute. See AuthorityCommunicationState.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/communicationStatus

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/communicationStatus

PUT Set Company AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/company

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/company

PUT Set DeclarationType AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(enum AuthorityDeclarationType) The request body should contain the new value for the attribute. See AuthorityDeclarationType.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/declarationType

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/declarationType

PUT Set ErrorDetails AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/errorDetails

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/errorDetails

PUT Set ErrorMessage AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/errorMessage

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/errorMessage

PUT Set IsActive AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/isActive

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/isActive

PUT Set OperationType AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(enum AuthorityOperationType) The request body should contain the new value for the attribute. See AuthorityOperationType.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/operationType

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/operationType

PUT Set RequestKey AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(int) 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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/requestKey

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/requestKey

PUT Set RequestMessageXML AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/requestMessageXML

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/requestMessageXML

PUT Set ResponseATDocCodeID AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseATDocCodeID

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseATDocCodeID

PUT Set ResponseCode AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseCode

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseCode

PUT Set ResponseDescription AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseDescription

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseDescription

PUT Set ResponseDocumentNumber AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseDocumentNumber

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/responseDocumentNumber

PUT Set SourceDoc AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceDoc

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceDoc

PUT Set SourceDocId AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(Guid) 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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceDocId

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceDocId

PUT Set SourceSchemaEntityId AuthorityCommunicationRequest

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

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
companyKey	(string) The company key.
value	(Guid) 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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceSchemaEntityId

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/sourceSchemaEntityId

PUT Set Custom Attribute AuthorityCommunicationRequest

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
requestKey	(int) The request's key. It is an auto number.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/{customAttributeName}

PUT /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}/{customAttributeName}

DELETE Operations

DELETE AuthorityCommunicationRequest 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}/taxesCore/authorityCommunicationRequests/{id}

DELETE /taxesCore/authorityCommunicationRequests/{id}

DELETE AuthorityCommunicationRequest by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
requestKey	(int) The request's key. It is an auto number.

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}/taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}

DELETE /taxesCore/authorityCommunicationRequests/{companyKey}/{requestKey}

Resources

ApiAuthorityCommunicationRequestResource

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
sourceDocId	(Guid) The document's identifier. Indicates the document comunicated on this request.
sourceSchemaEntityId	(Guid) The document's source schema entity identifier. Indicates the schema entity of the document comunicated on this request.
sourceDoc	(string) The source document using the format {..}. Indicates the natural key of the document comunicated on this request.
company	(string) The request company. The company code is the central organizational unit within the system.

The following elements are optional:

communicationAttempts	(int) The number of communication attempts for the current request.
requestMessageXML	(string) The actual XML message sent to the AT.
responseCode	(string) The response's code returned by the AT webservice.
responseDescription	(string) The response's description returned by the AT webservice.
responseATDocCodeID	(string) When aplicable the document code returned by the AT webservice after a valid communication.
responseDocumentNumber	(string) The number of the document returned by the AT webservice.
errorMessage	(string) The error messages related to problems communicating with the web service.
errorDetails	(string) The details of the error messages related to problems communicating with the web service.
communicationStatus	(enum AuthorityCommunicationState) The request's status. Indicates the status of the request. See AuthorityCommunicationState.
declarationType	(enum AuthorityDeclarationType) The request's type. Indicates if it is a request for transport or financial documents. See AuthorityDeclarationType.
operationType	(enum AuthorityOperationType) The request's operation. Indicates if the operation is registration or change status fo the document. See AuthorityOperationType.

AuthorityCommunicationRequestResource

The following elements are required:

requestKey	(int) The request's key. It is an auto number.
sourceDocId	(Guid) The document's identifier. Indicates the document comunicated on this request.
sourceSchemaEntityId	(Guid) The document's source schema entity identifier. Indicates the schema entity of the document comunicated on this request.
sourceDoc	(string) The source document using the format {..}. Indicates the natural key of the document comunicated on this request.
company	(string) The request company. The company code is the central organizational unit within the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

communicationAttempts	(int) The number of communication attempts for the current request.
requestMessageXML	(string) The actual XML message sent to the AT.
responseCode	(string) The response's code returned by the AT webservice.
responseDescription	(string) The response's description returned by the AT webservice.
responseATDocCodeID	(string) When aplicable the document code returned by the AT webservice after a valid communication.
responseDocumentNumber	(string) The number of the document returned by the AT webservice.
errorMessage	(string) The error messages related to problems communicating with the web service.
errorDetails	(string) The details of the error messages related to problems communicating with the web service.
communicationStatus	(enum AuthorityCommunicationState) The request's status. Indicates the status of the request. See AuthorityCommunicationState.
declarationType	(enum AuthorityDeclarationType) The request's type. Indicates if it is a request for transport or financial documents. See AuthorityDeclarationType.
operationType	(enum AuthorityOperationType) The request's operation. Indicates if the operation is registration or change status fo the document. See AuthorityOperationType.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AuthorityCommunicationState

1	Pending
2	Processing
3	Succeeded
4	Failed

AuthorityDeclarationType

1	Financial
2	Transport
3	Series

AuthorityOperationType

1	Register
2	ChangeStatus
3	Finish
4	Annul