GET api/StockBalances/changes/{branchId}?from={from}

Retrieves any changed rows since the specified time<br/> NOTE: To use this endpoint CDC (change data capture) needs to be enabled on the target database and running on the StockBalance table<br/>

Request Information

URI Parameters

NameDescriptionTypeAdditional information
from

(Required) Specific time to get changes since

 date

Required
branchId

(Optional) Branch ID to filter changes by

 integer

Default value is Null

Body Parameters

None.

Remarks

None.

Example

// Gets every changed stockbalance row since 2023-06-16 09:00
http://localhost/api/stockbalances/changes?from=2023-06-16T09:00

// Gets every changed stockbalance row since 2023-06-16 09:00 on branch 1
http://localhost/api/stockbalances/changes/1?from=2023-06-16T09:00

Response Information

Resource Description

Collection of CDCStockBalanceResponse
NameDescriptionTypeAdditional information
BranchId

integer

Required
ArticleId

globally unique identifier

Required
StockId

globally unique identifier

Required
Quantity

decimal number

Required
ReservedQuantity

decimal number

Required
Consignation

decimal number

Required
StockInTransfer

decimal number

Required
PalletPlace

string

Max length: 100
Changed

Time of the occurred change

 date

Required
Operation

Operation of the occurred change
Can only contain the following values:
DELETE,
INSERT,
UPDATE,
ERROR

 string

Required

Response Formats

application/json, text/json

Sample: 
[
  {
    "BranchId": 1,
    "ArticleId": "cfe16698-b0ac-453f-86e8-8224a707f0be",
    "StockId": "5fb4bcbe-4ef7-4a8b-844c-37ff59fe7753",
    "Quantity": 4.0,
    "ReservedQuantity": 5.0,
    "Consignation": 6.0,
    "StockInTransfer": 7.0,
    "PalletPlace": "sample string 8",
    "Changed": "12/21/2025 1:07:37 PM",
    "Operation": "sample string 10"
  },
  {
    "BranchId": 1,
    "ArticleId": "cfe16698-b0ac-453f-86e8-8224a707f0be",
    "StockId": "5fb4bcbe-4ef7-4a8b-844c-37ff59fe7753",
    "Quantity": 4.0,
    "ReservedQuantity": 5.0,
    "Consignation": 6.0,
    "StockInTransfer": 7.0,
    "PalletPlace": "sample string 8",
    "Changed": "12/21/2025 1:07:37 PM",
    "Operation": "sample string 10"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCDCStockBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.CDC.StockBalance">
  <CDCStockBalanceResponse>
    <Changed xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.CDC">2025-12-21T13:07:37.415348+00:00</Changed>
    <Operation xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.CDC">sample string 10</Operation>
    <ArticleId>cfe16698-b0ac-453f-86e8-8224a707f0be</ArticleId>
    <BranchId>1</BranchId>
    <Consignation>6</Consignation>
    <PalletPlace>sample string 8</PalletPlace>
    <Quantity>4</Quantity>
    <ReservedQuantity>5</ReservedQuantity>
    <StockId>5fb4bcbe-4ef7-4a8b-844c-37ff59fe7753</StockId>
    <StockInTransfer>7</StockInTransfer>
  </CDCStockBalanceResponse>
  <CDCStockBalanceResponse>
    <Changed xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.CDC">2025-12-21T13:07:37.415348+00:00</Changed>
    <Operation xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.CDC">sample string 10</Operation>
    <ArticleId>cfe16698-b0ac-453f-86e8-8224a707f0be</ArticleId>
    <BranchId>1</BranchId>
    <Consignation>6</Consignation>
    <PalletPlace>sample string 8</PalletPlace>
    <Quantity>4</Quantity>
    <ReservedQuantity>5</ReservedQuantity>
    <StockId>5fb4bcbe-4ef7-4a8b-844c-37ff59fe7753</StockId>
    <StockInTransfer>7</StockInTransfer>
  </CDCStockBalanceResponse>
</ArrayOfCDCStockBalanceResponse>