Taxes | Taxes Setup CV

Service to manage entities of type 'TaxesSetupCV'.

Overview

api/{tenantKey}/{orgKey}/taxesCore/taxesSetupCVs

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

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxesSetupCVs
PUT:
DELETE:
- DELETE TaxesSetupCV by identifier
- DELETE TaxesSetupCV by key

All Resources

This service uses the following resources:

ApiTaxesSetupCVResource
MoneyResource
TaxesSetupCVResource

GET Operations

GET TaxesSetupsCV (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See TaxesSetupCVResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetupCVs/odata

GET /taxesCore/taxesSetupCVs/odata

GET TaxesSetupCV 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 TaxesSetupCVResource.

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/taxesSetupCVs/{id}

GET /taxesCore/taxesSetupCVs/{id}

GET TaxesSetupCV by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

Response:

When successful, the response body contains the entity record. See TaxesSetupCVResource.

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/taxesSetupCVs/{company}

GET /taxesCore/taxesSetupCVs/{company}

POST Operations

POST TaxesSetupCVs

Creates a new entity record.

The following elements are required:

taxesSetupCVResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetupCVs

POST /taxesCore/taxesSetupCVs

PUT Operations

PUT Set CertificateFileName TaxesSetupCV

Updates the value of attribute 'CertificateFileName' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/certificateFileName

PUT /taxesCore/taxesSetupCVs/{company}/certificateFileName

PUT Set CertificatePassword TaxesSetupCV

Updates the value of attribute 'CertificatePassword' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/certificatePassword

PUT /taxesCore/taxesSetupCVs/{company}/certificatePassword

PUT Set Company TaxesSetupCV

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/company

PUT /taxesCore/taxesSetupCVs/{company}/company

PUT Set Currency TaxesSetupCV

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/currency

PUT /taxesCore/taxesSetupCVs/{company}/currency

PUT Set CustomIssueReasonDescription TaxesSetupCV

Updates the value of attribute 'CustomIssueReasonDescription' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/customIssueReasonDescription

PUT /taxesCore/taxesSetupCVs/{company}/customIssueReasonDescription

PUT Set DefaultCancellationIssueReason TaxesSetupCV

Updates the value of attribute 'DefaultCancellationIssueReason' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/defaultCancellationIssueReason

PUT /taxesCore/taxesSetupCVs/{company}/defaultCancellationIssueReason

PUT Set DefaultContingencyReasonDescription TaxesSetupCV

Updates the value of attribute 'DefaultContingencyReasonDescription' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/defaultContingencyReasonDescription

PUT /taxesCore/taxesSetupCVs/{company}/defaultContingencyReasonDescription

PUT Set DefaultContingencyReasonType TaxesSetupCV

Updates the value of attribute 'DefaultContingencyReasonType' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/defaultContingencyReasonType

PUT /taxesCore/taxesSetupCVs/{company}/defaultContingencyReasonType

PUT Set EconomicActivityClassification TaxesSetupCV

Updates the value of attribute 'EconomicActivityClassification' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/economicActivityClassification

PUT /taxesCore/taxesSetupCVs/{company}/economicActivityClassification

PUT Set FiscalTimeZone TaxesSetupCV

Updates the value of attribute 'FiscalTimeZone' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/fiscalTimeZone

PUT /taxesCore/taxesSetupCVs/{company}/fiscalTimeZone

PUT Set InvoiceLimitAmount TaxesSetupCV

Updates the value of attribute 'InvoiceLimitAmount' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(decimal) 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/taxesSetupCVs/{company}/invoiceLimitAmount

PUT /taxesCore/taxesSetupCVs/{company}/invoiceLimitAmount

PUT Set IsActive TaxesSetupCV

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

company	(string) Company.
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/taxesSetupCVs/{company}/isActive

PUT /taxesCore/taxesSetupCVs/{company}/isActive

PUT Set IsCustomIssueReasonAllowed TaxesSetupCV

Updates the value of attribute 'IsCustomIssueReasonAllowed' in the specified entity record.

The following elements are required:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetupCVs/{company}/isCustomIssueReasonAllowed

PUT /taxesCore/taxesSetupCVs/{company}/isCustomIssueReasonAllowed

PUT Set UseTestModeCommunication TaxesSetupCV

Updates the value of attribute 'UseTestModeCommunication' in the specified entity record.

The following elements are required:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetupCVs/{company}/useTestModeCommunication

PUT /taxesCore/taxesSetupCVs/{company}/useTestModeCommunication

DELETE Operations

DELETE TaxesSetupCV 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/taxesSetupCVs/{id}

DELETE /taxesCore/taxesSetupCVs/{id}

DELETE TaxesSetupCV by key

Deletes the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

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/taxesSetupCVs/{company}

DELETE /taxesCore/taxesSetupCVs/{company}

Resources

ApiTaxesSetupCVResource

The following elements are required:

company	(string) Company.
invoiceLimitAmount	(MoneyResource) Sales Slip Limit Amount. See MoneyResource .
currency	(string) Currency.
useTestModeCommunication	(bool) Use Test Mode Communication.
defaultCancellationIssueReason	(string) Default Tax Cancellation Issue.
defaultContingencyReasonType	(string) Default Contingency Reason Type.

The following elements are optional:

fiscalTimeZone	(string) Fiscal Time Zone.
economicActivityClassification	(string) Economic Activity Classification.
certificateFileName	(string) Certificate File Name.
certificatePassword	(string) The password of the certificate that allows the user to communicate with the financial authority.
customIssueReasonDescription	(string) Cancellation Issue Description.
isCustomIssueReasonAllowed	(bool) Is Custom Issue Reason Allowed.
defaultContingencyReasonDescription	(string) Default Contingency Reason Desc.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

TaxesSetupCVResource

The following elements are required:

company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
invoiceLimitAmount	(MoneyResource) Sales Slip Limit Amount. See MoneyResource .
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
useTestModeCommunication	(bool) Use Test Mode Communication.
defaultCancellationIssueReason	(string) Default Tax Cancellation Issue. (fk) Allowed value: the natural key of a record of type FiscalIssueReason. These records are accessibly through the FiscalIssueReasons service.
defaultContingencyReasonType	(string) Default Contingency Reason Type. (fk) Allowed value: the natural key of a record of type ReasonTypeCV. These records are accessibly through the ReasonTypeCVs service.

The following elements are optional:

fiscalTimeZone	(string) Fiscal Time Zone. (fk) Allowed value: the natural key of a record of type FiscalTimeZone. These records are accessibly through the FiscalTimeZones service.
economicActivityClassification	(string) Economic Activity Classification. (fk) Allowed value: the natural key of a record of type EconomicActivityClassification. These records are accessibly through the EconomicActivityClassifications service.
electronicConfigurationDate	(DateTimeOffset) Electronic Configuration Date.
certificateFileName	(string) Certificate File Name.
certificateDate	(DateTimeOffset) Certificate Date.
certificatePassword	(string) The password of the certificate that allows the user to communicate with the financial authority.
customIssueReasonDescription	(string) Cancellation Issue Description.
isCustomIssueReasonAllowed	(bool) Is Custom Issue Reason Allowed.
defaultContingencyReasonDescription	(string) Default Contingency Reason Desc.