Financials | Payment Term

A Payment Term represents the conditions surrounding the payment part of sale, typically specified by the seller to the buyer.

Overview

api/{tenantKey}/{orgKey}/financialCore/paymentTerms

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE PaymentTerm by identifier
- DELETE PaymentTerm by key

All Resources

This service uses the following resources:

ApiPaymentTermResource
PaymentTermResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET PaymentTerms

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTerms

GET /financialCore/paymentTerms

GET PaymentTerms (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 PaymentTermResource.

Response status codes:

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

Resource URL:

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

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

GET PaymentTerm 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 PaymentTermResource.

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

GET /financialCore/paymentTerms/{id}

GET PaymentTerm by key

Returns the entity record that matches the specified key.

The following elements are required:

paymentTermKey

(string) The payment term's key.

Response:

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

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/paymentTerms/{paymentTermKey}

GET /financialCore/paymentTerms/{paymentTermKey}

GET Print PaymentTerm 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/paymentTerms/{id}/print?template={template}

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

GET Print PaymentTerm by key

Prints the specified entity record.

The following elements are required:

paymentTermKey

(string) The payment term'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/paymentTerms/{paymentTermKey}/print

GET /financialCore/paymentTerms/{paymentTermKey}/print

GET Original Print PaymentTermOriginal 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/paymentTerms/{id}/printOriginal?template={template}

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

GET Original Print PaymentTerm by key

Prints the specified entity record.

The following elements are required:

paymentTermKey

(string) The payment term'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/paymentTerms/{paymentTermKey}/printOriginal

GET /financialCore/paymentTerms/{paymentTermKey}/printOriginal

POST Operations

POST PaymentTerms

Creates a new entity record.

The following elements are required:

paymentTermResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTerms

POST /financialCore/paymentTerms

POST Calculate Due Date

This operation calculates the Due Date for a given PaymentTerm and Document Date.

The following elements are required:

paymentTermKey	(string) The Payment Term Key.
documentDate	(DateTime?) The doucument Date.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains an item of type 'date'.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTerms/calculateDueDate/{paymentTermKey}

POST /financialCore/paymentTerms/calculateDueDate/{paymentTermKey}

POST Calculate Due Date By Payment Term Id

This operation calculates the Due Date for a given PaymentTerm and Document Date.

The following elements are required:

paymentTermId	(Guid) The Payment Term Id.
documentDate	(DateTime?) The doucument Date.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains an item of type 'date'.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/paymentTerms/calculateDueDateByPaymentTermId/{paymentTermId}

POST /financialCore/paymentTerms/calculateDueDateByPaymentTermId/{paymentTermId}

PUT Operations

PUT Set DaysFromReferenceDate PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/daysFromReferenceDate

PUT /financialCore/paymentTerms/{paymentTermKey}/daysFromReferenceDate

PUT Set Description PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/description

PUT /financialCore/paymentTerms/{paymentTermKey}/description

PUT Set IsActive PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/isActive

PUT /financialCore/paymentTerms/{paymentTermKey}/isActive

PUT Set PaymentTermKey PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/paymentTermKey

PUT /financialCore/paymentTerms/{paymentTermKey}/paymentTermKey

PUT Set UseInAccountsPayable PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/useInAccountsPayable

PUT /financialCore/paymentTerms/{paymentTermKey}/useInAccountsPayable

PUT Set UseInAccountsReceivable PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's 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/paymentTerms/{paymentTermKey}/useInAccountsReceivable

PUT /financialCore/paymentTerms/{paymentTermKey}/useInAccountsReceivable

PUT Set ValidFrom PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's key.
value	(DateTime) 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/paymentTerms/{paymentTermKey}/validFrom

PUT /financialCore/paymentTerms/{paymentTermKey}/validFrom

PUT Set ValidTo PaymentTerm

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

The following elements are required:

paymentTermKey	(string) The payment term's key.
value	(DateTime) 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/paymentTerms/{paymentTermKey}/validTo

PUT /financialCore/paymentTerms/{paymentTermKey}/validTo

PUT Set Custom Attribute PaymentTerm

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

paymentTermKey	(string) The payment term's key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/paymentTerms/{paymentTermKey}/{customAttributeName}

PUT /financialCore/paymentTerms/{paymentTermKey}/{customAttributeName}

DELETE Operations

DELETE PaymentTerm 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/paymentTerms/{id}

DELETE /financialCore/paymentTerms/{id}

DELETE PaymentTerm by key

Deletes the entity record that matches the specified key.

The following elements are required:

paymentTermKey

(string) The payment term'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/paymentTerms/{paymentTermKey}

DELETE /financialCore/paymentTerms/{paymentTermKey}

Resources

ApiPaymentTermResource

The following elements are required:

paymentTermKey	(string) The payment term's key.
description	(string) The payment term's description.
useInAccountsReceivable	(bool) Indicates whether this payment term can be used in accounts receivable or not.
useInAccountsPayable	(bool) Indicates whether this payment term can be used in accounts payable or not.

The following elements are optional:

validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
daysFromReferenceDate	(int) Number of days that determine the term for this payment.

PaymentTermResource

The following elements are required:

paymentTermKey	(string) The payment term's key.
description	(string) The payment term's description.
useInAccountsReceivable	(bool) Indicates whether this payment term can be used in accounts receivable or not.
useInAccountsPayable	(bool) Indicates whether this payment term can be used in accounts payable or not.

The following elements are optional:

validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
daysFromReferenceDate	(int) Number of days that determine the term for this payment.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.