Payroll | Create Payment File
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/createPaymentFiles |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET Create Payment File
Returns the list of entity records that can be processed by the 'Payments' 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). |
The following elements are optional:
| bankAccount | (string) Bank Account This is a query string parameter. |
| paymentMethod | (string) Payment Method This is a query string parameter. |
| transferDate | (DateTime?) Transfer Date This is a query string parameter. |
| periodStart | (DateTime?) Period Start This is a query string parameter. |
| periodEnd | (DateTime?) Period End This is a query string parameter. |
| payment | (string) Payment This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| includeNegativeValues | (bool?) Include Negative Values This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See PaymentFileLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/createPaymentFiles/{pageIndex}/{pageSize}?bankAccount={bankAccount}&paymentMethod={paymentMethod}&transferDate={transferDate}&periodStart={periodStart}&periodEnd={periodEnd}&payment={payment}&company={company}&includeNegativeValues={includeNegativeValues}
GET /payroll/createPaymentFiles/{pageIndex}/{pageSize}?bankAccount={bankAccount}&paymentMethod={paymentMethod}&transferDate={transferDate}&periodStart={periodStart}&periodEnd={periodEnd}&payment={payment}&company={company}&includeNegativeValues={includeNegativeValues}
POST Create Payment File
Instructs the 'Payments' service to process the specified entity records.
The following elements are required:
| list | (PaymentFileLine) List of the entity records that should be processed. See PaymentFileLine. |
| 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}/payroll/createPaymentFiles/{companyKey}
POST /payroll/createPaymentFiles/{companyKey}
Resources
PaymentFile
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| bankAccount | (string) Bank Account. |
| paymentMethod | (string) Payment Method. |
| transferDate | (DateTime) Transfer Date. |
| periodStart | (DateTime) Period Start. |
| periodEnd | (DateTime) Period End. |
| payment | (string) Payment. |
| company | (string) Company. |
| includeNegativeValues | (bool) Include Negative Values. |
PaymentFileLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| employee | (string) Employee. |
| contract | (string) Contract. |
| employeeReceipt | (string) Receipt. |
| value | (decimal) Value. |
| swift | (string) Swift. |
| iban | (string) Iban. |
| reference | (string) Reference. |
| company | (string) Company. |
| paymentPeriod | (DateTime) Payment Period. |