Credit rights receivable registration failure

A credit rights receivable failed to register. The Create receivable endpoint generates this event.

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

credit_rights_receivable_type required

Title: Credit rights receivable type
Description: Credit receivable type: 1 - Mercantile, 2 - Service
Type: number
Example:
1

debtor_document_number required

Title: Debtor document number
Description: Debtor 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

debtor_name required

Title: Debtor name
Description: Debtor name
Type: string
Example:
Hy Ball

face_value required

Title: Face value
Description: 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

holding_number required

Title: Holding Number
Description: Holding number - The invoice number + '.' + the number of installments.
Type: string
Example:
ABC.26

ibge_code required

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

internal_number required

Title: Internal number
Description: Client-assigned internal number used to manage credit rights receivable
Type: string
Example:
56789012

invoice_number required

Title: Invoice number
Description: Invoice number.
Type: number
Example:
123456789

invoice_serie required

Title: Invoice serie
Description: Invoice serie (series).
Type: number
Example:
2

invoice_total_value required

Title: Invoice total value
Description: Invoice total value.
Type: number
Format: double
Example:
1000.0

issuing_date required

Title: Issuing date
Description: When client issued credit rights receivable
Type: string
Format: date
Example:
2020-12-01

lender_document_number required

Title: Lender document number
Description: Lender 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

lender_name required

Title: Lender name
Description: Name of lender
Type: string
Example:
Ho Lee Smokes

maturity_date required

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

message required

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

payment_method required

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

payment_status required

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

recorder_account required

Title: Recorder account
Description: Recorder account number.
Type: number
Example:
1

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: Operation type. You need to configure the 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 Value
Description: Operation amount value
Type: number
Format: double
Example:
10.0

guarantee_percentage

Title: Amount to Pay
Description: Operation percentage
Type: number
Format: double
Example:
1.0

debtor_signing_date

Title: Issuing 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: Guarantor name
Type: string
Example:
Polly Ester

interop_holding_number

Title: Interop Holding Number
Description: Credit rights receivable recurring code with letter
Type: string
Example:
ABCY

lender_signing_date

