Contract applied

Contract applied event. The Update receivable endpoint generates this event.

Type: object
Domain: depositary
Event: contract-applied
Version: 1

|
contract_id required

Title: Contract id
Description: Client-assigned contract_id to identify a contract
Type: string
Example:
e0ec1a1c-982e-4887-bdaf-73b000751287

registrar_document_number required

Title: Registrar document number
Description: Registrar document number to identify to who this contract may be delivered
Type: string
Example:
10358728000143

operation_type required

Title: Operation type
Description: Operation type to identify if it was a contract creation, update, etc
Type: string
Example:
CREATE_UPDATE
CANCEL
EXTENSION
UPDATE_BANKING_DOMICILE

request_control_id

Title: Request control id
Description: Client-assigned request_control_id identifier
Type: string
Example:
4b52702e-516a-4efc-bebb-c15c5ea27525

reception_control_id

Title: Reception control id
Description: Client-assigned reception_control_id identifier
Type: string
Example:
4b52702e-516a-4efc-bebb-c15c5ea27525

external_contract_id

Title: External contract id
Description: Client-assigned external_contract_id identifier
Type: string
Example:
4b52702e-516a-4efc-bebb-c15c5ea27525

batch_id

Title: Batch id
Description: Client-assigned batch_id identifier
Type: string
Example:
4b52702e-516a-4efc-bebb-c15c5ea27525

creditor_document_number

Title: Creditor document number
Description: Client-assigned creditor_document_number identifier
Type: string
Example:
10358728000143

creation_date

Title: Creation date
Description: Client-assigned creation_date identifier
Type: string
Format: date
Example:
2024-12-01

reference_date

Title: Reference date
Description: Client-assigned reference_date identifier
Type: string
Format: date
Example:
2024-12-01

indicator_status

Title: Indicator of success or failed
Description: Success or failed indicator. [0=SUCCESS] [1=FAILURE]
Type: number
Example:
1

effects_count

Title: Number of effects applied
Description: Client-assigned reference_date identifier
Type: number
Example:
1

effects_group

Title: List of effects applied
Description: Effects linked to Contract
Type: array

acquirer_document_number required

Title: Acquirer Document Number
Description: Acquirer document number
Type: string
Example:
20481714683595

commercial_establishment_document_number required

Title: Commercial Establishment Document Number
Description: Document number of commercial establishment
Type: string
Example:
62543463000157

owner_document_number required

Title: Owner Document Number
Description: Document number of owner
Type: string
Example:
20481714000176

payment_arrangement required

Title: Payment Arrangement
Description: Represents code of payment arrangement
Type: string
Example:
MCC

domicile

Title: Banking Domicile
Description: List of effects linked to Contract
Type: object

account_type

Title: Account Type
Description: Represents the type of an account
Type: string
Example:
CC, CD, PG, PP

branch required

Title: Branch Bank
Description: Represents the branch bank
Type: string
Example:
0449

account required

Title: Account Number
Description: Represents the number of bank account
Type: string
Example:
20481714000176

account_digit

Title: Account Digit
Description: Represents the account digit
Type: string
Example:
55

account_holder_document_number required

Title: Account Holder Document Number
Description: Document number of account holder
Type: string
Example:
20481714000176

ispb

Title: ISPB
Description: ISPB number of Institution
Type: integer
Example:
20481714

document_type

Title: Document Type
Description: The account holder document type
Type: string
Example:
RG

receivables

Title: List of unit receivables achieved
Description: Unit receivable achieved to contract
Type: array

settlement_date required

Title: Settlement Date
Description: Settlement date for payment
Type: string
Format: date
Example:
2022-12-01

requested_effect_value

Title: Requested Effect Value
Description: Represents the requested value of UR
Type: number
Format: double
Example:
10.0

compromised_effect_value

Title: Compromised Effect Value
Description: Represents the compromised value of UR
Type: number
Format: double
Example:
10.0

total_constituted

Title: Total Constituted
Description: Represents the constituted value of UR
Type: number
Format: double
Example:
10.0

effect_value_to_be_constituted

Title: Effect Value To Be Constituted
Description: Represents the value to be constituted of UR
Type: number
Format: double
Example:
10.0

compromised_value

Title: Compromised Value
Description: Represents the compromised value of UR
Type: number
Format: double
Example:
10.0

order_effect_indicator required

