Tax Authority Service (Portugal) (TAXPT) Client Library

The client library allows consuming the service REST API.

Index

Service Client

Class Description
TaxAuthorityPortugalClient The entry point of the Tax Authority Service (Portugal) client library.

^ Back to top

Controllers

Class Description
CIUSPT Provides operations on ciuspt.
CryptoSaft Provides operations on crypto saft.
Dispatches Provides operations on dispatches.
EncryptionKeys Provides operations on encryption keys.
Invoices Provides operations on invoices.
Payments Provides operations on payments.
Saft Provides operations on saft.
Series Provides operations on series.
WorkingDocuments Provides operations on working documents.

^ Back to top

Models

Class Description
AdditionalItemData Describes an additional item.
AddressData Describes an address.
AllowanceChargeData Describes an allowance charge.
AmountData Describes an amount.
CardAccountData Describes a card account.
ChangeInvoiceStatusRequest Describes a change invoice status request.
ChangePaymentStatusRequest Describes a change payment status request.
ChangeWorkingDocumentStatusRequest Describes a change working document status request.
DecryptCryptoSaftRequestData Describes a decrypt crypto saft request.
DecryptCryptoSaftResponseData Describes a decrypt crypto saft response.
DeleteInvoiceRequest Describes a delete invoice request.
DeletePaymentRequest Describes a delete payment request.
DeleteWorkingDocumentRequest Describes a delete working document request.
DeliveryData Describes a delivery.
DisableSeriesRequest Describes a disable series request.
DispatchData Describes a dispatch.
DispatchLineData Describes a dispatch line.
DispatchRequest Describes a dispatch request.
DispatchResponse Describes a dispatch response.
DispatchResult Describes a dispatch result.
DispatchResultState Describes a dispatch result state.
DocumentCustomerData Describes a document customer.
DocumentData Describes a document.
DocumentLineData Describes a document line.
DocumentLineTaxData Describes a document line tax.
DocumentReferenceData Describes a document reference.
DocumentResponse Describes a document response.
DocumentResult Describes a document result.
DocumentResultState Describes a document result state.
DocumentTotalsData Describes a document totals.
EncryptionKeyData Describes an encryption key.
EncryptionKeyRequestData Describes an encryption key request.
EncryptionKeyRetrievalData Describes an encryption key retrieval.
EncryptSaftRequestData Describes an encrypt saft request.
EncryptSaftResponseData Describes an encrypt saft response.
GetSeriesRequest Describes a get series request.
GetSeriesResponse Describes a get series response.
GetSeriesResult Describes a get series result.
InvoiceData Describes an invoice.
InvoiceHeaderData Describes an invoice header.
InvoiceLineData Describes an invoice line.
InvoiceResponse Describes an invoice response.
InvoiceStatus Describes an invoice status.
ItemData Describes an item.
NewInvoiceStatus Describes a new invoice status.
OrderReferenceData Describes an order reference.
PartyData Describes a party.
PayeeFinancialAccountData Describes a payee financial account.
PaymentData Describes a payment.
PaymentHeaderData Describes a payment header.
PaymentLineData Describes a payment line.
PaymentMandateData Describes a payment mandate.
PaymentMeansData Describes a payment means.
PaymentResponse Describes a payment response.
PaymentStatus Describes a payment status.
QuantityData Describes a quantity.
RegisterInvoiceRequest Describes a register invoice request.
RegisterPaymentRequest Describes a register payment request.
RegisterSeriesRequest Describes a register series request.
RegisterWorkingDocumentRequest Describes a register working document request.
SendSaftRequestData Describes a send saft request.
SendSaftResponseData Describes a send saft response.
SeriesData Describes a series.
SeriesResponse Describes a series response.
SeriesResult Describes a series result.
SeriesResultState Describes a series result state.
TaxSubTotalData Describes a tax sub total.
TaxTotalData Describes a tax total.
UnregisterSeriesRequest Describes an unregister series request.
ValidateSaftRequestData Describes a validate saft request.
ValidateSaftResponseData Describes a validate saft response.
WithholdingTaxData Describes a withholding tax.
WorkingDocumentData Describes a working document.
WorkingDocumentHeaderData Describes a working document header.
WorkingDocumentLineData Describes a working document line.
WorkingDocumentResponse Describes a working document response.
WorkingDocumentStatus Describes a working document status.

^ Back to top

Enumerations

Enumeration Description
AdditionalItemType Defines the type of an additional item information.
AllowanceReasonType Defines an allowance reason.
CountryRegion Defines the country region.
DeleteDocumentCriteria Defines the criteria used for deleting invoices.
DispatchState Defines the state of a dispatch.
DispatchType Defines the type of a dispatch.
DocumentKind Defines the kind of a document as defined in CIUS-PT.
DocumentLineNature Defines the type of an invoice line.
DocumentLineType Defines the type of a document line.
DocumentType Defines the functional type of an electronic document (according to UNCL1001).
EncryptionKeyRequestState Defines the state of an encryption key request.
EncryptionKeyRetrievalState Defines the state of an encryption key retrieval.
EntityType Defines the type of an entity.
InvoiceState Defines the state of an invoice.
InvoiceType Defines the type of an invoice.
NewInvoiceState Defines the state of update invoice.
PaymentDocumentType The payment document types.
PaymentMeansCode Defines a payment means.
PaymentState Defines the state of update invoice.
PaymentType Defines a type of payment.
SaftOperation Indication of the operation to be carried out.
SaftVersion Defines a version of the SAF-T specification.
SeriesDocumentClass Defines the document class of a series.
SeriesDocumentType Defines the type of a document.
SeriesState Defines the state of a series.
SeriesStateReason Defines the reason for a series being on a given state.
SeriesType Defines the type of a series.
ServiceEndpoint Defines the external service endpoint.
TaxCategory Defines a tax category.
TaxTypeCode The tax type and code.
TaxValueType The tax amount type.
WithholdingTaxType Describes the withholding tax types.
WorkingDocumentState Defines the state of a working document.
WorkingDocumentType The working document types.

^ Back to top

Authorization Policies

Policy Description Scope
DefaultScope Defines an authorization policy that requires the default scope. li-taxpt

^ Back to top

Reference

Service Client

TaxAuthorityPortugalClient

