For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stock Ledger Entry

Represents a stock ledger entry

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Body
anyOptional
Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry/_export

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional
Query parameters
sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry/{id}/_export

Perform a search (query) for

get

The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_offsetnumberOptional

The offet of the first result to return

_countnumberOptional

The count of items to return in this result set

_includeTotalbooleanOptional

True if the server should count the matching results. May reduce performance

_orderBystringOptional

Instructs the result set to be ordered (in format: property:(asc|desc))

_queryIdstringOptional

The query state identifier. This allows the client to get a stable result set.

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry

Creates the resource. If the resource already exists, then a 409 is thrown

post

This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/StockLedgerEntry

Returns specific options for a single resource

options
Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

options/StockLedgerEntry

Perform a search (query) and return only the headers

head

The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change

Query parameters
sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
204

There is not response for this method

No content

head/StockLedgerEntry

No content

Retrieves the current version of the specified resource

get

This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object which should be retrieved

Query parameters
_bundlebooleanOptional

True if the server should send related objects to the caller in a bundle

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry/{id}

Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does

post

This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be created or updated

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/StockLedgerEntry/{id}

Retrieves only the metadata of the specified resource

head

The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.

Path parameters
idstringOptional

The identifier of the resource to be retrieved

Query parameters
sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
204

There is not response for this method

No content

head/StockLedgerEntry/{id}

No content

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/StockLedgerEntry/{id}/$diff

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/StockLedgerEntry/{id}/$tag

Gets the specified barcode for the resource

get

This method returns a barcode which explicitly points at the specified resource in the specified authority.

         The barcode is generated using the server's configuration, and is signed by the server's signing key.
        
         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource for which a VRP should be generated

Query parameters
_formatstringOptional

The format of the barcode (santedb-vrp, code39, etc.)

sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry/{id}/_code

Gets the digitally signed pointer (in JWS format) for the resource

get

This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return the structured contents of that code so the client can best determine how to represent the data.

         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : View Clinic Stock Information
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object for which the pointer should be created

Query parameters
sequencestringOptional

Gets or sets the sequence of this entry in the ledger

actstringOptional

Gets or sets the act which caused this ledger entry to be created

containerstringOptional

Gets or sets the container to which this ledger entry applies

materialstringOptional

Gets or sets the material to which the ledger entry applies

reasonstringOptional

Gets or sets the reason for the ledger entry

startOfLinenumberOptional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumberOptional

Gets or sets the quantity of the current ledger entry

createdBystringOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstringOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstringOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a stock ledger entry

sequencenumber · int64Optional

Gets or sets the sequence of this entry in the ledger

actstring · uuidOptional

Gets or sets the act which caused this ledger entry to be created

containerstring · uuidOptional

Gets or sets the container to which this ledger entry applies

materialstring · uuidOptional

Gets or sets the material to which the ledger entry applies

reasonstring · uuidOptional

Gets or sets the reason for the ledger entry

startOfLinenumber · int32Optional

Gets or sets the start of line balance (the known balance before the entry was created)

quantitynumber · int32Optional

Gets or sets the quantity of the current ledger entry

createdBystring · uuidOptional

Gets or sets the security principal that was responsible for the cretion of this ledger entry

creationTimestringOptional

Gets or sets the time that this ledger entry was created

timestampstringOptional

Gets or sets the timestamp when the ledger entry applies to

modifiedOnstring · dateOptional

Gets the modification date of this object entry

typestring · enumOptional

Gets or sets the stock ledger entry type

Possible values:
refstring · uuidOptional

If this entry points to another entry, then the pointer to the entry being referenced

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/StockLedgerEntry/{id}/_ptr

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/StockLedgerEntry/$xsd-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/StockLedgerEntry/$schema-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Perform Stock Count
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/StockLedgerEntry/$xref-use

Last updated

Was this helpful?