Credit rights receivable change failed

Failed credit rights receivable change event. The Update receivable endpoint generates this event.

Type: object
Domain: depositary
Event: credit_rights_change_failure
Version: 1

internal_number required

Title: Internal number
Description: Client-assigned internal number for managing credit rights receivable
Type: string
Example:
56789012

message required

Title: Error message
Description: Message about failure to update a credit rights receivable
Type: string
Example:
Credit rights receivable INTERNAL_NUMBER exceeded total amount value from invoice

access_key

Title: Access key
Description: Client-assigned access key identifier
Type: string
Example:
access-key

collateral_type

Title: Collateral type
Description: Collateral type: 1 - Aval collateral
Type: number
Example:
1

credit_operations

Title: Credit operations list
Description: Payments linked to receivable.
Type: array

operation_type

Title: Operation type
Description: Credit operation type. You need to configure operation types with Pismo
Type: string
Example:
operation-type

operation_date

Title: Operation date
Description: Date operation occurred.
Type: string
Format: date
Example:
2022-01-01

contact_number

Title: Contact number
Description: Contact Number
Type: string
Example:
0123456789

operation_maturity

Title: Operation maturity date
Description: Date operation expires, finishing cycle.
Type: string
Format: date
Example:
2022-01-01

operation_value

Title: Operation amount value
Description: Operation amount value
Type: number
Format: double
Example:
10.0

guarantee_percentage

Title: Guaranteed percentage
Description: Operation percentage
Type: number
Format: double
Example:
1.0

debtor_signing_date

Title: Debtor signing date
Description: When debtor signed credit rights receivable
Type: string
Format: date
Example:
2020-12-01

description

Title: Description
Description: Detailed description.
Type: string
Example:
Description

guarantor_name

Title: Guarantor name
Description: Name of guarantor
Type: string
Example:
Tai Kuhn

ibge_code

Title: IBGE Code
Description: IBGE stands for Instituto Brasileiro de Geografia e Estatística, which translates to the Brazilian Institute of Geography and Statistics. This Brazilian national statistical agency is responsible for collecting and providing official data on various aspects of the country. An IBGE code is a specific numerical code assigned to various administrative divisions and geographical areas in Brazil. Federative Unit + Town Name
Type: number
Example:
1234567

lender_signing_date

Title: Lender signing date
Description: When lender signed credit rights receivable.
Type: string
Format: date
Example:
2020-12-01

owner_document_number

Title: Owner document number
Description: Account owner document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil).
Type: string
Example:
10358728000143

owner_name

Title: Owner name
Description: Name of account owner
Type: string
Example:
Sam Sung

payment_method

Title: Payment method
Description: Payment method. Number between 1-6. See detailed descriptions in Create receivable endpoint documentation.
Type: number
Example:
1

payment_status

Title: Payment status
Description: Payment status: 1 = Paid, 2 = Unpaid
Type: number
Example:
1

updated_face_value

Title: Updated Face value
Description: Updated face value. Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase.
Type: number
Format: double
Example:
10.0

updated_maturity_date

