Taxes | Payment Method Fiscal Class

Service to manage entities of type 'PaymentMethodFiscalClassification'.

Overview

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications

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

All Operations

This service includes the following operations:

GET:
POST:
- POST PaymentMethodFiscalClassifications
PUT:
DELETE:
- DELETE PaymentMethodFiscalClassification by identifier
- DELETE PaymentMethodFiscalClassification by key

All Resources

This service uses the following resources:

ApiPaymentMethodFiscalClassificationResource
PaymentMethodFiscalClassificationResource

GET Operations

GET PaymentMethodFiscalClassifications

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications

GET /taxesCore/paymentMethodFiscalClassifications

GET PaymentMethodFiscalClassifications (paged)

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

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications?page={page}&pageSize={pageSize}

GET /taxesCore/paymentMethodFiscalClassifications?page={page}&pageSize={pageSize}

GET PaymentMethodFiscalClassification 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 PaymentMethodFiscalClassificationResource.

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

GET /taxesCore/paymentMethodFiscalClassifications/{id}

GET PaymentMethodFiscalClassification by key

Returns the entity record that matches the specified key.

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

Response:

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

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/paymentMethodFiscalClassifications/{fiscalClassificationKey}

GET /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}

GET Print PaymentMethodFiscalClassification by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{id}/print?template={template}

GET /taxesCore/paymentMethodFiscalClassifications/{id}/print?template={template}

GET Print PaymentMethodFiscalClassification by key

Prints the specified entity record.

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/print

GET /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/print

GET Original Print PaymentMethodFiscalClassificationOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{id}/printOriginal?template={template}

GET /taxesCore/paymentMethodFiscalClassifications/{id}/printOriginal?template={template}

GET Original Print PaymentMethodFiscalClassification by key

Prints the specified entity record.

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/printOriginal

GET /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/printOriginal

POST Operations

POST PaymentMethodFiscalClassifications

Creates a new entity record.

The following elements are required:

paymentMethodFiscalClassificationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications

POST /taxesCore/paymentMethodFiscalClassifications

PUT Operations

PUT Set Description PaymentMethodFiscalClassification

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

The following elements are required:

fiscalClassificationKey	(string) The payment's method fiscal classification key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/description

PUT /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/description

PUT Set FiscalClassificationKey PaymentMethodFiscalClassification

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

The following elements are required:

fiscalClassificationKey	(string) The payment's method fiscal classification key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/fiscalClassificationKey

PUT /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/fiscalClassificationKey

PUT Set IsActive PaymentMethodFiscalClassification

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

The following elements are required:

fiscalClassificationKey	(string) The payment's method fiscal classification key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/isActive

PUT /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}/isActive

DELETE Operations

DELETE PaymentMethodFiscalClassification 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/paymentMethodFiscalClassifications/{id}

DELETE /taxesCore/paymentMethodFiscalClassifications/{id}

DELETE PaymentMethodFiscalClassification by key

Deletes the entity record that matches the specified key.

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

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/paymentMethodFiscalClassifications/{fiscalClassificationKey}

DELETE /taxesCore/paymentMethodFiscalClassifications/{fiscalClassificationKey}

Resources

ApiPaymentMethodFiscalClassificationResource

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

The following elements are optional:

description

(string) The payment's method fiscal classification description.

PaymentMethodFiscalClassificationResource

The following elements are required:

fiscalClassificationKey

(string) The payment's method fiscal classification key.

The following elements are optional:

description

(string) The payment's method fiscal classification description.