Contract Not Applied

Not applied contract event. The Update receivable endpoint generates this event.

Type: object
Domain: depositary
Event: contract_failure
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

error_code required

Title: Error Code
Description: error_code is used to identify possible errors
Type: string
Example:
0066
0079

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

error_message

Title: Error message
Description: Error message describes possible failures
Type: string
Example:
Relação não existe na Base de Controle.

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Contract Not Applied",
    "description": "Not applied contract 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",
        "error_code"
    ],
    "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"
            ]
        },
        "error_code": {
            "type": "string",
            "title": "Error Code",
            "description": "error_code is used to identify possible errors",
            "examples": [
                "0066",
                "0079"
            ]
        },
        "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
            ]
        },
        "error_message": {
            "type": "string",
            "title": "Error message",
            "description": "Error message describes possible failures",
            "examples": [
                "Rela\u00e7\u00e3o n\u00e3o existe na Base de Controle."
            ]
        }
    }
}
{
    "contract_id": "e0ec1a1c-982e-4887-bdaf-73b000751287",
    "registrar_document_number": "10358728000143",
    "operation_type": "CREATE_UPDATE",
    "error_code": "0066",
    "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,
    "error_message": "Rela\u00e7\u00e3o n\u00e3o existe na Base de Controle."
}