Payroll | Payment

Service to manage entities of type 'Payment'.

Overview

api/{tenantKey}/{orgKey}/payroll/payments

URL	api/{tenantKey}/{orgKey}/payroll/payments
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE Payment by identifier
- DELETE Payment by key

All Resources

This service uses the following resources:

ApiPaymentResource
PaymentResource
PaymentsMainResource

All Enumerations

This service uses the following enumerations:

ContractKind
PaymentState

GET Operations

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}/payroll/payments

GET /payroll/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}/payroll/payments?page={page}&pageSize={pageSize}

GET /payroll/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}/payroll/payments/{id}

GET /payroll/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.
paymentKey	(string) Payment.

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}/payroll/payments/{companyKey}/{paymentKey}

GET /payroll/payments/{companyKey}/{paymentKey}

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}/payroll/payments/{id}/print?template={template}

GET /payroll/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.
paymentKey	(string) Payment.

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}/payroll/payments/{companyKey}/{paymentKey}/print

GET /payroll/payments/{companyKey}/{paymentKey}/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}/payroll/payments/{id}/printOriginal?template={template}

GET /payroll/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.
paymentKey	(string) Payment.

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}/payroll/payments/{companyKey}/{paymentKey}/printOriginal

GET /payroll/payments/{companyKey}/{paymentKey}/printOriginal

GET Get Payments By Period

Custom operation 'GetPaymentsByPeriod'.

The following elements are required:

company	(string) Company.
year	(int) Year.
month	(int) Month.

Response:

When successful, the response body contains a list of resources of type 'PaymentResource'. See PaymentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/getPaymentsByPeriod/{company}/{year}/{month}

GET /payroll/payments/getPaymentsByPeriod/{company}/{year}/{month}

POST Operations

POST Payments

Creates a new entity record.

The following elements are required:

paymentResource

(ApiPaymentResource) The request body should contain the entity record that should be created.
See ApiPaymentResource.

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 ApiPaymentResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments

POST /payroll/payments

POST Payment Remove Integration

Remove the accounting integration from the payment (Shared subscriptions only).

The following elements are required:

paymentKey	(string) The payment key.
companyKey	(string) The company key.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/paymentRemoveIntegration/{paymentKey}

POST /payroll/payments/paymentRemoveIntegration/{paymentKey}

POST Payment Integrate

Integrates the document in accounting (Shared subscriptions only).

The following elements are required:

paymentKey	(string) The payment key.
companyKey	(string) The company key.
externalAccountDocumentId	(Guid) The external document unique idenntifier.
externalAccountDocument	(string) The external accounting document.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/paymentIntegrate/{paymentKey}

POST /payroll/payments/paymentIntegrate/{paymentKey}

POST Payment Batch Create

Creates the payment batch or batches for the payment (Shared subscriptions only).

The following elements are required:

paymentKey	(string) The payment key.
companyKey	(string) The company key.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/paymentBatchCreate

POST /payroll/payments/paymentBatchCreate

POST Payment Batch Remove

Reserved (unavailable).

The following elements are required:

paymentKey	(string) The payment key.
companyKey	(string) The company key.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/paymentBatchRemove

POST /payroll/payments/paymentBatchRemove

POST Employee Receipts Create

Custom operation 'EmployeeReceiptsCreate'.

The following elements are required:

companyKey	(string) CompanyKey.
paymentKey	(string) PaymentKey.
processings	(List) Processings.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/payments/employeeReceiptsCreate/{companyKey}/{paymentKey}

POST /payroll/payments/employeeReceiptsCreate/{companyKey}/{paymentKey}

PUT Operations

PUT Set AccountDoc Payment

Updates the value of attribute 'AccountDoc' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/accountDoc

PUT /payroll/payments/{companyKey}/{paymentKey}/accountDoc

PUT Set AccountDocId Payment

Updates the value of attribute 'AccountDocId' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(Guid) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/accountDocId

PUT /payroll/payments/{companyKey}/{paymentKey}/accountDocId

PUT Set BatchCreated Payment

Updates the value of attribute 'BatchCreated' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/batchCreated

PUT /payroll/payments/{companyKey}/{paymentKey}/batchCreated

PUT Set ClosingDate Payment

Updates the value of attribute 'ClosingDate' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/closingDate

PUT /payroll/payments/{companyKey}/{paymentKey}/closingDate

PUT Set Company Payment

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/company

PUT /payroll/payments/{companyKey}/{paymentKey}/company

PUT Set ContractKind Payment

Updates the value of attribute 'ContractKind' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(enum ContractKind) The request body should contain the new value for the attribute. See ContractKind.

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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/contractKind

PUT /payroll/payments/{companyKey}/{paymentKey}/contractKind

