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

operation_status required

Title: Operation type
Description: Status to identify if it was a sucessfull or failure operation. 0 - Successfull, 1 - Failure
Type: string
Example:
0
1

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

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

{
    "$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",
        "operation_status"
    ],
    "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"
            ]
        },
        "operation_status": {
            "type": "string",
            "title": "Operation type",
            "description": "Status to identify if it was a sucessfull or failure operation. 0 - Successfull, 1 - Failure",
            "examples": [
                "0",
                "1"
            ]
        },
        "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"
            ]
        },
        "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"
                    ]
                }
            }
        }
    }
}

{
    "contract_id": "e0ec1a1c-982e-4887-bdaf-73b000751287",
    "registrar_document_number": "10358728000143",
    "operation_type": "CREATE_UPDATE",
    "operation_status": "0",
    "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",
    "effects_count": 1,
    "effects_group": {
        "acquirer_document_number": "20481714683595",
        "commercial_establishment_document_number": "62543463000157",
        "owner_document_number": "20481714000176",
        "payment_arrangement": "MCC"
    }
}

Updated 2 months ago