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
- GET AuthorityCommunicationRequestCVs (paged)
- GET AuthorityCommunicationRequestCV by identifier
- GET AuthorityCommunicationRequestCV by key
- GET Print AuthorityCommunicationRequestCV by identifier
- GET Print AuthorityCommunicationRequestCV by key
- GET Original Print AuthorityCommunicationRequestCVOriginal by identifier
- GET Original Print AuthorityCommunicationRequestCV by key
- POST:
-
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
- DELETE:
All Resources
This service uses the following resources:
- ApiAuthorityCommunicationRequestCVResource
- AuthorityCommunicationRequestCVResource
- RequestCommunicationToTaxAuthorityCV
All Enumerations
This service uses the following enumerations:
GET AuthorityCommunicationRequestCVs
Returns the list of all the entity records available.
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs
GET /taxesCore/authorityCommunicationRequestCVs
GET AuthorityCommunicationRequestCVs (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 AuthorityCommunicationRequestCVResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs?page={page}&pageSize={pageSize}
GET /taxesCore/authorityCommunicationRequestCVs?page={page}&pageSize={pageSize}
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{id}
GET /taxesCore/authorityCommunicationRequestCVs/{id}
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}
GET /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}
GET Print AuthorityCommunicationRequestCV 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/authorityCommunicationRequestCVs/{id}/print?template={template}
GET /taxesCore/authorityCommunicationRequestCVs/{id}/print?template={template}
GET Print AuthorityCommunicationRequestCV 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/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/print
GET /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/print
GET Original Print AuthorityCommunicationRequestCVOriginal 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/authorityCommunicationRequestCVs/{id}/printOriginal?template={template}
GET /taxesCore/authorityCommunicationRequestCVs/{id}/printOriginal?template={template}
GET Original Print AuthorityCommunicationRequestCV 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/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/printOriginal
GET /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/printOriginal
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs
POST /taxesCore/authorityCommunicationRequestCVs
POST Process Communication To Tax Authority
Custom operation 'ProcessCommunicationToTaxAuthorityCV'.
The following elements are required:
| requestCommunicationToTaxAuthority | (RequestCommunicationToTaxAuthorityCV) RequestCommunicationToTaxAuthority. |
Response:
| When successful, the response body contains a string. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/processCommunicationToTaxAuthorityCV
POST /taxesCore/authorityCommunicationRequestCVs/processCommunicationToTaxAuthorityCV
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/communicationStatus
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/communicationStatus
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/company
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/company
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/isActive
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/isActive
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/led
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/led
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/requestKey
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/requestKey
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/requestMessageXML
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/requestMessageXML
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/responseDescription
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/responseDescription
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/responseDocumentId
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/responseDocumentId
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceDoc
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceDoc
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceDocId
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceDocId
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceSchemaEntityId
PUT /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}/sourceSchemaEntityId
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{id}
DELETE /taxesCore/authorityCommunicationRequestCVs/{id}
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:
api/{tenantKey}/{orgKey}/taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}
DELETE /taxesCore/authorityCommunicationRequestCVs/{companyKey}/{requestKey}
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 { |
| 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. |
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 { |
| 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. |
RequestCommunicationToTaxAuthorityCV
The following elements are required:
| company | (string) Company. |
The following elements are optional:
| sourceSchemaEntityId | (string) Source Schema Entity Id. |
| fromDate | (DateTime) From Date. |
| toDate | (DateTime) To Date. |