Title: Order Indicator of the Effect
Description: Represents the order of the effect in UR
Type: integer
Example:
1

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Contract applied",
    "description": "Contract applied event. The <a href='https://developers.pismo.io/pismo-docs/reference/update' target='_blank'>Update receivable</a> endpoint generates this event.",
    "required": [
        "contract_id",
        "registrar_document_number",
        "operation_type"
    ],
    "properties": {
        "contract_id": {
            "type": "string",
            "title": "Contract id",
            "description": "Client-assigned contract_id to identify a contract",
            "examples": [
                "e0ec1a1c-982e-4887-bdaf-73b000751287"
            ]
        },
        "registrar_document_number": {
            "type": "string",
            "title": "Registrar document number",
            "description": "Registrar document number to identify to who this contract may be delivered",
            "examples": [
                "10358728000143"
            ]
        },
        "operation_type": {
            "type": "string",
            "title": "Operation type",
            "description": "Operation type to identify if it was a contract creation, update, etc",
            "examples": [
                "CREATE_UPDATE",
                "CANCEL",
                "EXTENSION",
                "UPDATE_BANKING_DOMICILE"
            ]
        },
        "request_control_id": {
            "type": "string",
            "title": "Request control id",
            "description": "Client-assigned request_control_id identifier",
            "examples": [
                "4b52702e-516a-4efc-bebb-c15c5ea27525"
            ]
        },
        "reception_control_id": {
            "type": "string",
            "title": "Reception control id",
            "description": "Client-assigned reception_control_id identifier",
            "examples": [
                "4b52702e-516a-4efc-bebb-c15c5ea27525"
            ]
        },
        "external_contract_id": {
            "type": "string",
            "title": "External contract id",
            "description": "Client-assigned external_contract_id identifier",
            "examples": [
                "4b52702e-516a-4efc-bebb-c15c5ea27525"
            ]
        },
        "batch_id": {
            "type": "string",
            "title": "Batch id",
            "description": "Client-assigned batch_id identifier",
            "examples": [
                "4b52702e-516a-4efc-bebb-c15c5ea27525"
            ]
        },
        "creditor_document_number": {
            "type": "string",
            "title": "Creditor document number",
            "description": "Client-assigned creditor_document_number identifier",
            "examples": [
                "10358728000143"
            ]
        },
        "creation_date": {
            "type": "string",
            "title": "Creation date",
            "description": "Client-assigned creation_date identifier",
            "format": "date",
            "examples": [
                "2024-12-01"
            ]
        },
        "reference_date": {
            "type": "string",
            "title": "Reference date",
            "description": "Client-assigned reference_date identifier",
            "format": "date",
            "examples": [
                "2024-12-01"
            ]
        },
        "indicator_status": {
            "type": "number",
            "title": "Indicator of success or failed",
            "description": "Success or failed indicator. [0=SUCCESS] [1=FAILURE]",
            "examples": [
                1
            ]
        },
        "effects_count": {
            "type": "number",
            "title": "Number of effects applied",
            "description": "Client-assigned reference_date identifier",
            "examples": [
                1
            ]
        },
        "effects_group": {
            "type": "array",
            "title": "List of effects applied",
            "items": {
                "$ref": "#/definitions/effects_group"
            }
        }
    },
    "definitions": {
        "effects_group": {
            "type": "object",
            "title": "Effects Group",
            "required": [
                "acquirer_document_number",
                "commercial_establishment_document_number",
                "owner_document_number",
                "payment_arrangement"
            ],
            "description": "Effects linked to Contract",
            "properties": {
                "acquirer_document_number": {
                    "type": "string",
                    "title": "Acquirer Document Number",
                    "description": "Acquirer document number",
                    "examples": [
                        "20481714683595"
                    ]
                },
                "commercial_establishment_document_number": {
                    "type": "string",
                    "title": "Commercial Establishment Document Number",
                    "description": "Document number of commercial establishment",
                    "examples": [
                        "62543463000157"
                    ]
                },
                "owner_document_number": {
                    "type": "string",
                    "title": "Owner Document Number",
                    "description": "Document number of owner",
                    "examples": [
                        "20481714000176"
                    ]
                },
                "payment_arrangement": {
                    "type": "string",
                    "title": "Payment Arrangement",
                    "description": "Represents code of payment arrangement",
                    "examples": [
                        "MCC"
                    ]
                },
                "domicile": {
                    "$ref": "#/definitions/domicile"
                },
                "receivables": {
                    "type": "array",
                    "title": "List of unit receivables achieved",
                    "items": {
                        "$ref": "#/definitions/receivable"
                    }
                }
            }
        },
        "domicile": {
            "type": "object",
            "title": "Banking Domicile",
            "required": [
                "account",
                "branch",
                "account_holder_document_number"
            ],
            "description": "List of effects linked to Contract",
            "properties": {
                "account_type": {
                    "type": "string",
                    "title": "Account Type",
                    "description": "Represents the type of an account",
                    "examples": [
                        "CC, CD, PG, PP"
                    ]
                },
                "branch": {
                    "type": "string",
                    "title": "Branch Bank",
                    "description": "Represents the branch bank",
                    "examples": [
                        "0449"
                    ]
                },
                "account": {
                    "type": "string",
                    "title": "Account Number",
                    "description": "Represents the number of bank account",
                    "examples": [
                        "20481714000176"
                    ]
                },
                "account_digit": {
                    "type": "string",
                    "title": "Account Digit",
                    "description": "Represents the account digit",
                    "examples": [
                        "55"
                    ]
                },
                "account_holder_document_number": {
                    "type": "string",
                    "title": "Account Holder Document Number",
                    "description": "Document number of account holder",
                    "examples": [
                        "20481714000176"
                    ]
                },
                "ispb": {
                    "type": "integer",
                    "title": "ISPB",
                    "description": "ISPB number of Institution",
                    "examples": [
                        20481714
                    ]
                },
                "document_type": {
                    "type": "string",
                    "title": "Document Type",
                    "description": "The account holder document type",
                    "examples": [
                        "RG"
                    ]
                }
            }
        },
        "receivable": {
            "type": "object",
            "title": "Unit Receivable achieved to Contract",
            "required": [
                "settlement_date",
                "order_effect_indicator"
            ],
            "description": "Unit receivable achieved to contract",
            "properties": {
                "settlement_date": {
                    "type": "string",
                    "title": "Settlement Date",
                    "description": "Settlement date for payment",
                    "format": "date",
                    "examples": [
                        "2022-12-01"
                    ]
                },
                "requested_effect_value": {
                    "type": "number",
                    "title": "Requested Effect Value",
                    "description": "Represents the requested value of UR",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "compromised_effect_value": {
                    "type": "number",
                    "title": "Compromised Effect Value",
                    "description": "Represents the compromised value of UR",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "total_constituted": {
                    "type": "number",
                    "title": "Total Constituted",
                    "description": "Represents the constituted value of UR",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "effect_value_to_be_constituted": {
                    "type": "number",
                    "title": "Effect Value To Be Constituted",
                    "description": "Represents the value to be constituted of UR",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "compromised_value": {
                    "type": "number",
                    "title": "Compromised Value",
                    "description": "Represents the compromised value of UR",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "order_effect_indicator": {
                    "type": "integer",
                    "title": "Order Indicator of the Effect",
                    "description": "Represents the order of the effect in UR",
                    "examples": [
                        1
                    ]
                }
            }
        }
    }
}
{
    "contract_id": "e0ec1a1c-982e-4887-bdaf-73b000751287",
    "registrar_document_number": "10358728000143",
    "operation_type": "CREATE_UPDATE",
    "request_control_id": "4b52702e-516a-4efc-bebb-c15c5ea27525",
    "reception_control_id": "4b52702e-516a-4efc-bebb-c15c5ea27525",
    "external_contract_id": "4b52702e-516a-4efc-bebb-c15c5ea27525",
    "batch_id": "4b52702e-516a-4efc-bebb-c15c5ea27525",
    "creditor_document_number": "10358728000143",
    "creation_date": "2024-12-01",
    "reference_date": "2024-12-01",
    "indicator_status": 1,
    "effects_count": 1,
    "effects_group": {
        "acquirer_document_number": "20481714683595",
        "commercial_establishment_document_number": "62543463000157",
        "owner_document_number": "20481714000176",
        "payment_arrangement": "MCC",
        "domicile": {
            "account_type": "CC, CD, PG, PP",
            "branch": "0449",
            "account": "20481714000176",
            "account_digit": "55",
            "account_holder_document_number": "20481714000176",
            "ispb": 20481714,
            "document_type": "RG"
        },
        "receivables": {
            "settlement_date": "2022-12-01",
            "requested_effect_value": 10.0,
            "compromised_effect_value": 10.0,
            "total_constituted": 10.0,
            "effect_value_to_be_constituted": 10.0,
            "compromised_value": 10.0,
            "order_effect_indicator": 1
        }
    }
}