Taxes | AT Communication Request

Service to manage entities of type 'AuthorityCommunicationRequest'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET AuthorityCommunicationRequests (odata)
  • GET AuthorityCommunicationRequest by identifier
  • GET AuthorityCommunicationRequest by key
• POST:
  • POST AuthorityCommunicationRequests
  • POST Process Communication To Tax Authority
• PUT:
  • PUT Set IsActive AuthorityCommunicationRequest
  • PUT Set RequestKey AuthorityCommunicationRequest
  • PUT Set SourceDocId AuthorityCommunicationRequest
  • PUT Set SourceSchemaEntityId AuthorityCommunicationRequest
  • PUT Set SourceDoc AuthorityCommunicationRequest
  • PUT Set CommunicationAttempts AuthorityCommunicationRequest
  • PUT Set RequestMessageXML AuthorityCommunicationRequest
  • PUT Set ResponseCode AuthorityCommunicationRequest
  • PUT Set ResponseDescription AuthorityCommunicationRequest
  • PUT Set ResponseATDocCodeID AuthorityCommunicationRequest
  • PUT Set ResponseDocumentNumber AuthorityCommunicationRequest
  • PUT Set ErrorMessage AuthorityCommunicationRequest
  • PUT Set ErrorDetails AuthorityCommunicationRequest
  • PUT Set Company AuthorityCommunicationRequest
  • PUT Set CommunicationStatus AuthorityCommunicationRequest
  • PUT Set DeclarationType AuthorityCommunicationRequest
  • PUT Set OperationType AuthorityCommunicationRequest
• DELETE:
  • DELETE AuthorityCommunicationRequest by identifier
  • DELETE AuthorityCommunicationRequest by key

All Resources

This service uses the following resources:

• ApiAuthorityCommunicationRequestResource
• AuthorityCommunicationRequestResource
• RequestCommunicationToTaxAuthority

All Enumerations

This service uses the following enumerations:

• AuthorityCommunicationState
• AuthorityDeclarationType
• AuthorityOperationType

GET Operations

GET AuthorityCommunicationRequests (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

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:

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:

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:

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.

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:

POST Process Communication To Tax Authority

Custom operation 'ProcessCommunicationToTaxAuthority'.

The following elements are required:

requestCommunicationToTaxAuthority

(RequestCommunicationToTaxAuthority) RequestCommunicationToTaxAuthority.

Response:

When successful, the response body contains a string.

Resource URL:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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 financial, transport or working documents. See AuthorityDeclarationType.
operationType	(enum AuthorityOperationType) The request's operation type. Indicates if it is a register request or change status request. 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 financial, transport or working documents. See AuthorityDeclarationType.
operationType	(enum AuthorityOperationType) The request's operation type. Indicates if it is a register request or change status request. See AuthorityOperationType.

RequestCommunicationToTaxAuthority

The following elements are required:

company	(string) Company.
documentType	(enum AuthorityDeclarationType) Document Type. See AuthorityDeclarationType.

The following elements are optional:

fromDate	(DateTime) From Date.
toDate	(DateTime) To Date.

Enumerations

AuthorityCommunicationState

1	Pending
2	Processing
3	Succeeded
4	Failed

AuthorityDeclarationType

1	Financial
2	Transport
3	Series
4	Working

AuthorityOperationType

1	Register
2	ChangeStatus