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:
All Resources
This service uses the following resources:
- PaymentLineResource
- PaymentReportingLineResource
- PaymentResource
- PaymentTaxResource
- PaymentWTaxResource
All Enumerations
This service uses the following enumerations:
GET Payments
Returns the list of all the entity records available.
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
GET /accountsPayable/payments
GET Payments (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 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?page={page}&pageSize={pageSize}
GET /accountsPayable/payments?page={page}&pageSize={pageSize}
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 resord 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 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 Original Print PaymentOriginal 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}/accountsPayable/payments/{id}/printOriginal?template={template}
GET /accountsPayable/payments/{id}/printOriginal?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
Resources
PaymentLineResource
The following elements are required:
| settledAmount | (decimal) It indicates the amount (in the payment curreny) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments. |
| discount | (decimal) It indicates the discount amount (in the payment curreny) that is settled by this payment. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple payments. |
| dueDate | (DateTime) The due date of the original document to be settled. Internally determined. |
| issueDate | (DateTime) The issue date original document to be settled. Internally determined. |
| amount | (decimal) It indicates the total amount of the original document in the payment currency. Internally determined. |
| openAmount | (decimal) It indicates the current open amount of the original document in the payment currency. One original document document can be partially settled over multiple payments. Internally determined. |
| settled | (bool) Indicates that the current line is selected to include on current payment. |
| currencyKey | (string) The money unit key. Inferred from the payment currency. |
| withholdingTaxAmount | (decimal) It indicates the withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. |
| openWithholdingTaxAmount | (decimal) It indicates the open withholding tax amount (in the payment curreny) that is settled by this payment. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. Internally determined. |
| nature | (enum Nature) The original document nature (Debit or Credit). Internally determined.
See Nature. |
| financialArea | (enum FinancialArea) The payment document financial area (Accounts Receivable or Accounts Payable). Internally determined.
See FinancialArea. |
| 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. |
| 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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| settledOriginalAmount | (decimal) It indicates the amount (in the original document currency) that is settled by this payment. This amount is deducted to the original open amount. One original document document can be partially settled over multiple payments. Internally determined. |
| baseExchangeRate | (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. |
| reportingExchangeRate | (decimal) The price of the document's currency expressed in the organization reporting currency. In other words, the rate at which the document's currency can be exchanged for the organization reporting currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| originalExchangeRate | (decimal) The original price of the document's currency expressed in the payment's currency. In other words, the rate at which the document's original currency can be exchanged for the payment's currency. Internally infered. |
The following elements are optional:
| sourceDoc | (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a payment (ex: Credit or Debit Notes). Internally determined. |
| sourceDocId | (Guid) The identifier of the original document to be settled. Internally determined. |
| accountPosting | (string) The accounting posting of the original document. Internally determined. |
| 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. |
| sourceSchemaEntity | (string) The schema of the source document entity. Internally determined. |
| settlementPosting | (string) The settlement posting of the original documents. Internally determined. |
| exchangeRateDate | (DateTime) The exchange rate creation date. |
| note | (string) Reference. |
PaymentReportingLineResource
The following elements are required:
| currency | (string) Money unit. Inferred from the payment currency. |
The following elements are optional:
| sourceDoc | (string) The source document key. |
| issueDate | (DateTime) Date in which the payment reporting line was issued. |
| dueDate | (DateTime) Date in which the payment is due. In some countries it is also known as law date. |
| currencyKey | (string) Money unit key. Inferred from the payment currency. |
| amount | (decimal) The total line amount. |
| openAmount | (decimal) The remain amount to be settled. |
| settledAmount | (decimal) The line settled amount. |
| discount | (decimal) The line item discount. The default is 0. |
| withholdingTaxAmount | (decimal) The payment line withholding tax amount. |
| taxableAmount | (decimal) The document line taxable amount. |
| percentage | (decimal) Rate. |
| taxAmount | (decimal) The document line tax amount. |
| taxTypeCode | (string) The document line tax type code. |
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 | (decimal) Total discount over goods and services. Internally calculated. |
| grossValue | (decimal) Total value of goods and services before taxes or discounts. Internally calculated. |
| payableAmount | (decimal) The payable amount. Total value of goods and services including taxes and discounts. Internally calculated. |
| wTaxTotal | (decimal) Total withholding tax value of goods and services. Internally calculated. |
| taxTotal | (decimal) Total tax value of goods and services. Internally calculated. |
| taxExclusiveAmount | (decimal) The payment total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated. |
| 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. |
PaymentTaxResource
The following elements are required:
| taxableAmount | (decimal) The payment withholding tax taxable amount. Internally determined. |
| taxAmount | (decimal) The payment line tax amount. Internally determined. |
| sourceDoc | (string) The source document key. |
| percentage | (decimal) The percentage for the payment tax. |
| openTaxAmount | (decimal) The open tax amount for the payment tax. |
| sourceDocId | (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined. |
| openTaxableAmount | (decimal) The open taxable amount for the payment tax. |
| sourceSchemaEntityId | (Guid) Schema entity from originating document. |
| taxSummary | (string) The tax summary for the payment tax. |
| taxTypeCode | (string) Payment tax type code. Internally determined. |
| currency | (string) Money unit. Inferred from the payment currency. Internally determined. |
| exchangeRate | (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency. |
The following elements are optional:
| isExempt | (bool) Indicates whether the payment line tax schema is exempt. Internally determined. |
| taxPosting | (string) The tax posting for the payment tax. |
| exemptionReasonCode | (string) Indicates whether the payment tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined. |
| exchangeRateDate | (DateTime) The exchange rate creation date. |
PaymentWTaxResource
The following elements are required:
| taxableAmount | (decimal) The payment withholding tax taxable amount. Internally determined. |
| withholdingTaxAmount | (decimal) The payment total amount for a withhold tax. Internally calculated. |
| ignore | (bool) Indicates whether the payment line tax schema is ignored. Internally determined. |
| sourceDoc | (string) The source document key. |
| percentage | (decimal) The payment withholding tax code rate percentage. Internally determined. |
| openWithholdingTaxAmount | (decimal) The payment line open withholding tax amount. |
| sourceDocId | (Guid) The source document id, when the payment was transformed. The source document is usually the invoice. Internally determined. |
| openTaxableAmount | (decimal) The open taxable amount for the payment tax. |
| wTaxSummary | (string) The withholding tax summary for the payment withholding tax. |
| withholdingTaxCode | (string) The payment withholding tax code. Internally determined. |
| beneficiaryParty | (string) The beneficiary party for the payment withholding tax. |
| sourceSchemaEntity | (string) Schema entity from originating document. |
| currency | (string) Money unit. Inferred from the payment currency. |
| exchangeRate | (decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency. |
The following elements are optional:
| withholdingPosting | (string) The payment line withholding tax amount. |
| wTaxPosting | (string) The withholding tax posting for the payment withholding tax. |
| exchangeRateDate | (DateTime) The exchange rate creation date. |