Financials | Payment Type

Service to manage entities of type 'PaymentType'.

Overview

api/{tenantKey}/{orgKey}/financialCore/paymentTypes

URL	api/{tenantKey}/{orgKey}/financialCore/paymentTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST PaymentTypes
- POST Payment Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiPaymentTypeDocumentTypeSeriesResource
ApiPaymentTypeResource
PaymentTypeResource
PaymentTypeSerieResource

All Enumerations

This service uses the following enumerations:

AccountingSchema

GET Operations

GET PaymentTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes

GET /financialCore/paymentTypes

GET PaymentTypes (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 PaymentTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes?page={page}&pageSize={pageSize}

GET /financialCore/paymentTypes?page={page}&pageSize={pageSize}

GET PaymentType 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 PaymentTypeResource.

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

GET /financialCore/paymentTypes/{id}

GET PaymentType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The payment type's key.

Response:

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

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}/financialCore/paymentTypes/{companyKey}/{typeKey}

GET /financialCore/paymentTypes/{companyKey}/{typeKey}

GET Print PaymentType 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}/financialCore/paymentTypes/{id}/print?template={template}

GET /financialCore/paymentTypes/{id}/print?template={template}

GET Print PaymentType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The payment type's 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}/financialCore/paymentTypes/{companyKey}/{typeKey}/print

GET /financialCore/paymentTypes/{companyKey}/{typeKey}/print

GET Original Print PaymentTypeOriginal 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}/financialCore/paymentTypes/{id}/printOriginal?template={template}

GET /financialCore/paymentTypes/{id}/printOriginal?template={template}

GET Original Print PaymentType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The payment type's 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}/financialCore/paymentTypes/{companyKey}/{typeKey}/printOriginal

GET /financialCore/paymentTypes/{companyKey}/{typeKey}/printOriginal

POST Operations

POST PaymentTypes

Creates a new entity record.

The following elements are required:

paymentTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes

POST /financialCore/paymentTypes

POST Payment Type

Inserts a new 'Payment Type Serie' in the 'Payment Type'.

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(ApiPaymentTypeDocumentTypeSeriesResource) The ApiPaymentTypeDocumentTypeSeriesResource instance. See ApiPaymentTypeDocumentTypeSeriesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries

PUT Operations

PUT Set AccountingSchema PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

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}/financialCore/paymentTypes/{companyKey}/{typeKey}/accountingSchema

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/accountingSchema

PUT Set Company PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/company

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/company

PUT Set ContactType PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/contactType

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/contactType

PUT Set DefaultCashFlowItem PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/defaultCashFlowItem

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/defaultCashFlowItem

PUT Set DefaultFinancialAccount PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/defaultFinancialAccount

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/defaultFinancialAccount

PUT Set Description PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/description

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/description

PUT Set IsActive PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/isActive

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/isActive

PUT Set IsDefault PaymentTypeSerie

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

The following elements are required:

typeKey	(string) The payment type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT Set Notification PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/notification

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/notification

PUT Set NumberOfCopies PaymentTypeSerie

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

The following elements are required:

typeKey	(string) The payment type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT Set TypeKey PaymentType

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

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTypes/{companyKey}/{typeKey}/typeKey

PUT /financialCore/paymentTypes/{companyKey}/{typeKey}/typeKey

DELETE Operations

DELETE Payment Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The payment type's key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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}/financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /financialCore/paymentTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE PaymentType 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}/financialCore/paymentTypes/{id}

DELETE /financialCore/paymentTypes/{id}

DELETE PaymentType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The payment type's 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}/financialCore/paymentTypes/{companyKey}/{typeKey}

DELETE /financialCore/paymentTypes/{companyKey}/{typeKey}

Resources

ApiPaymentTypeDocumentTypeSeriesResource

The following elements are required:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The serie for the payment type serie.

ApiPaymentTypeResource

The following elements are required:

company	(string) The company key to which the requested Payment Type is associated to.
typeKey	(string) The payment type's key.
accountingSchema	(enum AccountingSchema) The associated account schema. See AccountingSchema.

The following elements are optional:

description	(string) The payment type's description.
documentTypeSeries	(List of ApiPaymentTypeDocumentTypeSeriesResource) The document type's series. See ApiPaymentTypeDocumentTypeSeriesResource.
defaultFinancialAccount	(string) The financial account used by default.
defaultCashFlowItem	(string) The cash flow item used by default.
contactType	(string) The associated contact type.
notification	(string) The associated notification.

PaymentTypeResource

The following elements are required:

company	(string) The company key to which the requested Payment Type is associated to. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
typeKey	(string) The payment type's key.
accountingSchema	(enum AccountingSchema) The associated account schema. See AccountingSchema.

The following elements are optional:

description	(string) The payment type's description.
documentTypeSeries	(List of PaymentTypeSerieResource) The document type's series. See PaymentTypeSerieResource.
defaultFinancialAccount	(string) The financial account used by default. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
defaultCashFlowItem	(string) The cash flow item used by default. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
contactType	(string) The associated contact type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The associated notification. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.

PaymentTypeSerieResource

The following elements are required:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The serie for the payment type serie.

The following elements are optional:

currentNumber	(int) The current serie numerator, indicating the last number to be used.
currentDate	(DateTime) The date for the payment type serie.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash