Accrual migration started
Event generated when an accrual migration is started. Contains the payload with the data to be migrated.
Type: object
Additional properties: true
Domain: migration
Event: accrual_incoming
Version: 1
origin required
Description: This field identifies the source of the event: FILE/API
Type: string
Must be one of the following:
FILE
API
Example:
FILE
file_name required
Description: This field identifies the name file.
Type: string or null
Example:
pismo.csv
null
file_size required
Description: This field identifies the size file.
Type: integer or null
Example:
999
null
file_id required
Description: This field is the unique identifier of the file that originated the event (can be null when origin is API).
Type: string or null
Example:
5832868-ca4d-475f-888b-02bb44f84d19
null
line_number required
Description: This field identifies the line of the file that originated the event (can be 0 when origin is API).
Type: integer
Example:
null
2
11
entity required
Description: This field represents an accrual.
Type: object
Additional properties: true
Example:{ "migration": { "id": "0000002484919082021-12-14", "version_date": "2021-12-14T12:30:40Z", "account_id": "000000248491908", "authorization_id": "000000-24849-19082022" }, "org_id": "TN_c642ca23-4ea8-4218-a00d-8331a496253c", "cid": "4588d1ec-0b8e-4ac0-8578-a8c79f8f682e", "file_id": "1", "type": "1", "flag": "1", "authorization_type": "PLATFORM", "accounting_date": "2022-04-20", "accruals": [ { "type": "IOF", "amount": 0.423187, "interest_rate": 0.0 }, { "type": "REFINANCING", "amount": 14.7, "interest_rate": 0.0 }, { "type": "OVERDUE", "amount": 1.03, "interest_rate": 0.0 }, { "type": "FINE", "amount": 4.58, "interest_rate": 0.0 } ], "metadata": { "balanceIof": "0000000000000", "customerAccountId": "0004002479013933093", "customerOrgId": "004", "planCode": "00000", "planSequence": "000", "reference": "00000000000000000000000" } }migration required
Description: This field contains the data that identifies a migration.
Type: object
Additional properties: false
Example:{ "id": "0000002484919082021-12-14", "version_date": "2021-12-14T12:30:40Z", "account_id": "000000248491908", "authorization_id": "000000-24849-19082022" }id required
Description: This field is the unique identifier of migration.
Type: string
Example:
accrual-external-01version_date required
Description: This field is the date of version of migration.
Type: string
Format: date-time
Example:
2021-08-27T16:45:07.750936Zaccount_id required
Description: This field identifies the external account the accrual belongs to.
Type: string
Example:
account-external-01authorization_id required
Description: This field identifies the external authorization the accrual belongs to.
Type: string
Example:
account-external-01org_id required
Description: Internal identifier of the client organization registered into the platform.
Type: string
Example:
TN_c642ca23-4ea8-4218-a00d-8331a496253ccid required
Description: This field identifies a file processing or an API request.
Type: string
Format: uuid
Example:
9be0486e-073a-4f56-80bb-5c400337e721file_id required
Description: This field is the unique identifier of the file that originated the event (can be null when origin is API).
Type: string or null
Example:
5832868-ca4d-475f-888b-02bb44f84d19
nulltype required
Description: This field identifies the type of accrual.
Type: string
Example:
1
2
3flag required
Description: This field whether the accrual should be sent to balance (1/true) or not (0/false).
Type: string or boolean
Example:
0
1
true
falseauthorization_type required
Description: If the accrual of the transaction comes from a network (e.g.: VISA, MASTERCARD) then it should be NETWORK. If the accrual of the transaction comes from an internal process then it should be PLATFORM
Type: string
Must be one of the following:
PLATFORM
NETWORK
Example:
PLATFORM
NETWORKaccounting_date required
Description: This field identifies the accounting_date of accrual.
Type: string
Format: date
Example:
2022-04-20accruals required
metadata required
Description: This field contains others accrual information.
Type: object
Additional properties: true
Example:{ "balanceIof": "0000000000000", "customerAccountId": "0004002479013933093", "customerOrgId": "004", "planCode": "00000", "planSequence": "000", "reference": "00000000000000000000000" }
{
"$schema": "https://json-schema.org/draft-07/schema",
"$id": "https://pismo.io/events/migration/accrual_incoming-1.json",
"type": "object",
"title": "Accrual migration started",
"description": "Event generated when an accrual migration is started. Contains the payload with the data to be migrated.",
"examples": [
{
"origin": "FILE",
"file_name": "pismo.csv",
"file_size": 999,
"file_id": "1",
"line_number": 1,
"entity": {
"migration": {
"id": "0000002484919082021-12-14",
"version_date": "2021-12-14T12:30:40Z",
"account_id": "000000248491908",
"authorization_id": "000000-24849-19082022"
},
"org_id": "TN_c642ca23-4ea8-4218-a00d-8331a496253c",
"authorization_type": "PLATFORM",
"cid": "4588d1ec-0b8e-4ac0-8578-a8c79f8f682e",
"file_id": "1",
"type": "1",
"flag": "1",
"accounting_date": "2022-04-20",
"accruals": [
{
"type": "IOF",
"amount": 0.423187,
"interest_rate": 0.0
},
{
"type": "REFINANCING",
"amount": 14.7,
"interest_rate": 0.0
},
{
"type": "OVERDUE",
"amount": 1.03,
"interest_rate": 0.0
},
{
"type": "FINE",
"amount": 4.58,
"interest_rate": 0.0
}
],
"metadata": {
"balanceIof": "0000000000000",
"customerAccountId": "0004002479013933093",
"customerOrgId": "004",
"planCode": "00000",
"planSequence": "000",
"reference": "00000000000000000000000"
}
}
}
],
"required": [
"origin",
"file_name",
"file_size",
"file_id",
"line_number",
"entity"
],
"properties": {
"origin": {
"$id": "#/properties/origin",
"type": "string",
"description": "This field identifies the source of the event: FILE/API",
"enum": [
"FILE",
"API"
],
"examples": [
"FILE"
]
},
"file_name": {
"$id": "#/properties/file_name",
"type": [
"string",
"null"
],
"description": "This field identifies the name file.",
"examples": [
"pismo.csv",
null
]
},
"file_size": {
"$id": "#/properties/file_size",
"type": [
"integer",
"null"
],
"description": "This field identifies the size file.",
"examples": [
999,
null
]
},
"file_id": {
"$id": "#/properties/file_id",
"type": [
"string",
"null"
],
"description": "This field is the unique identifier of the file that originated the event (can be null when origin is API).",
"examples": [
"5832868-ca4d-475f-888b-02bb44f84d19",
null
]
},
"line_number": {
"$id": "#/properties/line_number",
"type": "integer",
"description": "This field identifies the line of the file that originated the event (can be 0 when origin is API).",
"examples": [
0,
2,
11
]
},
"entity": {
"$id": "#/properties/entity",
"type": "object",
"description": "This field represents an accrual.",
"examples": [
{
"migration": {
"id": "0000002484919082021-12-14",
"version_date": "2021-12-14T12:30:40Z",
"account_id": "000000248491908",
"authorization_id": "000000-24849-19082022"
},
"org_id": "TN_c642ca23-4ea8-4218-a00d-8331a496253c",
"cid": "4588d1ec-0b8e-4ac0-8578-a8c79f8f682e",
"file_id": "1",
"type": "1",
"flag": "1",
"authorization_type": "PLATFORM",
"accounting_date": "2022-04-20",
"accruals": [
{
"type": "IOF",
"amount": 0.423187,
"interest_rate": 0.0
},
{
"type": "REFINANCING",
"amount": 14.7,
"interest_rate": 0.0
},
{
"type": "OVERDUE",
"amount": 1.03,
"interest_rate": 0.0
},
{
"type": "FINE",
"amount": 4.58,
"interest_rate": 0.0
}
],
"metadata": {
"balanceIof": "0000000000000",
"customerAccountId": "0004002479013933093",
"customerOrgId": "004",
"planCode": "00000",
"planSequence": "000",
"reference": "00000000000000000000000"
}
}
],
"required": [
"migration",
"org_id",
"cid",
"file_id",
"type",
"flag",
"accounting_date",
"accruals",
"metadata",
"authorization_type"
],
"properties": {
"migration": {
"$id": "#/properties/entity/properties/migration",
"type": "object",
"description": "This field contains the data that identifies a migration.",
"examples": [
{
"id": "0000002484919082021-12-14",
"version_date": "2021-12-14T12:30:40Z",
"account_id": "000000248491908",
"authorization_id": "000000-24849-19082022"
}
],
"required": [
"id",
"version_date",
"account_id",
"authorization_id"
],
"properties": {
"id": {
"$id": "#/properties/entity/properties/migration/properties/id",
"type": "string",
"description": "This field is the unique identifier of migration.",
"examples": [
"accrual-external-01"
]
},
"version_date": {
"$id": "#/properties/entity/properties/migration/properties/version_date",
"type": "string",
"format": "date-time",
"description": "This field is the date of version of migration.",
"examples": [
"2021-08-27T16:45:07.750936Z"
]
},
"account_id": {
"$id": "#/properties/entity/properties/migration/properties/account_id",
"type": "string",
"description": "This field identifies the external account the accrual belongs to.",
"examples": [
"account-external-01"
]
},
"authorization_id": {
"$id": "#/properties/entity/properties/migration/properties/authorization_id",
"type": "string",
"description": "This field identifies the external authorization the accrual belongs to.",
"examples": [
"account-external-01"
]
}
},
"additionalProperties": false
},
"org_id": {
"$id": "#/properties/entity/properties/org_id",
"type": "string",
"description": "Internal identifier of the client organization registered into the platform.",
"examples": [
"TN_c642ca23-4ea8-4218-a00d-8331a496253c"
]
},
"cid": {
"$id": "#/properties/entity/properties/cid",
"type": "string",
"format": "uuid",
"description": "This field identifies a file processing or an API request.",
"examples": [
"9be0486e-073a-4f56-80bb-5c400337e721"
]
},
"file_id": {
"$id": "#/properties/entity/properties/file_id",
"type": [
"string",
"null"
],
"description": "This field is the unique identifier of the file that originated the event (can be null when origin is API).",
"examples": [
"5832868-ca4d-475f-888b-02bb44f84d19",
null
]
},
"type": {
"$id": "#/properties/entity/properties/type",
"type": "string",
"description": "This field identifies the type of accrual.",
"examples": [
"1",
"2",
"3"
]
},
"flag": {
"$id": "#/properties/entity/properties/flag",
"type": [
"string",
"boolean"
],
"pattern": "[01]",
"description": "This field whether the accrual should be sent to balance (1/true) or not (0/false).",
"examples": [
"0",
"1",
true,
false
]
},
"authorization_type": {
"$id": "#/properties/entity/properties/authorization_type",
"type": "string",
"enum": [
"PLATFORM",
"NETWORK"
],
"description": "If the accrual of the transaction comes from a network (e.g.: VISA, MASTERCARD) then it should be NETWORK. If the accrual of the transaction comes from an internal process then it should be PLATFORM",
"examples": [
"PLATFORM",
"NETWORK"
]
},
"accounting_date": {
"$id": "#/properties/entity/properties/accounting_date",
"type": "string",
"description": "This field identifies the accounting_date of accrual.",
"format": "date",
"examples": [
"2022-04-20"
]
},
"accruals": {
"$id": "#/properties/entity/properties/accruals",
"type": "array",
"description": "This field contains the values of accrual.",
"examples": [
[
{
"type": "IOF",
"amount": 0.423187,
"interest_rate": 0.0
},
{
"type": "REFINANCING",
"amount": 14.7,
"interest_rate": 0.0
}
]
],
"additionalItems": true,
"items": {
"$id": "#/properties/entity/properties/accruals/items",
"anyOf": [
{
"$id": "#/properties/entity/properties/accruals/items/anyOf/0",
"type": "object",
"examples": [
{
"type": "IOF",
"amount": 0.423187,
"interest_rate": 0.0
}
],
"required": [
"type",
"amount",
"interest_rate"
],
"properties": {
"type": {
"$id": "#/properties/entity/properties/accruals/items/anyOf/0/properties/type",
"type": "string",
"description": "This field identifies the type of value.",
"enum": [
"REFINANCING",
"IOF",
"OVERDUE",
"FINE"
],
"examples": [
"IOF",
"OVERDUE"
]
},
"amount": {
"$id": "#/properties/entity/properties/accruals/items/anyOf/0/properties/amount",
"type": "number",
"description": "This field identifies the amount of value.",
"examples": [
0.423187
]
},
"interest_rate": {
"$id": "#/properties/entity/properties/accruals/items/anyOf/0/properties/interest_rate",
"type": "number",
"description": "This field identifies the interest rate of value.",
"examples": [
0.0
]
}
},
"additionalProperties": false
}
]
}
},
"metadata": {
"$id": "#/properties/entity/properties/metadata",
"type": "object",
"description": "This field contains others accrual information.",
"default": {},
"examples": [
{
"balanceIof": "0000000000000",
"customerAccountId": "0004002479013933093",
"customerOrgId": "004",
"planCode": "00000",
"planSequence": "000",
"reference": "00000000000000000000000"
}
],
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
{
"origin": "FILE",
"file_name": "pismo.csv",
"file_size": 999,
"file_id": "1",
"line_number": 1,
"entity": {
"migration": {
"id": "0000002484919082021-12-14",
"version_date": "2021-12-14T12:30:40Z",
"account_id": "000000248491908",
"authorization_id": "000000-24849-19082022"
},
"org_id": "TN_c642ca23-4ea8-4218-a00d-8331a496253c",
"authorization_type": "PLATFORM",
"cid": "4588d1ec-0b8e-4ac0-8578-a8c79f8f682e",
"file_id": "1",
"type": "1",
"flag": "1",
"accounting_date": "2022-04-20",
"accruals": [
{
"type": "IOF",
"amount": 0.423187,
"interest_rate": 0.0
},
{
"type": "REFINANCING",
"amount": 14.7,
"interest_rate": 0.0
},
{
"type": "OVERDUE",
"amount": 1.03,
"interest_rate": 0.0
},
{
"type": "FINE",
"amount": 4.58,
"interest_rate": 0.0
}
],
"metadata": {
"balanceIof": "0000000000000",
"customerAccountId": "0004002479013933093",
"customerOrgId": "004",
"planCode": "00000",
"planSequence": "000",
"reference": "00000000000000000000000"
}
}
}
Updated 13 days ago