Stock statement

Endpoints

Import entity list

/companies/{companycode}/stock-statements/import

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Body

body
required

ImportStockStatementList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

StockStatement

Stock statement data structure.

Name Description Value Business rules

batch
optional

Batch

string

20 characters max

companyCode
required

Current company code

string

2 characters max

depositCode
required

Deposit code

string

10 characters max

establishmentCode
required

Current establishment code

string

2 characters max

firstQuantity
required

First quantity

double

firstUnitCode
required

First unit code

string

5 characters max

itemCode
required

Item code

string

20 characters max

secondQuantity
optional

Second quantity

double

secondUnitCode
optional

Second unit code

string

5 characters max

stockDate
required

Stock date

datetime (ISO-8601)

ImportStockStatementList

Name Value

callback
optional

string

data
optional

StockStatement list

parameters
optional

StockStatementParameters

StockStatementParameters

Stock statement parameters structure.

Name Description Value

dateType
required

Date type

string (BEGIN_CURRENT_MONTH, BEGIN_CURRENT_WEEK, BEGIN_CURRENT_DAY, CUSTOM)

deleteBeforeImport
optional

Delete stock statements of the scope before import ?

boolean

depositCodes
optional

List of deposit codes

list

endDate
optional

End date

datetime (ISO-8601)

establishmentCode
optional

Establishment code

string

startDate
optional

Start date

datetime (ISO-8601)