Taxes | Series Communications
Service to manage the communication of series to the tax authority. Once the series is communicated, the series' name is automatically changed to represent the combination, which has been registered with the tax authority, of the document type and series (i.e.: FA2023).
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/seriesCommunications |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Series Communications
Returns the list of entity records that can be processed by the 'TaxesSetups' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| action | (ATCommunicateSeriesAction) Action. |
The following elements are optional:
| company | (string) Company This is a query string parameter. |
| fiscalUse | (FiscalUse?) Fiscal Use This is a query string parameter. |
| fiscalDocumentTypeFilter | (string) Fiscal Document Type This is a query string parameter. |
| validOn | (DateTime?) Valid On This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See CommunicateSeriesLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Communicate Series
Custom operation 'CommunicateSeries'.
The following elements are required:
| apiCommunicateSeries | (ApiCommunicateSeries) ApiCommunicateSeries. |
Response:
| When successful, the response body contains a string. |
Resource URL:
POST Series Communications
Instructs the 'TaxesSetups' service to process the specified entity records.
The following elements are required:
| list | (CommunicateSeriesLine) List of the entity records that should be processed. See CommunicateSeriesLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
ApiCommunicateSeries
The following elements are required:
| company | (string) The company. |
| action | (enum ATCommunicateSeriesAction) The action to be performed on the indicated series.
See ATCommunicateSeriesAction. |
CommunicateSeries
The following elements are required:
| selectedCount | (int) Selected Count. |
| action | (enum ATCommunicateSeriesAction) Action.
See ATCommunicateSeriesAction. |
The following elements are optional:
| company | (string) Company. |
| fiscalUse | (enum FiscalUse) Fiscal Use.
See FiscalUse. |
| fiscalDocumentTypeFilter | (string) Fiscal Document Type. |
| validOn | (DateTime) Valid On. |
CommunicateSeriesLine
The following elements are required:
| selected | (bool) Selected. |
| serie | (string) Serie. |
| documentType | (string) Document Type. |
| documentTypeId | (Guid) Document Type Id. |
| fiscalDocumentType | (string) Fiscal Document Type. |
| lastUsedNumber | (int) Last Used Number. |
| lastDate | (DateTime) Last Date. |
| schemaEntityId | (Guid) Schema Entity Id. |
| schemaEntityNaturalKey | (string) Schema Entity Natural Key. |
The following elements are optional:
| documentTypeSerieLineId | (Guid) Document Type Serie Line Id. |
| aTValidationCode | (string) Validation Code. |
| aTCommunicationStatus | (enum ATCommunicationStatus) Communication Status.
See ATCommunicationStatus. |
| aTCommunicationDate | (DateTime) Communication Date. |