Analytics Stock Real Movement

Endpoints

Get stock movement list

/companies/{companycode}/establishments/{establishmentcode}/analytics/stock-real-movements

operation.deprecated

Description

Returns stock movements.

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Query

from
required

Begin date

string

Query

to
optional

End date

string

Responses

HTTP Code Description Schema

200

Successfull

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

stock movement response information

Description of a stock movement.

Name Description Value

at
required

movement date

datetime (ISO-8601)

cancelled
required

movement deleted or not

boolean

companyCode
required

Current company code

string

containerMovements
required

Container movement list

establishmentCode
required

Current establishment code

string

itemBatchMovements
required

Items/batch movement list

movementId
required

Current movement id

integer

natureCode
required

movement nature

string

type
required

movement type (INPUT, OUTPUT or TRANSFER)

string (INPUT, OUTPUT, TRANSFER)

ContainerMovements

Name Description Value

containerNsc
optional

Container code

string

direction
optional

Direction (INPUT or OUTPUT)

string (INPUT, OUTPUT)

geoContext
optional

Context

ItemBatchMovements

Name Description Value

direction
required

Direction (INPUT or OUTPUT)

string (INPUT, OUTPUT)

enteredQuantities
required

Items/batch quantities (declared with input units)

geoContext
required

Context

stockQuantities
required

Items/batch quantities (declared with stock units)

Quantities

Name Description Value

batchCode
optional

Batch code

string

itemCode
required

Item code

string

quantity1
required

First quantity

quantity2
optional

Second quantity

GeoContext

Name Description Value

childContainerNsc
optional

Child container code

string

depotCode
optional

Deposit code

string

locationCode
optional

Location code

string

parentContainerNsc
optional

Parent container code

string

ValueUnitCode

Name Description Value

unitCode
optional

Quantity unit code

string

value
optional

Quantity value

number

QuantityBatch

Name Description Value

unitCode
required

quantity unit code

string

value
required

quantity value

double