sprPaymentLocations

  • Updated on Mar 27, 2025
  • Published on Mar 14, 2025
Prev Next

Represents payment locations (spr) in Business Central.

Method Return Type Description
GET sprPaymentLocations sprPaymentLocations Gets a payment location object.
DELETE sprPaymentLocations none Deletes a payment location object.
POST sprPaymentLocations sprPaymentLocations Creates a payment location object.
PATCH sprPaymentLocations sprPaymentLocations Updates a payment location object.
Navigation Return Type Description
sprEmployee sprEmployee Gets the employee associated with the payment location.
sprBank sprBank Gets the bank associated with the payment location.
Property Type Description Relation to
id Guid Specifies the payment location's ID. Non-editable.
employeeNumber String[20] Specifies the employee's number. sprEmployees.number
employeeId Guid Specifies the employee's id. sprEmployees.id
lineNo Int32 Specifies the line number.
paymentOrderType Option Specifies the payment order type. It can be:
0- " "
1- Salary
2- Deduct.Trans.
3- Business Trip
recipientBankAccNo String[30] Specifies the recipient's bank account number. sprBanks.bankAccountNo
recipientBankCode String[10] Specifies the recipient's bank code. sprBanks.code
recipientBankId Guid Specifies the recipient's bank ID. sprBanks.id
companyBankCode String[10] Specifies the companies bank code. sprBanks.bankCode
companyBankId Guid Specifies the companies bank ID. sprBanks.id
includeToPmtOrdersFile Boolean Specifies if the payment location is included in the payment orders file.
lastModifiedDateTime DateTimeOffset Specifies the payment location's last modified date. Read-Only.

POST URI: /companies({{companyId}})/sprPaymentLocations

Request

{
    "employeeId": "{{employeeId}}",
    "paymentOrderType": "1",
    "recipientBankAccNo": "LT123456789134567890",
    "includeToPmtOrdersFile": true
}
JSON

Response

{
    "@odata.context": "http://bc220-2:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(fb9142f3-361f-ee11-a396-ce5b49aea574)/sprPaymentLocations/$entity",
    "@odata.etag": "W/\"JzIwOzExOTUyNjU0OTQwODc1MzcwNTExMTswMDsn\"",
    "id": "82fcca2e-e32b-ee11-a395-98edeed05568",
    "employeeNumber": "D0025",
    "employeeId": "24def330-bd2b-ee11-a395-98edeed05568",
    "lineNo": 20000,
    "paymentOrderType": "Salary",
    "recipientBankAccNo": "LT123456789134567890",
    "recipientBankCode": "",
    "recipientBankId": "00000000-0000-0000-0000-000000000000",
    "companyBankCode": "HCBC",
    "companyBankId": "7b90cdf1-bb2a-ee11-a395-fe66e2afdfa9",
    "includeToPmtOrdersFile": true,
    "lastModifiedDateTime": "2023-07-26T18:35:24.793Z"
}
JSON