Reason Codes

List Reason Codes

reason_codes.list_reason_codes() -> ReasonCodeListReasonCodesResponse

GET/api/v2/public/reasoncodes

Create Reason Codes

reason_codes.create_reason_codes() -> ReasonCodeCreateReasonCodesResponse

POST/api/v2/public/reasoncodes

ModelsExpand Collapse

List[ReasonCodeListReasonCodesResponseItem]

code: int

The reason code itself. This is the value the movement endpoints expect.

formatint32

is_comment_mandatory: bool

true when a comment must be supplied with the movement.

is_gain: bool

true when the code represents stock arriving. The is_gain filter matches on this.

is_image_mandatory: bool

true when a photo must be supplied with the movement.

is_loss: bool

true when the code represents stock leaving. The is_loss filter on the movement log matches on this.

is_order_number_mandatory: bool

true when an order number must be supplied with the movement.

is_picking_list: bool

true when the code applies to picking.

is_rollback_allowed: bool

true when a movement booked under this code can be reversed.

is_sales_order_discount: bool

Correctly spelled alias of CountingCloud.Entities.Entities.Response.ReasonCodesResponsePublicV2.IsSalesOrderDiscsount. Both fields are always emitted and always carry the same value; the misspelled one is kept because live integrations read it.

Deprecatedis_sales_order_discsount: bool

Deprecated — use is_sales_order_discount instead. Both names are still accepted and behave identically; is_sales_order_discount is the supported spelling going forward.

is_store: bool

true when store staff may use this code.

reason_code_type: int

Type of reason code.

formatint32

review_status: int

Review state movements get when booked under this code.

formatint32

code_description: Optional[str]

Short label for the code.

description: Optional[str]

Fuller description of when to use the code.

function_key: Optional[str]

Shortcut key the code is bound to in the app.

store_type: Optional[str]

Store type the code applies to.

class ReasonCodeCreateReasonCodesResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.