Constructors
TaxAuthorityPortugalClient(Uri, BearerTokenCredential)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
TaxAuthorityPortugalClient(Uri, BearerTokenCredential, TaxAuthorityPortugalClientOptions)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
clientOptions TaxAuthorityPortugalClientOptions The client options.
Example
Uri address = new Uri("[service-address]");
Uri authorizationServer = new Uri("[authorization-server]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

TaxAuthorityPortugalClient client = new TaxAuthorityPortugalClient(
    new Uri(address),
    new ClientSecretCredential(
        authorizationServer,
        clientId,
        clientSecret));

^ Back to top

Error Codes

ErrorCodes

Constants
Constants Description Remarks
AuthorizationHeaderRequired The authorization header (X-TAXPT-Authz) was not found or is invalid.
CertificateRetrievalFailed The retrieval of the certificate failed.
CommunicationChannelInactive The specified communication channel is inactive.
DispatchRegistrationFailed The dispatch registration failed.
DocumentValidationFailed The document validation failed.
EncryptionKeyNotFound The encryption key does not exist.
EncryptionKeyRequestDuplicate The encryption key was already requested.
EncryptionKeyRequestFailed The encryption key request failed.
EncryptionKeyRequestNotCompleted The encryption key request is not completed.
EncryptionKeyRequestNotFound The encryption key request does not exist.
EncryptionKeyRetrievalDuplicate The encryption key was already retrieved.
EncryptionKeyRetrievalFailed The encryption key retrieval failed.
EncryptionKeyRetrievalNotFound The encryption key retrieval does not exist.
EncryptionKeysStartKeyRetrievalSecurityCodeRequired The encryption keys start key retrieval security code is required.
EndpointHeaderRequired The endpoint header (X-TAXPT-Endpoint) was not found or is invalid.
FiscalYearInvalid The specified fiscal year is invalid.
FiscalYearOrVatNumberBlocked The specified fiscal year and/or VAT number is blocked.
InternalServerError An internal error occurred while processing your request.
InvoiceChangeStatusFailed The invoice change status failed.
InvoiceDeleteFailed The invoice delete failed.
InvoiceDeleteMissingCriteria The invoice delete criteria is missing.
InvoiceRegistrationFailed The invoice registration failed.
PaymentChangeStatusFailed The payment change status failed.
PaymentDeleteFailed The payment delete failed.
PaymentDeleteMissingCriteria The payment delete criteria is missing.
PaymentRegistrationFailed The payment registration failed.
RequestArgsInvalid The request arguments are invalid.
SecurityCodeInvalid The specified security code is invalid.
SeriesDeactivationFailed The series deactivation failed.
SeriesDeregistrationFailed The series deregistration failed.
SeriesRegistrationFailed The series registration failed.
SeriesRetrievalFailed The series retrieval failed.
SoftwareProviderClaimRequired The software provider claim is required.
VatNumberInvalid The specified VAT number is invalid.
WorkingDocumentChangeStatusFailed The working document change status failed.
WorkingDocumentDeleteFailed The working document delete failed.
WorkingDocumentDeleteMissingCriteria The working document delete criteria is missing.
WorkingDocumentRegistrationFailed The working document registration failed.

Controllers

CIUSPTClientController

Provides operations on ciuspt.

Methods
GetXmlAsync()

Retrieves the XML representation of a document.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResponse>> GetXmlAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentData request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentData The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResponse The XML that represents the document.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CryptoSaftClientController

Provides operations on crypto saft.

Methods
DecryptCryptoSaftAsync()

Decrypts a CryptoSAF-T file to produce the corresponding SAF-T file.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DecryptCryptoSaftResponseData>> DecryptCryptoSaftAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DecryptCryptoSaftRequestData request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DecryptCryptoSaftRequestData The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DecryptCryptoSaftResponseData The operation response.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

EncryptSaftAsync()

Encrypts a SAF-T file to produce the corresponding CryptoSAF-T file.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptSaftResponseData>> EncryptSaftAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptSaftRequestData request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptSaftRequestData The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptSaftResponseData The operation response.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DispatchesClientController

Provides operations on dispatches.

Methods
GetSupportedDocumentTypesAsync()

Retrieves the list of document types that can be delivered to the tax authority.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<string>>> GetSupportedDocumentTypesAsync(CancellationToken cancellationToken = default);
Parameters

The operation has no parameters.

Returns
Return Type Description
System.Collections.Generic.IList<string> The list of document types that can be delivered to the tax authority.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RegisterAsync()

Registers a dispatch.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchResponse>> RegisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchResponse The response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

EncryptionKeysClientController

Provides operations on encryption keys.

Methods
GetKeyAsync()

Retrieves an encryption key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyData>> GetKeyAsync(int fiscalYear, string vatNumber, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
fiscalYear int The fiscal year. Required.> 2020.
vatNumber string The vat number. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyData The encryption key.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetKeyRequestStateAsync()

Retrieves the state of an encryption key request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRequestData>> GetKeyRequestStateAsync(int fiscalYear, string vatNumber, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
fiscalYear int The fiscal year. Required.> 2020.
vatNumber string The vat number. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRequestData The encryption key request.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetKeyRetrievalStateAsync()

Retrieves the state of an encryption key retrieval.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRetrievalData>> GetKeyRetrievalStateAsync(int fiscalYear, string vatNumber, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
fiscalYear int The fiscal year. Required.> 2020.
vatNumber string The vat number. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRetrievalData The encryption key retrieval.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

StartKeyRequestAsync()

Starts an encryption key request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> StartKeyRequestAsync(int fiscalYear, string vatNumber, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
fiscalYear int The fiscal year. Required.> 2020.
vatNumber string The vat number. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.Accepted Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

StartKeyRetrievalAsync()

Starts an encryption key (previously requested) retrieval.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> StartKeyRetrievalAsync(int fiscalYear, string vatNumber, string securityCode, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
fiscalYear int The fiscal year. Required.> 2020.
vatNumber string The vat number. Required.
securityCode string The security code. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.Accepted Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

InvoicesClientController

Provides operations on invoices.

Methods
ChangeStatusAsync()

Changes the status of an invoice.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse>> ChangeStatusAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangeInvoiceStatusRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangeInvoiceStatusRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse The response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes invoices defined by the request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse>> DeleteAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteInvoiceRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteInvoiceRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse The response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetSupportedDocumentTypesAsync()

Retrieves the list of document types that can be delivered to the tax authority.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<string>>> GetSupportedDocumentTypesAsync(CancellationToken cancellationToken = default);
Parameters

The operation has no parameters.

Returns
Return Type Description
System.Collections.Generic.IList<string> The list of document types that can be delivered to the tax authority.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RegisterAsync()

Registers an invoice.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse>> RegisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterInvoiceRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterInvoiceRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceResponse The response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

PaymentsClientController

Provides operations on payments.

Methods
ChangeStatusAsync()

Changes the status of a payment (receipt).

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse>> ChangeStatusAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangePaymentStatusRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangePaymentStatusRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse The payment status change response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes payments (receipts) defined by the request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse>> DeleteAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeletePaymentRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeletePaymentRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse The delete payments response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RegisterAsync()

The working document registration response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse>> RegisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterPaymentRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterPaymentRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentResponse The payment response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SaftClientController

Provides operations on saft.

Methods
SendSaftAsync()

Sends a SAFT-T file.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SendSaftResponseData>> SendSaftAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SendSaftRequestData request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SendSaftRequestData The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SendSaftResponseData The operation response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidateSaftAsync()

Validates a SAF-T file.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ValidateSaftResponseData>> ValidateSaftAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ValidateSaftRequestData request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ValidateSaftRequestData The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ValidateSaftResponseData The operation response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SeriesClientController

Provides operations on series.

Methods
DisableAsync()

Disables a series with the Tax Authority.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse>> DisableAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DisableSeriesRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DisableSeriesRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse The result of disabling the series.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Retrieves the series that match the specified criteria.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.GetSeriesResponse>> GetAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.GetSeriesRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.GetSeriesRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.GetSeriesResponse The result containing the series that match the specified criteria.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RegisterAsync()

Registers a series with the Tax Authority.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse>> RegisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterSeriesRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterSeriesRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse The result of registering the series.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UnregisterAsync()

Unregisters a series with the Tax Authority.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse>> UnregisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.UnregisterSeriesRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.UnregisterSeriesRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResponse The result of unregistering the series.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

WorkingDocumentsClientController

Provides operations on working documents.

Methods
ChangeStatusAsync()

Changes the status of a working document.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse>> ChangeStatusAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangeWorkingDocumentStatusRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ChangeWorkingDocumentStatusRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse The working document status change response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes working documents defined by the request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse>> DeleteAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteWorkingDocumentRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteWorkingDocumentRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse The response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RegisterAsync()

Registers a working document.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse>> RegisterAsync(Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterWorkingDocumentRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.RegisterWorkingDocumentRequest The request. Required.
Returns
Return Type Description
Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentResponse The working document registration response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

Models

AdditionalItemData

Describes an additional item.

Properties
Property Type Description Rules
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AdditionalItemType Gets or sets the type. Required.
Value string Gets or sets the value. Required.

^ Back to top

AddressData

Describes an address.

Properties
Property Type Description Rules
Detail string? Gets or sets the detail.
City string? Gets or sets the city.
PostalCode string? Gets or sets the postal code.
Country string? Gets or sets the country.

The model includes custom properties not described here.

^ Back to top

AllowanceChargeData

Describes an allowance charge.

Properties
Property Type Description Rules
ChargeIndicator bool True if there is a charge indicador. False otherwise. Required.
AllowanceChargeReasonCode Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AllowanceReasonType Gets or sets the allowance charge reason code. Required.
AllowanceChargeReason string Gets or sets the allowance charge reason. Required.
MultiplierFactorNumeric decimal? Gets or sets the multiplier factor numeric.
Amount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the amount. Required.
BaseAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData? Gets or sets the base amount.

^ Back to top

AmountData

Describes an amount.

Properties
Property Type Description Rules
Currency string? Gets or sets the currency.
Value decimal Gets or sets the value. Required.

^ Back to top

CardAccountData

Describes a card account.

Properties
Property Type Description Rules
PrimaryAccountNumberID string Gets or sets the primary account number id. Required.
NetworkID string Gets or sets the network id. Required.
HolderName string? Gets or sets the holder name.

^ Back to top

ChangeInvoiceStatusRequest

Describes a change invoice status request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
Invoice Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceHeaderData Gets or sets the invoice. Required.
NewDocumentStatus Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.NewInvoiceStatus Gets or sets the new document status. Required.

^ Back to top

ChangePaymentStatusRequest

Describes a change payment status request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
PaymentDocument Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentHeaderData Gets or sets the payment document. Required.
NewDocumentStatus Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentStatus Gets or sets the new document status. Required.

^ Back to top

ChangeWorkingDocumentStatusRequest

Describes a change working document status request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
WorkingDocument Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentHeaderData Gets or sets the working document. Required.
NewDocumentStatus Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentStatus Gets or sets the new document status. Required.

^ Back to top

DecryptCryptoSaftRequestData

Describes a decrypt crypto saft request.

Properties
Property Type Description Rules
Key Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyData Gets or sets the key. Required.
InputFileName string Gets or sets the input file name. Required.
OutputFileName string? Gets or sets the output file name.

^ Back to top

DecryptCryptoSaftResponseData

Describes a decrypt crypto saft response.

Properties
Property Type Description Rules
Checksum string? Gets or sets the checksum.
OutputFileName string? Gets or sets the output file name.

^ Back to top

DeleteInvoiceRequest

Describes a delete invoice request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
Criteria Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteDocumentCriteria Gets or sets the criteria. Required.
Invoices System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceHeaderData>? Gets or sets the invoices.
StartDate System.DateTime? Gets or sets the start date.
EndDate System.DateTime? Gets or sets the end date.
Reason string Gets or sets the reason. Required.

^ Back to top

DeletePaymentRequest

Describes a delete payment request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
Criteria Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteDocumentCriteria Gets or sets the criteria. Required.
Documents System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentHeaderData>? Gets or sets the documents.
StartDate System.DateTime? Gets or sets the start date.
EndDate System.DateTime? Gets or sets the end date.
Reason string Gets or sets the reason. Required.

^ Back to top

DeleteWorkingDocumentRequest

Describes a delete working document request.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
Criteria Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeleteDocumentCriteria Gets or sets the criteria. Required.
Documents System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentHeaderData>? Gets or sets the documents.
StartDate System.DateTime? Gets or sets the start date.
EndDate System.DateTime? Gets or sets the end date.
Reason string Gets or sets the reason. Required.

^ Back to top

DeliveryData

Describes a delivery.

Properties
Property Type Description Rules
ActualDate System.DateTime Gets or sets the actual date. Required.
Party System.Collections.Generic.IList<string> Gets or sets the party. Required.
StreetName string Gets or sets the street name. Required.
CityName string Gets or sets the city name. Required.
AdditionalStreetName string? Gets or sets the additional street name.
PostalZone string Gets or sets the postal zone. Required.
CountrySubentity string? Gets or sets the country subentity.
AddressLine string? Gets or sets the address line.
Country string Gets or sets the country. Required.
LocationId string? Gets or sets the location id.

^ Back to top

DisableSeriesRequest

Describes a disable series request.

Properties
Property Type Description Rules
Id string Gets or sets the id. Required.RegEx ([a-zA-Z0-9_.\-]+).
DocumentClass Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentClass Gets or sets the document class. Required.
DocumentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentType Gets or sets the document type. Required.
Justification string? Gets or sets the justification.
ValidationCode string Gets or sets the validation code. Required.
LastNumber int Gets or sets the last number. Required.

^ Back to top

DispatchData

Describes a dispatch.

Properties
Property Type Description Rules
TaxRegistrationNumber string? Gets or sets the tax registration number.
CompanyName string? Gets or sets the company name.
CompanyAddress Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AddressData? Gets or sets the company address.
DocumentNumber string? Gets or sets the document number.
DocumentCodeId string? Gets or sets the document code id.
DispatchState Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchState Gets or sets the dispatch state. Required.
MovementDate System.DateTime Gets or sets the movement date. Required.
DispatchType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchType Gets or sets the dispatch type. Required.
EntityType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EntityType Gets or sets the entity type. Required.
EntityTaxId string? Gets or sets the entity tax id.
CustomerAddress Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AddressData? Gets or sets the customer address.
CustomerName string? Gets or sets the customer name.
AddressTo Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AddressData? Gets or sets the address to.
AddressFrom Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AddressData? Gets or sets the address from.
MovementEndTime System.DateTime? Gets or sets the movement end time.
MovementStartTime System.DateTime Gets or sets the movement start time. Required.
VehicleId string? Gets or sets the vehicle id.
Lines System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchLineData>? Gets or sets the lines.
Atcud string? Gets or sets the atcud.

The model includes custom properties not described here.

^ Back to top

DispatchLineData

Describes a dispatch line.

Properties
Property Type Description Rules
OrderReferences System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.OrderReferenceData>? Gets or sets the order references.
ProductDescription string? Gets or sets the product description.
Quantity decimal Gets or sets the quantity. Required.
UnitOfMeasure string? Gets or sets the unit of measure.
UnitPrice decimal Gets or sets the unit price. Required.

The model includes custom properties not described here.

^ Back to top

DispatchRequest

Describes a dispatch request.

Properties
Property Type Description Rules
Dispatch Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchData Gets or sets the dispatch. Required.

^ Back to top

DispatchResponse

Describes a dispatch response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

DispatchResult

Describes a dispatch result.

Properties
Property Type Description Rules
DocumentNumber string? Gets or sets the document number.
DocumentCodeId string? Gets or sets the document code id.
ResultStates System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DispatchResultState>? Gets or sets the result states.
RequestXml string? Gets or sets the request xml.

The model includes custom properties not described here.

^ Back to top

DispatchResultState

Describes a dispatch result state.

Properties
Property Type Description Rules
ReturnCode string? Gets or sets the return code.
ReturnMessage string? Gets or sets the return message.

The model includes custom properties not described here.

^ Back to top

DocumentCustomerData

Describes a document customer.

Properties
Property Type Description Rules
CountryCode string? Gets or sets the country code.
TaxId string? Gets or sets the tax id.

The model includes custom properties not described here.

^ Back to top

DocumentData

Describes a document.

Properties
Property Type Description Rules
Id string Gets or sets the id. Required.
Kind Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentKind Gets or sets the kind. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentType Gets or sets the type. Required.
IssueDate System.DateTime Gets or sets the issue date. Required.
DueDate System.DateTime Gets or sets the due date. Required.
Currency string Gets or sets the currency. Required.
AccountingSupplierParty Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PartyData Gets or sets the accounting supplier party. Required.
AccountingCustomerParty Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PartyData Gets or sets the accounting customer party. Required.
Delivery System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DeliveryData> Gets or sets the delivery. Required.
Lines System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineData> Gets or sets the lines. Required.
LineExtensionAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the line extension amount. Required.
TaxExclusiveAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the tax exclusive amount. Required.
TaxInclusiveAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the tax inclusive amount. Required.
PayableAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the payable amount. Required.
TaxTotal Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxTotalData Gets or sets the tax total. Required.
DocumentReference System.Collections.Generic.IList<string>? Gets or sets the document reference.
OrderReference string? Gets or sets the order reference.
PaymentMeans Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentMeansData? Gets or sets the payment means.
PaymentTerms System.Collections.Generic.IList<string>? Gets or sets the payment terms.
DocumentFile string? Gets or sets the document file.
AccountingCost string? Gets or sets the accounting cost.
Atcud string? Gets or sets the atcud.
Qrcode string? Gets or sets the qrcode.

^ Back to top

DocumentLineData

Describes a document line.

Properties
Property Type Description Rules
Id string Gets or sets the id. Required.
Quantity Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.QuantityData Gets or sets the quantity. Required.
LineExtensionAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the line extension amount. Required.
AccountingCost string? Gets or sets the accounting cost.
Item Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ItemData Gets or sets the item. Required.
Price Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the price. Required.
AllowanceCharge System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AllowanceChargeData> Gets or sets the allowance charge. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineType Gets or sets the type. Required.
OrderLineReference string? Gets or sets the order line reference.

^ Back to top

DocumentLineTaxData

Describes a document line tax.

Properties
Property Type Description Rules
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxTypeCode Gets or sets the type. Required.
CountryRegion Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.CountryRegion Gets or sets the country region. Required.
ValueType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxValueType Gets or sets the value type. Required.
Value double Gets or sets the value. Required.
StampTaxValue string? Gets or sets the stamp tax value.

The model includes custom properties not described here.

^ Back to top

DocumentReferenceData

Describes a document reference.

Properties
Property Type Description Rules
OriginatingDocumentNumber string Gets or sets the originating document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.

^ Back to top

DocumentResponse

Describes a document response.

Properties
Property Type Description Rules
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.
IsValid bool True if the document is valid. False otherwise. Required.
Xml string Gets or sets the xml. Required.
SchemaErrors System.Collections.Generic.IList<string>? Gets or sets the schema errors.
BusinessErrors System.Collections.Generic.IList<string>? Gets or sets the business errors.

^ Back to top

DocumentResult

Describes a document result.

Properties
Property Type Description Rules
DocumentNumber string? Gets or sets the document number.
ResultStates System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResultState>? Gets or sets the result states.
RequestXml string? Gets or sets the request xml.

The model includes custom properties not described here.

^ Back to top

DocumentResultState

Describes a document result state.

Properties
Property Type Description Rules
ReturnCode string? Gets or sets the return code.
ReturnMessage string? Gets or sets the return message.

The model includes custom properties not described here.

^ Back to top

DocumentTotalsData

Describes a document totals.

Properties
Property Type Description Rules
TaxPayable decimal Gets or sets the tax payable. Required.
NetTotal decimal Gets or sets the net total. Required.
GrossTotal decimal Gets or sets the gross total. Required.

The model includes custom properties not described here.

^ Back to top

EncryptionKeyData

Describes an encryption key.

Properties
Property Type Description Rules
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.
FiscalYear int Gets or sets the fiscal year. Required.> 2020.
VatNumber string? Gets or sets the vat number.
Key string? Gets or sets the key.
IV string? Gets or sets the iv.
GeneratedOn System.DateTime? Gets or sets the generated on.
LastRetrievedOn System.DateTime? Gets or sets the last retrieved on.
LastAccessedOn System.DateTime? Gets or sets the last accessed on.

^ Back to top

EncryptionKeyRequestData

Describes an encryption key request.

Properties
Property Type Description Rules
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.
FiscalYear int Gets or sets the fiscal year. Required.> 2020.
VatNumber string? Gets or sets the vat number.
State Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRequestState Gets or sets the state. Required.
ErrorCode string? Gets or sets the error code.
ErrorMessage string? Gets or sets the error message.

^ Back to top

EncryptionKeyRetrievalData

Describes an encryption key retrieval.

Properties
Property Type Description Rules
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.
FiscalYear int Gets or sets the fiscal year. Required.> 2020.
VatNumber string? Gets or sets the vat number.
SecurityCode string? Gets or sets the security code.
State Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyRetrievalState Gets or sets the state. Required.
ErrorCode string? Gets or sets the error code.
ErrorMessage string? Gets or sets the error message.

^ Back to top

EncryptSaftRequestData

Describes an encrypt saft request.

Properties
Property Type Description Rules
Key Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.EncryptionKeyData Gets or sets the key. Required.
InputFileName string Gets or sets the input file name. Required.
OutputFileName string? Gets or sets the output file name.

^ Back to top

EncryptSaftResponseData

Describes an encrypt saft response.

Properties
Property Type Description Rules
Checksum string? Gets or sets the checksum.
OutputFileName string? Gets or sets the output file name.

^ Back to top

GetSeriesRequest

Describes a get series request.

Properties
Property Type Description Rules
Id string? Gets or sets the id.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesType? Gets or sets the type.
DocumentClass Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentClass? Gets or sets the document class.
DocumentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentType? Gets or sets the document type.
ValidationCode string? Gets or sets the validation code.
StartDate System.DateTime? Gets or sets the start date.
EndDate System.DateTime? Gets or sets the end date.
State Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesState? Gets or sets the state.

^ Back to top

GetSeriesResponse

Describes a get series response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.GetSeriesResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

GetSeriesResult

Describes a get series result.

Properties
Property Type Description Rules
SeriesList System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesData>? Gets or sets the series list.
ResultStates System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResultState> Gets or sets the result states. Required.
RequestXml string? Gets or sets the request xml.

^ Back to top

InvoiceData

Describes an invoice.

Properties
Property Type Description Rules
DocumentNumber string Gets or sets the document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceStatus Gets or sets the status. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceType Gets or sets the type. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Lines System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceLineData>? Gets or sets the lines.
Totals Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentTotalsData? Gets or sets the totals.
WithholdingTax System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WithholdingTaxData>? Gets or sets the withholding tax.
SelfBilling bool True if the invoice is self billing. False othewise. Required.
HashCharacters string Gets or sets the hash characters. Required.
CashVATScheme bool True if the invoice is a vat scheme. False otherwise. Required.
Paperless bool True if the invoice is paperless, false otherwise. Required.
EACCode string? Gets or sets the eac code.
SystemEntryDate System.DateTime Gets or sets the system entry date. Required.
Atcud string Gets or sets the atcud. Required.

The model includes custom properties not described here.

^ Back to top

InvoiceHeaderData

Describes an invoice header.

Properties
Property Type Description Rules
DocumentNumber string? Gets or sets the document number.
DocumentDate System.DateTime Gets or sets the document date. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceType Gets or sets the type. Required.
SelfBilling bool True if the invoice is self billing. False otherwise. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Atcud string Gets or sets the atcud. Required.

^ Back to top

InvoiceLineData

Describes an invoice line.

Properties
Property Type Description Rules
Amount decimal Gets or sets the amount. Required.
ItemNature Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineNature Gets or sets the item nature. Required.
Tax Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineTaxData? Gets or sets the tax.
OrderReferences System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentReferenceData>? Gets or sets the order references.
TaxPointDate System.DateTime Gets or sets the tax point date. Required.
Reference System.Collections.Generic.IList<string>? Gets or sets the reference.
TaxExemptionReason string? Gets or sets the tax exemption reason.

The model includes custom properties not described here.

^ Back to top

InvoiceResponse

Describes an invoice response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

InvoiceStatus

Describes an invoice status.

Properties
Property Type Description Rules
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceState Gets or sets the status. Required.
StatusDate System.DateTime Gets or sets the status date. Required.

^ Back to top

ItemData

Describes an item.

Properties
Property Type Description Rules
Name string Gets or sets the name. Required.
Description string? Gets or sets the description.
TaxCategory Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxCategory Gets or sets the tax category. Required.
TaxCategoryPercent decimal Gets or sets the tax category percent. Required.
TaxSchemeId string Gets or sets the tax scheme id. Required.
AdditionalItemProperty System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AdditionalItemData> Gets or sets the additional item property. Required.

^ Back to top

NewInvoiceStatus

Describes a new invoice status.

Properties
Property Type Description Rules
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.NewInvoiceState Gets or sets the status. Required.
StatusDate System.DateTime Gets or sets the status date. Required.

^ Back to top

OrderReferenceData

Describes an order reference.

Properties
Property Type Description Rules
OriginatingOrderNumber string Gets or sets the originating order number. Required.

^ Back to top

PartyData

Describes a party.

Properties
Property Type Description Rules
StreetName string Gets or sets the street name. Required.
CityName string Gets or sets the city name. Required.
PostalZone string Gets or sets the postal zone. Required.
Country string Gets or sets the country. Required.
RegistrationName string Gets or sets the registration name. Required.
TaxId string Gets or sets the tax id. Required.
TaxSchemeId string Gets or sets the tax scheme id. Required.

^ Back to top

PayeeFinancialAccountData

Describes a payee financial account.

Properties
Property Type Description Rules
IBAN string? Gets or sets the iban.
Name string? Gets or sets the name.
SwiftCode string? Gets or sets the swift code.

^ Back to top

PaymentData

Describes a payment.

Properties
Property Type Description Rules
DocumentNumber string Gets or sets the document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentStatus Gets or sets the status. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentDocumentType Gets or sets the type. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Lines System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentLineData> Gets or sets the lines. Required.
Totals Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentTotalsData? Gets or sets the totals.
WithholdingTax System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WithholdingTaxData>? Gets or sets the withholding tax.
SystemEntryDate System.DateTime Gets or sets the system entry date. Required.
Atcud string? Gets or sets the atcud.

^ Back to top

PaymentHeaderData

Describes a payment header.

Properties
Property Type Description Rules
DocumentNumber string Gets or sets the document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentDocumentType Gets or sets the type. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Atcud string Gets or sets the atcud. Required.

^ Back to top

PaymentLineData

Describes a payment line.

Properties
Property Type Description Rules
Amount decimal Gets or sets the amount. Required.
SettlementAmount decimal? Gets or sets the settlement amount.
ItemNature Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineNature Gets or sets the item nature. Required.
Tax Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineTaxData? Gets or sets the tax.
DocumentReferences System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentReferenceData> Gets or sets the document references. Required.
TaxExemptionReason string? Gets or sets the tax exemption reason.

^ Back to top

PaymentMandateData

Describes a payment mandate.

Properties
Property Type Description Rules
Id string? Gets or sets the id.
AccountId string? Gets or sets the account id.

^ Back to top

PaymentMeansData

Describes a payment means.

Properties
Property Type Description Rules
PaymentDueDate System.DateTime Gets or sets the payment due date. Required.
PaymentMeans Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentMeansCode Gets or sets the payment means. Required.
PaymentId string? Gets or sets the payment id.
EntityId string? Gets or sets the entity id.
PaymentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentType Gets or sets the payment type. Required.
CardAccount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.CardAccountData? Gets or sets the card account.
PayeeFinancialAccount System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PayeeFinancialAccountData>? Gets or sets the payee financial account.
PaymentMandate Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentMandateData? Gets or sets the payment mandate.

^ Back to top

PaymentResponse

Describes a payment response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

PaymentStatus

Describes a payment status.

Properties
Property Type Description Rules
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentState Gets or sets the status. Required.
StatusDate System.DateTime Gets or sets the status date. Required.

^ Back to top

QuantityData

Describes a quantity.

Properties
Property Type Description Rules
Value decimal Gets or sets the value. Required.
Unit string? Gets or sets the unit.

^ Back to top

RegisterInvoiceRequest

Describes a register invoice request.

Properties
Property Type Description Rules
Invoice Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.InvoiceData Gets or sets the invoice. Required.
TaxRegistrationNumber string Gets or sets the tax registration number. Required.
AuditFileVersion string Gets or sets the audit file version. Required.
TaxEntity string Gets or sets the tax entity. Required.
SoftwareCertificateNumber string Gets or sets the software certificate number. Required.

^ Back to top

RegisterPaymentRequest

Describes a register payment request.

Properties
Property Type Description Rules
Payment Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.PaymentData Gets or sets the payment. Required.
AuditFileVersion string Gets or sets the audit file version. Required.
TaxRegistrationNumber string Gets or sets the tax registration number. Required.
TaxEntity string Gets or sets the tax entity. Required.
SoftwareCertificateNumber string Gets or sets the software certificate number. Required.

^ Back to top

RegisterSeriesRequest

Describes a register series request.

Properties
Property Type Description Rules
Id string Gets or sets the id. Required.RegEx ([a-zA-Z0-9_.\-]+).
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesType Gets or sets the type. Required.
DocumentClass Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentClass Gets or sets the document class. Required.
DocumentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentType Gets or sets the document type. Required.
StartNumber int Gets or sets the start number. Required.> 0.
StartDate System.DateTime Gets or sets the start date. Required.
CertificationNumber string Gets or sets the certification number. Required.MinLen(4).MaxLen(4).

^ Back to top

RegisterWorkingDocumentRequest

Describes a register working document request.

Properties
Property Type Description Rules
WorkingDocument Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentData Gets or sets the working document. Required.
AuditFileVersion string Gets or sets the audit file version. Required.
TaxRegistrationNumber string Gets or sets the tax registration number. Required.
TaxEntity string Gets or sets the tax entity. Required.
SoftwareCertificateNumber string Gets or sets the software certificate number. Required.

^ Back to top

SendSaftRequestData

Describes a send saft request.

Properties
Property Type Description Rules
VatNumber string Gets or sets the vat number. Required.
Year int Gets or sets the year. Required.
Month int Gets or sets the month. Required.
InputFileName string Gets or sets the input file name. Required.
OutputFileName string? Gets or sets the output file name.
Version Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SaftVersion Gets or sets the version. Required.
Operation Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SaftOperation Gets or sets the operation. Required.
IssuerSelfBilling string? Gets or sets the issuer self billing.
UpdatedJarOutputPath string? Gets or sets the updated jar output path.

^ Back to top

SendSaftResponseData

Describes a send saft response.

Properties
Property Type Description Rules
Success bool True if the response succeeded. False otherwise. Required.
Message string? Gets or sets the message.
FileName string? Gets or sets the file name.
FileId string? Gets or sets the file id.
CreatedDate System.DateTime? Gets or sets the created date.
Errors System.Collections.Generic.IList<string>? Gets or sets the errors.
Warning string? Gets or sets the warning.
InvoicesCount int Gets or sets the invoices count. Required.
CreditsCount double Gets or sets the credits count. Required.
DebitsCount double Gets or sets the debits count. Required.
OutputFileName string Gets or sets the output file name. Required.
MultiDocFileName string Gets or sets the multi doc file name. Required.

^ Back to top

SeriesData

Describes a series.

Properties
Property Type Description Rules
Id string? Gets or sets the id.
ValidationCode string? Gets or sets the validation code.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesType Gets or sets the type. Required.
DocumentClass Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentClass Gets or sets the document class. Required.
DocumentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentType Gets or sets the document type. Required.
StartNumber int Gets or sets the start number. Required.
StartDate System.DateTime Gets or sets the start date. Required.
LastDocument int? Gets or sets the last document.
State Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesState Gets or sets the state. Required.
StateReason Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesStateReason? Gets or sets the state reason.
Justification string? Gets or sets the justification.
StateDate System.DateTime Gets or sets the state date. Required.
RegistrationDate System.DateTime Gets or sets the registration date. Required.
CertificationNumber string? Gets or sets the certification number. MinLen(4).MaxLen(4).

^ Back to top

SeriesResponse

Describes a series response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

SeriesResult

Describes a series result.

Properties
Property Type Description Rules
Series Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesData? Gets or sets the series.
ResultStates System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesResultState> Gets or sets the result states. Required.
RequestXml string? Gets or sets the request xml.

^ Back to top

SeriesResultState

Describes a series result state.

Properties
Property Type Description Rules
ReturnCode string? Gets or sets the return code.
ReturnMessage string? Gets or sets the return message.

^ Back to top

TaxSubTotalData

Describes a tax sub total.

Properties
Property Type Description Rules
TaxAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the tax amount. Required.
TaxableAmount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the taxable amount. Required.
TaxCategory Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxCategory Gets or sets the tax category. Required.
TaxCategoryPercent decimal Gets or sets the tax category percent. Required.
TaxSchemeId string Gets or sets the tax scheme id. Required.
TaxExemptionReasonCode string? Gets or sets the tax exemption reason code.
TaxExemptionReason string? Gets or sets the tax exemption reason.

^ Back to top

TaxTotalData

Describes a tax total.

Properties
Property Type Description Rules
Amount Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.AmountData Gets or sets the amount. Required.
SubTotal System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.TaxSubTotalData> Gets or sets the sub total. Required.

^ Back to top

UnregisterSeriesRequest

Describes an unregister series request.

Properties
Property Type Description Rules
Id string Gets or sets the id. Required.RegEx ([a-zA-Z0-9_.\-]+).
DocumentClass Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentClass Gets or sets the document class. Required.
DocumentType Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesDocumentType Gets or sets the document type. Required.
Reason Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SeriesStateReason Gets or sets the reason. Required.
ValidationCode string Gets or sets the validation code. Required.
NonEmissionDeclaration bool Non emission declaration number. Required.

^ Back to top

ValidateSaftRequestData

Describes a validate saft request.

Properties
Property Type Description Rules
InputFileName string Gets or sets the input file name. Required.
Version Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.SaftVersion Gets or sets the version. Required.

^ Back to top

ValidateSaftResponseData

Describes a validate saft response.

Properties
Property Type Description Rules
IsValid bool True if the response is valid, false otherwise. Required.
Warnings System.Collections.Generic.IList<string>? Gets or sets the warnings.
Errors System.Collections.Generic.IList<string>? Gets or sets the errors.

^ Back to top

WithholdingTaxData

Describes a withholding tax.

Properties
Property Type Description Rules
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WithholdingTaxType? Gets or sets the type.
Amount decimal Gets or sets the amount. Required.

^ Back to top

WorkingDocumentData

Describes a working document.

Properties
Property Type Description Rules
DocumentNumber string Gets or sets the document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentStatus Gets or sets the status. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentType Gets or sets the type. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Lines System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentLineData> Gets or sets the lines. Required.
Totals Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentTotalsData? Gets or sets the totals.
HashCharacters string Gets or sets the hash characters. Required.
EACCode string? Gets or sets the eac code.
SystemEntryDate System.DateTime Gets or sets the system entry date. Required.
Atcud string Gets or sets the atcud. Required.

^ Back to top

WorkingDocumentHeaderData

Describes a working document header.

Properties
Property Type Description Rules
DocumentNumber string Gets or sets the document number. Required.
DocumentDate System.DateTime Gets or sets the document date. Required.
Type Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentType Gets or sets the type. Required.
Customer Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentCustomerData? Gets or sets the customer.
Atcud string Gets or sets the atcud. Required.

^ Back to top

WorkingDocumentLineData

Describes a working document line.

Properties
Property Type Description Rules
Amount decimal Gets or sets the amount. Required.
ItemNature Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineNature Gets or sets the item nature. Required.
Tax Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentLineTaxData? Gets or sets the tax.
OrderReferences System.Collections.Generic.IList<Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentReferenceData>? Gets or sets the order references.
TaxPointDate System.DateTime Gets or sets the tax point date. Required.
Reference System.Collections.Generic.IList<string>? Gets or sets the reference.
TaxExemptionReason string? Gets or sets the tax exemption reason.

^ Back to top

WorkingDocumentResponse

Describes a working document response.

Properties
Property Type Description Rules
Result Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.DocumentResult Gets or sets the result. Required.
Endpoint Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.ServiceEndpoint Gets or sets the endpoint. Required.

^ Back to top

WorkingDocumentStatus

Describes a working document status.

Properties
Property Type Description Rules
Status Cegid.Lithium.TaxAuthorityPortugal.Client.Rest.Models.WorkingDocumentState Gets or sets the status. Required.
StatusDate System.DateTime Gets or sets the status date. Required.

^ Back to top

Enumerations

AdditionalItemType

Defines the type of an additional item information.

Members
Member Value Description
ExemptionReasonCode 0 The exemption reason code.
ExemptionReason 1 The exemption reason.

^ Back to top

AllowanceReasonType

Defines an allowance reason.

Members
Member Value Description
ChargeStampDuty 0 Stamp duty charge allowance reason type.
ChargeADF 1 ADF charge allowance reason type.
DiscountSimple 2 Simple Discount allowance reason type.

^ Back to top

CountryRegion

Defines the country region.

Members
Member Value Description
Continent 0 The tax refers to continental Portugal.
Azores 1 The tax refers to the Azores.
Madeira 2 The tax refers to Madeira.

^ Back to top

DeleteDocumentCriteria

Defines the criteria used for deleting invoices.

Members
Member Value Description
DiscreteList 0 The discrete list criteria.
DateInterval 1 The date interval criteria.

^ Back to top

DispatchState

Defines the state of a dispatch.

Members
Member Value Description
Normal 0 The dispatch is normal.
OnBehalfOf 1 The dispatch is on behalf of another party.
Annulled 2 The dispatch is annulled.

^ Back to top

DispatchType

Defines the type of a dispatch.

Members
Member Value Description
ShippingGuide 0 The dispatch is a shipping guide.
TransportationGuide 1 The dispatch is a transportation guide.
OwnAssetsMovementGuide 2 The dispatch is a own assets movement guide.
ConsignmentGuide 3 The dispatch is a consignment guide.
ReturnGuide 4 The dispatch is a return guide.

^ Back to top

DocumentKind

Defines the kind of a document as defined in CIUS-PT.

Members
Member Value Description
Invoice 0 The document is an invoice.
CreditNote 1 The document is a credit note.

^ Back to top

DocumentLineNature

Defines the type of an invoice line.

Members
Member Value Description
Credit 0 The amount is credit.
Debit 1 The amount is debit.

^ Back to top

DocumentLineType

Defines the type of a document line.

Members
Member Value Description
Regular 0 The line is regular.
DiscountValueOnMerchandise 1 The line is a discount value on merchandise.
Postage 2 The line is a postage cost.
OtherServices 3 The line is another service.
MonetaryAdvance 4 The line is a monetary advance.
DiscountsOnServices 5 The line is a discount on services.

^ Back to top

DocumentType

Defines the functional type of an electronic document (according to UNCL1001).

Members
Member Value Description
UNCL380 0 Invoice (UNCL1001: 380).
UNCL381 1 Credit note (UNCL1001: 381).
UNCL383 2 Debit note (UNCL1001:383).
UNCL386 3 Advancement invoice (UNCL1001:386).
UNCL389 4 Auto invoicing (UNCL1001:389).
FT 5 Document is an invoice.
FS 6 Document is an simplified invoice.
FR 7 The document is an invoice/receipt.
ND 8 The document is a debit note.
NC 9 The document is a credit note.
RP 10 The document is prize or a prize receipt.
RE 11 The document is a reversal or a reveral receipt.
CS 12 The document is a "imputação a co-seguradoras".
LD 13 The document is a "imputação a co-seguradora líder".
RA 14 The document is a "resseguro aceite".

^ Back to top

EncryptionKeyRequestState

Defines the state of an encryption key request.

Members
Member Value Description
Pending 0 The request is pending.
Completed 1 The request is completed.
Failed 2 The request has failed.

^ Back to top

EncryptionKeyRetrievalState

Defines the state of an encryption key retrieval.

Members
Member Value Description
Pending 0 The retrieval is pending.
Completed 1 The retrieval is completed.
Failed 2 The retrieval has failed.

^ Back to top

EntityType

Defines the type of an entity.

Members
Member Value Description
Customer 0 The entity is a customer.
Supplier 1 The entity is a supplier.

^ Back to top

InvoiceState

Defines the state of an invoice.

Members
Member Value Description
Normal 0 The invoice is normal.
Annulled 1 The invoice is annulled.
Billed 2 The invoice is billed.
SelfBilled 3 The invoice is self billed.

^ Back to top

InvoiceType

Defines the type of an invoice.

Members
Member Value Description
Invoice 0 The document is an invoice.
InvoiceSimplified 1 The document is a simplified invoice.
CreditNote 2 The document is a credit note.
DebitNote 3 The document is a debit note.
InvoiceReceipt 4 The document is an invoice/receipt.

^ Back to top

NewInvoiceState

Defines the state of update invoice.

Members
Member Value Description
Normal 0 The invoice is normal.
Annulled 1 The invoice is billed.
Billed 2 The invoice is self billed.

^ Back to top

PaymentDocumentType

The payment document types.

Members
Member Value Description
Receipt 0 The receipt payment document type.

^ Back to top

PaymentMeansCode

Defines a payment means.

Members
Member Value Description
CC 0 Credit card.
CD 1 Debit card.
CH 2 Bank check.
CI 3 International credit.
CO 4 Offer check/card.
CS 5 Compensation on account balances.
DE 6 Eletronic money.
LC 7 Commercial letter.
MB 8 MB payment reference.
NU 13 Cash payment.
OU 9 Other means.
PR 10 Exchange of goods.
TB 11 Bank transfer or authorized direct debit.
TR 12 Compensation extra-salary.

^ Back to top

PaymentState

Defines the state of update invoice.

Members
Member Value Description
Normal 0 The invoice is normal.
Annulled 1 The invoice is billed.

^ Back to top

PaymentType

Defines a type of payment.

Members
Member Value Description
ATM 0 The ATM payment type.
DUC 1 The DUC (Documento único de cobrança) payment type.

^ Back to top

SaftOperation

Indication of the operation to be carried out.

Members
Member Value Description
Validate 0 Validate the SAF-T file.
Send 1 Send the SAF-T file.

^ Back to top

SaftVersion

Defines a version of the SAF-T specification.

Members
Member Value Description
Version103 0 The SAF-T version 1.03_01.
Version104 1 The SAF-T version 1.04_01.

^ Back to top

SeriesDocumentClass

Defines the document class of a series.

Members
Member Value Description
SI 0 Invoices and rectification documents.
MG 1 Transport documents.
WD 2 Checking documents.
PY 3 Receipts documents.

^ Back to top

SeriesDocumentType

Defines the type of a document.

Members
Member Value Description
FT 0 The FT document type.
FS 1 The FS document type.
FR 2 The FR document type.
ND 3 The ND document type.
NC 4 The NC document type.
GR 5 The GR document type.
GT 6 The GT document type.
GA 7 The GA document type.
GC 8 The GC document type.
GD 9 The GD document type.
CM 10 The CM document type.
CC 11 The CC document type.
FC 12 The FC document type.
FO 13 The FO document type.
NE 14 The NE document type.
OU 15 The OU document type.
OR 16 The OR document type.
PF 17 The PF document type.
RP 18 The RP document type.
RE 19 The RE document type.
CS 20 The CS document type.
LD 21 The LD document type.
RA 22 The RA document type.
RC 23 The RC document type.
RG 24 The RG document type.

^ Back to top

SeriesState

Defines the state of a series.

Members
Member Value Description
Active 0 The series is active.
Unregistered 1 The series is unregistered.
Disabled 2 The series is disabled.

^ Back to top

SeriesStateReason

Defines the reason for a series being on a given state.

Members
Member Value Description
ER 0 The ER reason.

^ Back to top

SeriesType

Defines the type of a series.

Members
Member Value Description
Normal 0 The series is normal.
Training 1 The series is used for training.
Recovery 2 The series is used for recovery.

^ Back to top

ServiceEndpoint

Defines the external service endpoint.

Members
Member Value Description
Production 0 The production endpoint.
Testing 1 The testing endpoint.

^ Back to top

TaxCategory

Defines a tax category.

Members
Member Value Description
CatAA 0 Taxa reduzida.
CatS 1 Taxa normal.
CatE 2 Taxa de iva para Isentos.
CatRED 3 Taxa reduzida.
CatINT 4 Taxa intermédia.
CatNOR 5 Taxa normal.
CatISE 6 Taxa de iva para Isentos.
CatOUT 7 Outros, aplicável para os regimes especiais de IVA.
CatNA 8 No caso de não sujeição a IVA ou IS. Nos recibos emitidos sem imposto discriminado deve ser preenchido com “NA”.
CatZ 9 IVA taxa zero.
CatAE 10 IVA autoliquidado.
CatIC 11 IVA intracomunitário.
CatG 12 IVA exportações.
CatO 13 Não sujeito ou não tributado.

^ Back to top

TaxTypeCode

The tax type and code.

Members
Member Value Description
VATRED 0 Value added tax, reduced rate.
VATINT 1 Value added tax, intermediate rate.
VATNOR 2 Value added tax, regular rate.
VATEXEMPT 3 Value added tax, exempt rate.
VATOUT 4 Value added tax, other vat contexts.
ST 5 Stamp tax, not exempt.
STEXEMPT 6 Stamp tax, exempt.
NS 7 Not subject to vat or stamp tax.

^ Back to top

TaxValueType

The tax amount type.

Members
Member Value Description
Percentage 0 The tax ammount is a percentage.
Absolute 1 The tax amount is an absolute value.

^ Back to top

WithholdingTaxType

Describes the withholding tax types.

Members
Member Value Description
IRS 0 Single individual income tax.
IRC 1 Corporate income tax.
ST 2 Stamp tax.

^ Back to top

WorkingDocumentState

Defines the state of a working document.

Members
Member Value Description
Normal 0 The invoice is normal.
Annulled 1 The invoice is annulled.
Billed 2 The invoice is billed.

^ Back to top

WorkingDocumentType

The working document types.

Members
Member Value Description
TableQuery 0 The table query type.
ConsignmentCredit 1 The consigment credit type.
ConsignmentInvoice 2 The consignment invoice.
WorkSheet 3 The work sheets type.
PurchaseOrder 4 The purchase order type.
Other 5 All other types of working documents.
Budget 6 The budget type.
ProformaInvoice 7 The proforma invoice type.
PrizeOrPrizeReceipt 8 The prize or prize receipt type.
ReversalOrReversalReceipt 9 The reversal or reversal receipt type.
CoInsurersInputation 10 The inputation to co-insurers type.
LeaderCoInsurersInputation 11 The inputation to leader co-insurers type.
ReinsuranceAccepted 12 The reinsurance accepted type.

^ Back to top