Title: Updated Issuing date
Description: Updated maturity date for credit rights receivable.
Type: string
Format: date
Example:
2022-12-01

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Credit rights receivable change failed",
    "description": "Failed credit rights receivable change event. The <a href='https://developers.pismo.io/pismo-docs/reference/update' target='_blank'>Update receivable</a> endpoint generates this event.",
    "required": [
        "internal_number",
        "message"
    ],
    "properties": {
        "internal_number": {
            "type": "string",
            "title": "Internal number",
            "description": "Client-assigned internal number for managing credit rights receivable",
            "examples": [
                "56789012"
            ]
        },
        "message": {
            "type": "string",
            "title": "Error message",
            "description": "Message about failure to update a credit rights receivable",
            "examples": [
                "Credit rights receivable INTERNAL_NUMBER exceeded total amount value from invoice"
            ]
        },
        "access_key": {
            "type": "string",
            "title": "Access key",
            "description": "Client-assigned access key identifier",
            "examples": [
                "access-key"
            ]
        },
        "collateral_type": {
            "type": "number",
            "title": "Collateral type",
            "description": "Collateral type: 1 - Aval collateral",
            "examples": [
                1
            ]
        },
        "credit_operations": {
            "type": "array",
            "title": "Credit operations list",
            "items": {
                "$ref": "#/definitions/credit_operations"
            }
        },
        "debtor_signing_date": {
            "type": "string",
            "title": "Debtor signing date",
            "description": "When debtor signed credit rights receivable",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "description": {
            "type": "string",
            "title": "Description",
            "description": "Detailed description.",
            "examples": [
                "Description"
            ]
        },
        "guarantor_name": {
            "type": "string",
            "title": "Guarantor name",
            "description": "Name of guarantor",
            "examples": [
                "Tai Kuhn"
            ]
        },
        "ibge_code": {
            "type": "number",
            "title": "IBGE Code",
            "description": "IBGE stands for Instituto Brasileiro de Geografia e Estat\u00edstica, which translates to the Brazilian Institute of Geography and Statistics. This Brazilian national statistical agency is responsible for collecting and providing official data on various aspects of the country. An IBGE code is a specific numerical code assigned to various administrative divisions and geographical areas in Brazil. Federative Unit + Town Name",
            "examples": [
                1234567
            ]
        },
        "lender_signing_date": {
            "type": "string",
            "title": "Lender signing date",
            "description": "When lender signed credit rights receivable.",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "owner_document_number": {
            "type": "string",
            "title": "Owner document number",
            "description": "Account owner document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas F\u00edsicas number (Brazil).",
            "examples": [
                "10358728000143"
            ]
        },
        "owner_name": {
            "type": "string",
            "title": "Owner name",
            "description": "Name of account owner",
            "examples": [
                "Sam Sung"
            ]
        },
        "payment_method": {
            "type": "number",
            "title": "Payment method",
            "description": "Payment method. Number between 1-6. See detailed descriptions in <a href='https://developers.pismo.io/pismo-docs/reference/create-receivable' target='_blank'>Create receivable</a> endpoint documentation.",
            "examples": [
                1
            ]
        },
        "payment_status": {
            "type": "number",
            "title": "Payment status",
            "description": "Payment status: 1 = Paid, 2 = Unpaid",
            "examples": [
                1
            ]
        },
        "updated_face_value": {
            "type": "number",
            "title": "Updated Face value",
            "description": "Updated face value. Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase.",
            "format": "double",
            "examples": [
                10.0
            ]
        },
        "updated_maturity_date": {
            "type": "string",
            "title": "Updated Issuing date",
            "description": "Updated maturity date for credit rights receivable.",
            "format": "date",
            "examples": [
                "2022-12-01"
            ]
        }
    },
    "definitions": {
        "credit_operations": {
            "type": "object",
            "title": "Credit Operations",
            "description": "Payments linked to receivable.",
            "properties": {
                "operation_type": {
                    "type": "string",
                    "title": "Operation type",
                    "description": "Credit operation type. You need to configure operation types with Pismo",
                    "examples": [
                        "operation-type"
                    ]
                },
                "operation_date": {
                    "type": "string",
                    "title": "Operation date",
                    "description": "Date operation occurred.",
                    "format": "date",
                    "examples": [
                        "2022-01-01"
                    ]
                },
                "contact_number": {
                    "type": "string",
                    "title": "Contact number",
                    "description": "Contact Number",
                    "examples": [
                        "0123456789"
                    ]
                },
                "operation_maturity": {
                    "type": "string",
                    "title": "Operation maturity date",
                    "description": "Date operation expires, finishing cycle.",
                    "format": "date",
                    "examples": [
                        "2022-01-01"
                    ]
                },
                "operation_value": {
                    "type": "number",
                    "title": "Operation amount value",
                    "description": "Operation amount value",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "guarantee_percentage": {
                    "type": "number",
                    "title": "Guaranteed percentage",
                    "description": "Operation percentage",
                    "format": "double",
                    "examples": [
                        1.0
                    ]
                }
            }
        }
    }
}

{
    "internal_number": "56789012",
    "message": "Credit rights receivable INTERNAL_NUMBER exceeded total amount value from invoice",
    "access_key": "access-key",
    "collateral_type": 1,
    "credit_operations": {
        "operation_type": "operation-type",
        "operation_date": "2022-01-01",
        "contact_number": "0123456789",
        "operation_maturity": "2022-01-01",
        "operation_value": 10.0,
        "guarantee_percentage": 1.0
    },
    "debtor_signing_date": "2020-12-01",
    "description": "Description",
    "guarantor_name": "Tai Kuhn",
    "ibge_code": 1234567,
    "lender_signing_date": "2020-12-01",
    "owner_document_number": "10358728000143",
    "owner_name": "Sam Sung",
    "payment_method": 1,
    "payment_status": 1,
    "updated_face_value": 10.0,
    "updated_maturity_date": "2022-12-01"
}

Updated 2 days ago