---
title: "sprIntegrationExchanges"
slug: "sprintegrationexchanges"
updated: 2025-11-27T12:26:49Z
published: 2025-11-27T12:26:49Z
canonical: "instrukcijos.softera.lt/sprintegrationexchanges"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://instrukcijos.softera.lt/llms.txt
> Use this file to discover all available pages before exploring further.

# sprIntegrationExchanges

Represents integration exchange (spr) in Business Central.

## Methods

| Method | Return Type | Description |
| --- | --- | --- |
| GET sprIntegrationExchanges | Collection(sprIntegrationExchanges) | Gets a collection of sprIntegrationExchanges objects. |
| POST sprIntegrationExchanges | sprIntegrationExchanges | Creates a sprIntegrationExchanges object. |

## Properties

| Property | Type | Length | Description |
| --- | --- | --- | --- |
| id | Guid |  | The unique ID of the integration exchange. Non-editable. |
| entryNumber | BigInteger |  | Specifies the integration exchange entry number. |
| status | Enum |  | Specifies the integration exchange status. It can be: 0- " " 1- Inbound_Pending 2- Inbound_Error 3- Inbound_Skipped 4- Inbound_Finished |
| customTypeCode | Code | 20 | Specifies the custom type code of the integration exchange. |
| fileExist | Boolean |  | Specifies if the file exists for integration exchange. |
| fileInBase64 | Boolean |  | Specifies if the existing file is in Base64 encoding. |
| fileContent | String |  | Specifies the contents of the existing file. |
| fileName | String | 100 | Specifies the file name. |
| paramIncludeFileContent | Boolean |  | Specifies if the file should include content. |
| lastModifiedDateTime | DateTime |  | Specifies the last modified date and time. |

## Examples

### GET sprIntegrationExchanges - collection with file content

`https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprIntegrationExchanges?$filter=(paramIncludeFileContent eq 'true')`

RESPONSE

```
{
    "@odata.context": "http://bcserver-default:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(18e38aed-cb24-f011-8a73-ec5e689fb79a)/sprIntegrationExchanges",
    "value": [
        {
            "@odata.etag": "W/\"JzE4OzgyNzQ0MTA2NTQ0ODAyODQ4NDE7MDA7Jw==\"",
            "id": "e8b30d59-bbbf-f011-8aa2-fdf0877734a1",
            "entryNumber": 1,
            "status": "Inbound_Pending",
            "customTypeCode": "TEST",
            "fileExist": true,
            "fileInBase64": true,
            "fileContent": "IntcInJlc3VsdHNcIjpbe1wiZmlyc3ROYW1lXCI6XCJQaXJtYXNcIixcImxhc3ROYW1lXCI6XCJQaXJtb2thc1wifV19Ig==",
            "fileName": "Test file.json",
            "paramIncludeFileContent": "Yes",
            "lastModifiedDateTime": "2025-11-12T11:33:03.253Z"
        }
    ]
}
```

### POST sprIntegrationExchanges - file encoded in Base64

`https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprIntegrationExchanges`

REQUEST

```
{
    "customTypeCode": "TEST",
    "fileInBase64": true,
    "fileContent": "IntcInJlc3VsdHNcIjpbe1wiZmlyc3ROYW1lXCI6XCJQaXJtYXNcIixcImxhc3ROYW1lXCI6XCJQaXJtb2thc1wifV19Ig==",
    "fileName": "Test file.json"
}
```

RESPONSE

```
{
    "@odata.context": "http://bcserver-default:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(18e38aed-cb24-f011-8a73-ec5e689fb79a)/sprIntegrationExchanges/$entity",
    "@odata.etag": "W/\"JzE5OzM5NDE5NjQ5ODM4MjYwNTE2ODYxOzAwOyc=\"",
    "id": "e440d27e-83c0-f011-8aa2-fdf0877734a1",
    "entryNumber": 13,
    "status": "Inbound_Pending",
    "customTypeCode": "TEST",
    "fileExist": true,
    "fileInBase64": true,
    "fileContent": "IntcInJlc3VsdHNcIjpbe1wiZmlyc3ROYW1lXCI6XCJQaXJtYXNcIixcImxhc3ROYW1lXCI6XCJQaXJtb2thc1wifV19Ig==",
    "fileName": "Test file.json",
    "paramIncludeFileContent": "",
    "lastModifiedDateTime": "2025-11-13T11:25:45.967Z"
}
```

### POST sprIntegrationExchanges - file not encoded in Base64

`https://api.businesscentral.dynamics.com/v2.0/{{tenant}}/{{environmentName}}/api/softera/softeraPayroll/{{sprAPIVersion}}/companies({{companyId}})/sprIntegrationExchanges`

REQUEST

```
{
    "customTypeCode": "TEST",
    "fileInBase64": false,
    "fileContent": "{\"results\":[{\"firstName\":\"Pirmas\",\"lastName\":\"Pirmokas\"}]}",
    "fileName": "Test file.json"
}
```

RESPONSE

```
{
    "@odata.context": "http://bcserver-default:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(18e38aed-cb24-f011-8a73-ec5e689fb79a)/sprIntegrationExchanges/$entity",
    "@odata.etag": "W/\"JzIwOzE3OTUzODA2MTM2Njc5MTY5NjI3MTswMDsn\"",
    "id": "d076a799-83c0-f011-8aa2-fdf0877734a1",
    "entryNumber": 14,
    "status": "Inbound_Pending",
    "customTypeCode": "TEST",
    "fileExist": true,
    "fileInBase64": false,
    "fileContent": "{\"results\":[{\"firstName\":\"Pirmas\",\"lastName\":\"Pirmokas\"}]}",
    "fileName": "Test file.json",
    "paramIncludeFileContent": "",
    "lastModifiedDateTime": "2025-11-13T11:26:30.963Z"
}
```