Financials | Payment Term
Service to manage entities of type 'PaymentTerm'.
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/paymentTerms |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET PaymentTerms (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 PaymentTermResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
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:
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:
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. |
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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. |