Accounts Payable | Payment
Service to manage entities of type 'Payment'.
Overview
| URL | api/{tenantKey}/{orgKey}/accountsPayable/payments |
| Methods Supported | GET |
All Operations
This service includes the following operations:
-
GET:
- GET Payments (odata)
- GET Payment by identifier
- GET Payment by key
- GET Print Payment by identifier
- GET Print Payment by identifier (asynchronously)
- GET Print Payment by key
- GET Print Payment by key (asynchronously)
- GET Original Print Payment by identifier
- GET Original Print Payment by identifier (asynchronously)
- GET Original Print Payment by key
- GET Original Print Payment by key (asynchronously)
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Payments (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 PaymentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/odata
GET /accountsPayable/payments/odata
GET Payment 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 PaymentResource. |
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}/accountsPayable/payments/{id}
GET /accountsPayable/payments/{id}
GET Payment by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key. |
Response:
| When successful, the response body contains the entity record. See PaymentResource. |
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}/accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}
GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}
GET Print Payment 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 record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{id}/print?template={template}
GET /accountsPayable/payments/{id}/print?template={template}
GET Print Payment by identifier (asynchronously)
Prints the specified entity record asynchronously.
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 Location header contains an URL to download the printed file. |
Response status codes:
| 202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{id}/printAsync?template={template}
GET /accountsPayable/payments/{id}/printAsync?template={template}
GET Print Payment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural 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}/accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/print
GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/print
GET Print Payment by key (asynchronously)
Prints the specified entity record asynchronously.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural 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 Location header contains an URL to download the printed file. |
Response status codes:
| 202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printAsync
GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printAsync
GET Original Print Payment 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 record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{id}/printOriginal?template={template}
GET /accountsPayable/payments/{id}/printOriginal?template={template}
GET Original Print Payment by identifier (asynchronously)
Prints the specified entity record asynchronously.
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 Location header contains an URL to download the printed file. |
Response status codes:
| 202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{id}/printOriginalAsync?template={template}
GET /accountsPayable/payments/{id}/printOriginalAsync?template={template}
GET Original Print Payment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural 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}/accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal
GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal
GET Original Print Payment by key (asynchronously)
Prints the specified entity record asynchronously.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural 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 Location header contains an URL to download the printed file. |
Response status codes:
| 202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginalAsync
GET /accountsPayable/payments/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginalAsync
Resources
PaymentResource
The following elements are required:
| documentType | (string) Defines the payment's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default payment type is defined in the financial setup configuration setting.
(fk) Allowed value: the natural key of a record of type PaymentType. These records are accessibly through the PaymentTypes service. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the payment type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service. |
| seriesNumber | (int) Sequential number internally determined that uniquely identifies the document within the payment type and serie. Part of the document natural key. |
| accountingParty | (string) The supplier designated in the payment as the party to whom the payment should be sent. It may or may not be the party to whom the goods or services are delivered. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| company | (string) The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) The date when the document is created. |
| currency | (string) Money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| exchangeRate | (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| isPaymentMethodCheck | (bool) Determines if the used payment method is of type check. Applicable only when the payment is cash payment and the payment method is of type check. Internally determined. |
| allowanceChargeAmount | (MoneyResource) Total discount over goods and services. Internally calculated.
See MoneyResource . |
| grossValue | (MoneyResource) Total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource . |
| payableAmount | (MoneyResource) The payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource . |
| wTaxTotal | (MoneyResource) Total withholding tax value of goods and services. Internally calculated.
See MoneyResource . |
| taxTotal | (MoneyResource) Total tax value of goods and services. Internally calculated.
See MoneyResource . |
| taxExclusiveAmount | (MoneyResource) The payment total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource . |
| isLocked | (bool) Is Locked. |
The following elements are optional:
| documentLines | (List of PaymentLineResource) The payment lines.
See PaymentLineResource. |
| documentTaxes | (List of PaymentTaxResource) The payment taxes.
See PaymentTaxResource. |
| documentWTaxes | (List of PaymentWTaxResource) The payment withholding taxes.
See PaymentWTaxResource. |
| reportingLines | (List of PaymentReportingLineResource) The reporting lines.
See PaymentReportingLineResource. |
| remarks | (string) The payment remarks. |
| note | (string) The document note. |
| partyAddress | (string) The supplier address. |
| isPrinted | (bool) Indicates if the payment has been printed. Internally determined. |
| noteToRecipient | (string) Note to the payment recipient. |
| accountingSchemaLegalStamp | (string) The accounting schema legal stamp. |
| paymentMethodStamp | (string) Sentence to be printed on the Payment, regarding the Payment Means. |
| financialAccount | (string) A financial account that represents either a cash drawer or a bank account and must be used to define where to debit the value. A bank account is an account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
| cashFlowItem | (string) Incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows.
(fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service. |
| exchangeRateDate | (DateTime) The exchange rate creation date. |
| check | (string) The check used for this payment. Applicable only when the payment is cash payment and the payment method is of type check.
(fk) Allowed value: the natural key of a record of type Check. |
| checkNumber | (int) The number of the check used for this payment. Applicable only when the payment is cash payment and the payment method is of type check. |
| outgoingCheckLot | (string) The outgoint lot of the check used for this payment document. Applicable only when the payment is cash payment and the payment method is of type check.
(fk) Allowed value: the natural key of a record of type OutgoingCheckLot. |
| paymentMethod | (string) Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service. |
| accountingSchema | (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| partyAccountingSchema | (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| notification | (string) The payment notification configuration. Inferred from the payment type.
(fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service. |
| emailTo | (string) The email(s) to send payment notification. Inferred from the notification. |
| lockReason | (string) Lock Reason.
(fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service. |
| printedReportName | (string) Printed Report Name. |
| isReprinted | (bool) Is Reprinted. |
| isSigned | (bool) Is Signed. |