Adjustment created (outdated)

This functionality is scheduled to be deprecated. For any new deployments, use Force operation instead.
This event occurs when the platform creates an adjustment.
Generated by: Create adjustment
More information: Adjustments overview

Type: object
Domain: audit
Event: core_adjustment
Version: 1

method required

Title: The operation HTTP method
Type: string
Example:
POST

uri required

Title: The API operation URI
Type: string
Example:
/v1/adjustment

email required

Title: The operator email
Type: string or null
Example:
[email protected]

roles required

Title: The operator roles
Type: array or null
Example:

[
    "backoffice-operator",
    "crm-operator",
    "geroficios-operator",
    "inspetoria-master",
    "inspetoria-operator",
    "itibackoffice-master",
    "itibackoffice-operator",
    "itinivel1-operator",
    "treasury-operator"
]

object required

Title: The audit data message
Type: object

adjustment_type_id required

Title: The Adjustment type id
Type: integer
Example:
171238

amount required

Title: The Amount value
Type: number
Example:
0.02

account_id required

Title: The account identifier
Type: integer
Example:
123

description required

Title: The Description
Type: string or null
Example:
Teste 2

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Adjustment created (outdated)",
    "description": "<b>This functionality is scheduled to be deprecated. For any new deployments, use <a href='https://developers.pismo.io/pismo-docs/docs/force-operation' target='_blank'>Force operation</a> instead.</b><br>This event occurs when the platform creates an adjustment.<br>Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-adjustments-v1-adjustments-1' target='_blank'>Create adjustment</a><br>More information: <a href='https://developers.pismo.io/pismo-docs/docs/adjustments-overview' target='_blank'>Adjustments overview</a>",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "The operation HTTP method",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "The API operation URI",
            "examples": [
                "/v1/adjustment"
            ]
        },
        "email": {
            "type": [
                "string",
                "null"
            ],
            "title": "The operator email",
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": [
                "array",
                "null"
            ],
            "title": "The operator roles",
            "items": {
                "type": "string",
                "title": "The Roles",
                "examples": [
                    "backoffice-operator",
                    "crm-operator",
                    "geroficios-operator",
                    "inspetoria-master",
                    "inspetoria-operator",
                    "itibackoffice-master",
                    "itibackoffice-operator",
                    "itinivel1-operator",
                    "treasury-operator"
                ]
            }
        },
        "object": {
            "type": "object",
            "title": "The audit data message",
            "required": [
                "amount",
                "adjustment_type_id",
                "description",
                "account_id"
            ],
            "properties": {
                "adjustment_type_id": {
                    "type": "integer",
                    "title": "The Adjustment type id",
                    "examples": [
                        171238
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "The Amount value",
                    "examples": [
                        0.02
                    ]
                },
                "account_id": {
                    "type": "integer",
                    "title": "The account identifier",
                    "examples": [
                        123
                    ]
                },
                "description": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The Description",
                    "examples": [
                        "Teste 2"
                    ]
                }
            }
        }
    }
}

{
    "method": "POST",
    "uri": "/v1/adjustment",
    "email": "[email protected]",
    "roles": [
        "backoffice-operator",
        "crm-operator",
        "geroficios-operator",
        "inspetoria-master",
        "inspetoria-operator",
        "itibackoffice-master",
        "itibackoffice-operator",
        "itinivel1-operator",
        "treasury-operator"
    ],
    "object": {
        "adjustment_type_id": 171238,
        "amount": 0.02,
        "account_id": 123,
        "description": "Teste 2"
    }
}

Updated 21 days ago