Title: Lender signing date
Description: Lender signing date
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:
Nick O'Thyme

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Credit rights receivable registration failure",
    "description": "A credit rights receivable failed to register. The <a href='https://developers.pismo.io/pismo-docs/reference/create-receivable' target='_blank'>Create receivable</a> endpoint generates this event.",
    "required": [
        "credit_rights_receivable_type",
        "debtor_document_number",
        "debtor_name",
        "face_value",
        "holding_number",
        "ibge_code",
        "internal_number",
        "invoice_number",
        "invoice_serie",
        "invoice_total_value",
        "issuing_date",
        "lender_document_number",
        "lender_name",
        "maturity_date",
        "message",
        "payment_method",
        "payment_status",
        "recorder_account"
    ],
    "properties": {
        "credit_rights_receivable_type": {
            "type": "number",
            "title": "Credit rights receivable type",
            "description": "Credit receivable type: 1 - Mercantile, 2 - Service ",
            "examples": [
                1
            ]
        },
        "debtor_document_number": {
            "type": "string",
            "title": "Debtor document number",
            "description": "Debtor document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas F\u00edsicas number (Brazil).",
            "examples": [
                "10358728000143"
            ]
        },
        "debtor_name": {
            "type": "string",
            "title": "Debtor name",
            "description": "Debtor name",
            "examples": [
                "Hy Ball"
            ]
        },
        "face_value": {
            "type": "number",
            "title": "Face value",
            "description": "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
            ]
        },
        "holding_number": {
            "type": "string",
            "title": "Holding Number",
            "description": "Holding number - The invoice number  + '.' + the number of installments.",
            "examples": [
                "ABC.26"
            ]
        },
        "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
            ]
        },
        "internal_number": {
            "type": "string",
            "title": "Internal number",
            "description": "Client-assigned internal number used to manage credit rights receivable",
            "examples": [
                "56789012"
            ]
        },
        "invoice_number": {
            "type": "number",
            "title": "Invoice number",
            "description": "Invoice number.",
            "examples": [
                123456789
            ]
        },
        "invoice_serie": {
            "type": "number",
            "title": "Invoice serie",
            "description": "Invoice serie (series).",
            "examples": [
                2
            ]
        },
        "invoice_total_value": {
            "type": "number",
            "title": "Invoice total value",
            "description": "Invoice total value.",
            "format": "double",
            "examples": [
                1000.0
            ]
        },
        "issuing_date": {
            "type": "string",
            "title": "Issuing date",
            "description": "When client issued credit rights receivable",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "lender_document_number": {
            "type": "string",
            "title": "Lender document number",
            "description": "Lender document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas F\u00edsicas number (Brazil). ",
            "examples": [
                "10358728000143"
            ]
        },
        "lender_name": {
            "type": "string",
            "title": "Lender name",
            "description": "Name of lender",
            "examples": [
                "Ho Lee Smokes"
            ]
        },
        "maturity_date": {
            "type": "string",
            "title": "Issuing date",
            "description": "Credit rights receivable maturity date.",
            "format": "date",
            "examples": [
                "2022-12-01"
            ]
        },
        "message": {
            "type": "string",
            "title": "Error message",
            "description": "Message about failure to register a credit rights receivable.",
            "examples": [
                "credit rights receivable INTERNAL_NUMBER exceeded total amount value from invoice"
            ]
        },
        "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
            ]
        },
        "recorder_account": {
            "type": "number",
            "title": "Recorder account",
            "description": "Recorder account number.",
            "examples": [
                1
            ]
        },
        "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": "Issuing 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": "Guarantor name",
            "examples": [
                "Polly Ester"
            ]
        },
        "interop_holding_number": {
            "type": "string",
            "title": "Interop Holding Number",
            "description": "Credit rights receivable recurring code with letter",
            "examples": [
                "ABCY"
            ]
        },
        "lender_signing_date": {
            "type": "string",
            "title": "Lender signing date",
            "description": "Lender signing date",
            "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": [
                "Nick O'Thyme"
            ]
        }
    },
    "definitions": {
        "credit_operations": {
            "type": "object",
            "title": "Credit Operations",
            "description": "Payments linked to receivable.",
            "properties": {
                "operation_type": {
                    "type": "string",
                    "title": "Operation Type",
                    "description": "Operation type. You need to configure the 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 Value",
                    "description": "Operation amount value",
                    "format": "double",
                    "examples": [
                        10.0
                    ]
                },
                "guarantee_percentage": {
                    "type": "number",
                    "title": "Amount to Pay",
                    "description": "Operation percentage",
                    "format": "double",
                    "examples": [
                        1.0
                    ]
                }
            }
        }
    }
}

{
    "credit_rights_receivable_type": 1,
    "debtor_document_number": "10358728000143",
    "debtor_name": "Hy Ball",
    "face_value": 10.0,
    "holding_number": "ABC.26",
    "ibge_code": 1234567,
    "internal_number": "56789012",
    "invoice_number": 123456789,
    "invoice_serie": 2,
    "invoice_total_value": 1000.0,
    "issuing_date": "2020-12-01",
    "lender_document_number": "10358728000143",
    "lender_name": "Ho Lee Smokes",
    "maturity_date": "2022-12-01",
    "message": "credit rights receivable INTERNAL_NUMBER exceeded total amount value from invoice",
    "payment_method": 1,
    "payment_status": 1,
    "recorder_account": 1,
    "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": "Polly Ester",
    "interop_holding_number": "ABCY",
    "lender_signing_date": "2020-12-01",
    "owner_document_number": "10358728000143",
    "owner_name": "Nick O'Thyme"
}

Updated 4 days ago