Taxes | DNRE Communication Request

Service to manage entities of type 'AuthorityCommunicationRequestCV'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET AuthorityCommunicationRequestCVs (odata)
  • GET AuthorityCommunicationRequestCV by identifier
  • GET AuthorityCommunicationRequestCV by key
• POST:
  • POST AuthorityCommunicationRequestCVs
• PUT:
  • PUT Set IsActive AuthorityCommunicationRequestCV
  • PUT Set RequestKey AuthorityCommunicationRequestCV
  • PUT Set SourceDocId AuthorityCommunicationRequestCV
  • PUT Set SourceSchemaEntityId AuthorityCommunicationRequestCV
  • PUT Set SourceDoc AuthorityCommunicationRequestCV
  • PUT Set RequestMessageXML AuthorityCommunicationRequestCV
  • PUT Set ResponseDocumentId AuthorityCommunicationRequestCV
  • PUT Set ResponseDescription AuthorityCommunicationRequestCV
  • PUT Set CommunicationStatus AuthorityCommunicationRequestCV
  • PUT Set Company AuthorityCommunicationRequestCV
  • PUT Set Led AuthorityCommunicationRequestCV
  • PUT Set CommunicationAttempts AuthorityCommunicationRequestCV
  • PUT Set OperationType AuthorityCommunicationRequestCV
• DELETE:
  • DELETE AuthorityCommunicationRequestCV by identifier
  • DELETE AuthorityCommunicationRequestCV by key

All Resources

This service uses the following resources:

• ApiAuthorityCommunicationRequestCVResource
• AuthorityCommunicationRequestCVResource

All Enumerations

This service uses the following enumerations:

• AuthorityCommunicationState
• AuthorityCVOperationType

GET Operations

GET AuthorityCommunicationRequestCVs (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 AuthorityCommunicationRequestCVResource.

Response status codes:

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

Resource URL:

GET AuthorityCommunicationRequestCV 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 AuthorityCommunicationRequestCVResource.

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 AuthorityCommunicationRequestCV 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 AuthorityCommunicationRequestCVResource.

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 AuthorityCommunicationRequestCVs

Creates a new entity record.

The following elements are required:

authorityCommunicationRequestCVResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set CommunicationAttempts AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV

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 IsActive AuthorityCommunicationRequestCV

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 Led AuthorityCommunicationRequestCV

Updates the value of attribute 'Led' 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 OperationType AuthorityCommunicationRequestCV

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 AuthorityCVOperationType) The request body should contain the new value for the attribute. See AuthorityCVOperationType.

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 AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV

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 ResponseDescription AuthorityCommunicationRequestCV

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 ResponseDocumentId AuthorityCommunicationRequestCV

Updates the value of attribute 'ResponseDocumentId' 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 AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV

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 AuthorityCommunicationRequestCV 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 AuthorityCommunicationRequestCV 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

ApiAuthorityCommunicationRequestCVResource

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) Company.

The following elements are optional:

requestMessageXML	(string) The actual XML message sent to the AT.
responseDocumentId	(string) The identifier of the document returned by the DNRE webservice.
responseDescription	(string) The response's description returned by the DNRE webservice.
communicationStatus	(enum AuthorityCommunicationState) The request's status. Indicates the status of the request. See AuthorityCommunicationState.
led	(string) Place of issue of the document. It is required for electronic communication of the document in Cape Verde.
communicationAttempts	(int) The number of communication attempts for the current request.
operationType	(enum AuthorityCVOperationType) The request's operation type. Indicates if it is a register request or change status request. See AuthorityCVOperationType.

AuthorityCommunicationRequestCVResource

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) Company. (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:

requestMessageXML	(string) The actual XML message sent to the AT.
responseDocumentId	(string) The identifier of the document returned by the DNRE webservice.
responseDescription	(string) The response's description returned by the DNRE webservice.
communicationStatus	(enum AuthorityCommunicationState) The request's status. Indicates the status of the request. See AuthorityCommunicationState.
led	(string) Place of issue of the document. It is required for electronic communication of the document in Cape Verde.
communicationAttempts	(int) The number of communication attempts for the current request.
operationType	(enum AuthorityCVOperationType) The request's operation type. Indicates if it is a register request or change status request. See AuthorityCVOperationType.

Enumerations

AuthorityCommunicationState

1	Pending
2	Processing
3	Succeeded
4	Failed

AuthorityCVOperationType

1	Register
2	Cancelation