Accounts Receivable | Create Receipt
Service to allow picking of open items to process for receipt purpose. The monetary values must be specified using the party default currency.
Overview
| URL | api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Create Receipt
Returns the list of entity records that can be processed by the 'Receipts' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| company | (string) The company code is the central organizational unit within the system. |
| documentType | (string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. The default receipt type is defined in the sales setup configuration setting. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) Posting Date. |
| financialAccount | (string) Financial Account. |
| cashFlowItem | (string) Cash Flow Item. |
| party | (string) The customer designated in the account posting as the party to whom should be sent the receipt. It may or may not be the party to whom the goods or services were delivered. |
| 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 customer 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 base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| paymentMethod | (string) Payment Method. |
| isCheckPaymentMethod | (bool) Is Check Payment Method. |
The following elements are optional:
| note | (string) Reference This is a query string parameter. |
| checkNumber | (string) Check Number This is a query string parameter. |
| checkDate | (DateTime?) Check Date This is a query string parameter. |
| checkBank | (string) Check Bank This is a query string parameter. |
| checkBranch | (string) Check Branch This is a query string parameter. |
| checkAccount | (string) Check Account This is a query string parameter. |
| dueDateFromFilter | (DateTime?) The accounting posting starting due date. Ignored if not set, is used to filter the due date. Only account postings with due date greater than or equal to this value will be displayed. This is a query string parameter. |
| dueDateUntilFilter | (DateTime?) The accounting posting end due date. Ignored if not set, is used to filter the due date. Only account postings with due date less than or equal to this value will be displayed. This is a query string parameter. |
| paymentMethodFilter | (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 customer party. This is a query string parameter. |
| sourceDocFilter | (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined. This is a query string parameter. |
| total | (decimal?) Document total. Internally calculated. This is a query string parameter. |
| serie | (string) Serie This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See OpenAccountPostingLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/{pageIndex}/{pageSize}?note={note}&checkNumber={checkNumber}&checkDate={checkDate}&checkBank={checkBank}&checkBranch={checkBranch}&checkAccount={checkAccount}&dueDateFromFilter={dueDateFromFilter}&dueDateUntilFilter={dueDateUntilFilter}&paymentMethodFilter={paymentMethodFilter}&sourceDocFilter={sourceDocFilter}&total={total}&serie={serie}
GET /accountsReceivable/processOpenItems/{pageIndex}/{pageSize}?note={note}&checkNumber={checkNumber}&checkDate={checkDate}&checkBank={checkBank}&checkBranch={checkBranch}&checkAccount={checkAccount}&dueDateFromFilter={dueDateFromFilter}&dueDateUntilFilter={dueDateUntilFilter}&paymentMethodFilter={paymentMethodFilter}&sourceDocFilter={sourceDocFilter}&total={total}&serie={serie}
POST Generate Receipt
Operation that creates a new receipt using the specifed information while processing the specified entity records.
The following elements are required:
| apiOpenAccountPosting | (ApiOpenAccountPosting) ApiOpenAccountPosting. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/generateReceipt
POST /accountsReceivable/processOpenItems/generateReceipt
POST Create Receipt
Instructs the 'Receipts' service to process the specified entity records.
The following elements are required:
| list | (OpenAccountPostingLine) List of the entity records that should be processed. See OpenAccountPostingLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/{companyKey}
POST /accountsReceivable/processOpenItems/{companyKey}
Resources
ApiOpenAccountPosting
The following elements are required:
| company | (string) Company. |
| documentType | (string) Receipt Type. |
| documentDate | (DateTime) Document Date. |
| postingDate | (DateTime) Posting Date. |
| financialAccount | (string) Financial Account. |
| cashFlowItem | (string) Cash Flow Item. |
| party | (string) Party. |
| currency | (string) Currency. |
| 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. |
| paymentMethod | (string) Payment Method. |
The following elements are optional:
| note | (string) Reference. |
| checkNumber | (string) Check Number. |
| checkDate | (DateTime) Check Date. |
| checkBank | (string) Check Bank. |
| checkBranch | (string) Check Branch. |
| checkAccount | (string) Check Account. |
| serie | (string) Serie. |
OpenAccountPosting
The following elements are required:
| selectedCount | (int) Number of lines selected. Internally calculated. |
| company | (string) The company code is the central organizational unit within the system. |
| documentType | (string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. The default receipt type is defined in the sales setup configuration setting. |
| documentDate | (DateTime) The date when the document is issued. |
| postingDate | (DateTime) Posting Date. |
| financialAccount | (string) Financial Account. |
| cashFlowItem | (string) Cash Flow Item. |
| party | (string) The customer designated in the account posting as the party to whom should be sent the receipt. It may or may not be the party to whom the goods or services were delivered. |
| 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 customer 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 base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| paymentMethod | (string) Payment Method. |
| isCheckPaymentMethod | (bool) Is Check Payment Method. |
The following elements are optional:
| note | (string) Reference. |
| checkNumber | (string) Check Number. |
| checkDate | (DateTime) Check Date. |
| checkBank | (string) Check Bank. |
| checkBranch | (string) Check Branch. |
| checkAccount | (string) Check Account. |
| dueDateFromFilter | (DateTime) The accounting posting starting due date. Ignored if not set, is used to filter the due date. Only account postings with due date greater than or equal to this value will be displayed. |
| dueDateUntilFilter | (DateTime) The accounting posting end due date. Ignored if not set, is used to filter the due date. Only account postings with due date less than or equal to this value will be displayed. |
| paymentMethodFilter | (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 customer party. |
| sourceDocFilter | (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined. |
| total | (decimal) Document total. Internally calculated. |
| serie | (string) Serie. |
OpenAccountPostingLine
The following elements are required:
| selected | (bool) Indicates if the line has been selected to be included on the receipt. |
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 receitp (ex: Credit or Debit Notes). Internally determined. |
| dueDate | (DateTime) The due date of the original document to be settled. Internally determined. |
| sourceDocPaymentMethod | (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 customer party. |
| amount | (decimal) It indicates the total amount of the original document in the receipt currency. Internally determined. |
| open | (decimal) It indicates the current open amount of the original document in the receipt currency. One original document document can be partially settled over multiple receipts. Internally determined. |
| settled | (decimal) It indicates the amount (in the receipt curreny) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts. |
| discount | (decimal) It indicates the discount amount (in the receipt curreny) that is settled by this receipt. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple receipts. |
| withholded | (decimal) It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. 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. |
| accountPostingId | (Guid) The unique identifier of then account posting for the line. Internally determined. |
| sourceDocExchangeRate | (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. |
| natureId | (Guid) The unique identifier of the original document nature (Debit or Credit). Internally determined. |
| sourceDocId | (Guid) The unique identifier of the original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined. |