Represents payment files submission and status return (spr) in Business Central.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET sprPaymentFiles | Collection(sprPaymentFiles) | Gets a collection of sprPaymentFiles objects. |
| PATCH sprPaymentFiles | sprPaymentFiles | Updates a sprPaymentFiles object. |
Properties
| Property | Type | Length | Description |
|---|---|---|---|
| id | Guid | The unique ID of the integration exchange. Non-editable. | |
| entryNumber | Integer | Specifies the integration exchange entry number. | |
| fileName | String | 100 | Specifies the file name. |
| fileExist | Boolean | Specifies if the file exists. | |
| status | Enum | Specifies the exchange status. It can be: 0- " "; 1- Ready; 2- Finished; 3- Error; 4- Cancelled. |
|
| integrationMessage | String | 250 | Data exchange comment. |
| lastModifiedDateTime | DateTime | Specifies the last modified date and time. | |
| fileContent@odata.mediaReadLink | String | 250 | The query address to access the file contents. |
Data flow
A file is created in Microsoft BC with the status Ready. The status can also be changed to Cancel.
The file is retrieved via the API, and its status is updated using PATCH to either Finish or Error.
Examples
GET sprPaymentFiles
REQUEST full file list
https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprPaymentFiles
REQUEST with lastModifiedDateTime greater than or equal filter
https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprPaymentFiles?$filter=lastModifiedDateTime ge 2025-12-01T00:00:00Z
RESPONSE
{
"@odata.context": "http://bc25-1:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(8bea8b2c-9e21-f011-9af2-6045bde9b9ec)/sprPaymentFiles",
"value": [
{
"@odata.etag": "W/\"JzE5Ozc0NzA3OTM4NzExNzg5MzI3MzgxOzAwOyc=\"",
"id": "c455881a-b6ca-f011-b18e-eb1b6a9ba462",
"entryNunber": 1,
"fileName": "debank-2mok_202511261253.xml",
"fileExist": true,
"status": "Ready",
"integrationMessage": "",
"lastModifiedDateTime": "2025-12-10T08:56:53.04Z",
"fileContent@odata.mediaReadLink": "http://bc25-1:7048/BC/api/softera/softeraPayroll/v1.0/companies(8bea8b2c-9e21-f011-9af2-6045bde9b9ec)/sprPaymentFiles(c455881a-b6ca-f011-b18e-eb1b6a9ba462)/fileContent"
}
]
}
REQUEST file content
https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprPaymentFiles(c455881a-b6ca-f011-b18e-eb1b6a9ba462)/fileContent
RESPONSE
<?xml version="1.0" encoding="utf-8"?>
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.03">
<CstmrCdtTrfInitn>
<GrpHdr>
<MsgId>AMOK0000511</MsgId>
<CreDtTm>2025-11-26T10:53:10</CreDtTm>
<NbOfTxs>1</NbOfTxs>
..
</GrpHdr>
<PmtInf>
<PmtInfId>BMOK0000511 SL-L-LT</PmtInfId>
..
</PmtInf>
</CstmrCdtTrfInitn>
</Document>
PATCH sprPaymentFiles change of integration status
REQUEST
https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprPaymentFiles(c455881a-b6ca-f011-b18e-eb1b6a9ba462)
The "if-match" key should be specified in the header.
{
"status": "Finished",
"integrationMessage": "Integration completed"
}
RESPONSE
{
"@odata.context": "http://bc25-1:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(8bea8b2c-9e21-f011-9af2-6045bde9b9ec)/sprPaymentFiles/$entity",
"@odata.etag": "W/\"JzE5OzMyMjc2MDIyMzQwNTE0ODM2ODIxOzAwOyc=\"",
"id": "c455881a-b6ca-f011-b18e-eb1b6a9ba462",
"entryNunber": 1,
"fileName": "debank-2mok_202511261253.xml",
"fileExist": true,
"status": "Finished",
"integrationMessage": "Integration completed",
"lastModifiedDateTime": "2025-12-10T11:56:39.773Z",
"fileContent@odata.mediaReadLink": "http://bc25-1:7048/BC/api/softera/softeraPayroll/v1.0/companies(8bea8b2c-9e21-f011-9af2-6045bde9b9ec)/sprPaymentFiles(c455881a-b6ca-f011-b18e-eb1b6a9ba462)/fileContent"
}