PUT Set IsActive Payment

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/isActive

PUT /payroll/payments/{companyKey}/{paymentKey}/isActive

PUT Set Name Payment

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/name

PUT /payroll/payments/{companyKey}/{paymentKey}/name

PUT Set PaymentKey Payment

Updates the value of attribute 'PaymentKey' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/paymentKey

PUT /payroll/payments/{companyKey}/{paymentKey}/paymentKey

PUT Set PaymentState Payment

Updates the value of attribute 'PaymentState' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(enum PaymentState) The request body should contain the new value for the attribute. See PaymentState.

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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/paymentState

PUT /payroll/payments/{companyKey}/{paymentKey}/paymentState

PUT Set Period Payment

Updates the value of attribute 'Period' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/period

PUT /payroll/payments/{companyKey}/{paymentKey}/period

PUT Set TotalCompanyDeductions Payment

Updates the value of attribute 'TotalCompanyDeductions' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/totalCompanyDeductions

PUT /payroll/payments/{companyKey}/{paymentKey}/totalCompanyDeductions

PUT Set TotalDebtProcedures Payment

Updates the value of attribute 'TotalDebtProcedures' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/totalDebtProcedures

PUT /payroll/payments/{companyKey}/{paymentKey}/totalDebtProcedures

PUT Set TotalDeductions Payment

Updates the value of attribute 'TotalDeductions' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/totalDeductions

PUT /payroll/payments/{companyKey}/{paymentKey}/totalDeductions

PUT Set TotalEarnings Payment

Updates the value of attribute 'TotalEarnings' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/totalEarnings

PUT /payroll/payments/{companyKey}/{paymentKey}/totalEarnings

PUT Set TotalNetValue Payment

Updates the value of attribute 'TotalNetValue' in the specified entity record.

The following elements are required:

paymentKey	(string) Payment.
companyKey	(string) The company key.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}/totalNetValue

PUT /payroll/payments/{companyKey}/{paymentKey}/totalNetValue

DELETE Operations

DELETE Payment 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:

api/{tenantKey}/{orgKey}/payroll/payments/{id}

DELETE /payroll/payments/{id}

DELETE Payment by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
paymentKey	(string) Payment.

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:

api/{tenantKey}/{orgKey}/payroll/payments/{companyKey}/{paymentKey}

DELETE /payroll/payments/{companyKey}/{paymentKey}

Resources

ApiPaymentResource

The following elements are required:

paymentKey	(string) Payment.
closingDate	(DateTime) Closing Date.
company	(string) Company.
paymentState	(enum PaymentState) Payment State. See PaymentState.
period	(DateTime) Period.
batchCreated	(bool) Bool value indicating when was the payment batch created.
totalDebtProcedures	(decimal) Total Debt Procedures.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.

The following elements are optional:

name	(string) Name.
totalEarnings	(decimal) Total Earnings.
totalDeductions	(decimal) Total Deductions.
totalCompanyDeductions	(decimal) Total Company Deductions.
totalNetValue	(decimal) Total Net Value.
accountDoc	(string) The accounting document.
accountDocId	(Guid) Accounting Document Identifier.

PaymentResource

The following elements are required:

paymentKey	(string) Payment.
closingDate	(DateTime) Closing Date.
company	(string) Company.
paymentState	(enum PaymentState) Payment State. See PaymentState.
period	(DateTime) Period.
batchCreated	(bool) Bool value indicating when was the payment batch created.
totalDebtProcedures	(decimal) Total Debt Procedures.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.

The following elements are optional:

name	(string) Name.
totalEarnings	(decimal) Total Earnings.
totalDeductions	(decimal) Total Deductions.
totalCompanyDeductions	(decimal) Total Company Deductions.
totalNetValue	(decimal) Total Net Value.
accountDoc	(string) The accounting document.
accountDocId	(Guid) Accounting Document Identifier.

PaymentsMainResource

The following elements are required:

company	(string) Company.
closingDate	(DateTime) Closing Date.
paymentKey	(string) Payment.
paymentState	(enum PaymentState) Payment State. See PaymentState.
period	(DateTime) Period.
batchCreated	(bool) Bool value indicating when was the payment batch created.
totalDebtProcedures	(decimal) Total Debt Procedures.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.

The following elements are optional:

name	(string) Name.
totalCompanyDeductions	(decimal) Total Company Deductions.
totalDeductions	(decimal) Total Deductions.
totalEarnings	(decimal) Total Earnings.
totalNetValue	(decimal) Total Net Value.
accountDoc	(string) The accounting document.

Enumerations

ContractKind

1	Employment
2	Service

PaymentState

1	Open
2	Closed