External accounting entry created
Type: object
Domain: audit
Event: external_entry
Version: 1
method required
Title: Method
Description: The operation HTTP method
Type: string
Example:
POST
uri required
Title: URI
Description: The API operation URI
Type: string
Example:
/v1/accounting-entry
Title: E-mail
Description: The operator email
Type: string or null
Example:
[email protected]
roles
Title: Roles
Description: The operator roles
Type: array or null
Example:[ "backoffice-operator", "crm-operator", "treasury-operator" ]
tracking_id required
Title: Tracking ID
Description: Tracking ID of AccountingEntry
Type: string or null
Example:
75f845de-b135-4cbf-8498-7d76aaa3a29a
created_at
Title: Created At
Description: Creation date and time in ISO 8601
Type: string or null
Example:
2019-09-16T18:57:30
object required
Title: Object
Description: The audit data message
Type: object or nulltransaction_id
Description: Transaction id of the accountingEntry
Type: integer or null
Example:
15335085account_id
Description: Account id of the accountingEntry
Type: integer or null
Example:
1000001event_date required
Title: Event date
Description: The event date
Type: string
Example:
2019-09-16amount required
Description: Total amount of the accounting entry
Type: number
Example:
240.48program_id required
Description: Program id of the accountingEntry
Type: integer
Example:
252debit_account required
Description: Debit account of the accountingEntry
Type: string
Example:
1000002credit_account required
Description: Credit account of the accountingEntry
Type: string
Example:
1000003entry_type_id required
Description: Entry type of the accountingEntry
Type: integer
Example:
999tracking_id required
Description: A unique 36 character long identification for the operation.
Type: string
Example:
6af8d777-5c18-4fd3-8018-665cc792bfa6
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "External accounting entry created",
"required": [
"method",
"uri",
"tracking_id",
"object"
],
"properties": {
"method": {
"type": "string",
"title": "Method",
"description": "The operation HTTP method",
"examples": [
"POST"
]
},
"uri": {
"type": "string",
"title": "URI",
"description": "The API operation URI",
"examples": [
"/v1/accounting-entry"
]
},
"email": {
"type": [
"string",
"null"
],
"title": "E-mail",
"description": "The operator email",
"examples": [
"[email protected]"
]
},
"roles": {
"type": [
"array",
"null"
],
"title": "Roles",
"description": "The operator roles",
"items": {
"type": "string",
"title": "Itens",
"description": "The roles",
"examples": [
"backoffice-operator",
"crm-operator",
"treasury-operator"
]
}
},
"tracking_id": {
"type": [
"string",
"null"
],
"title": "Tracking ID",
"description": "Tracking ID of AccountingEntry",
"examples": [
"75f845de-b135-4cbf-8498-7d76aaa3a29a"
]
},
"created_at": {
"type": [
"string",
"null"
],
"title": "Created At",
"description": "Creation date and time in ISO 8601",
"examples": [
"2019-09-16T18:57:30"
]
},
"object": {
"type": [
"object",
"null"
],
"title": "Object",
"description": "The audit data message",
"required": [
"event_date",
"program_id",
"amount",
"debit_account",
"credit_account",
"entry_type_id",
"tracking_id"
],
"properties": {
"transaction_id": {
"type": [
"integer",
"null"
],
"description": "Transaction id of the accountingEntry",
"examples": [
15335085
]
},
"account_id": {
"type": [
"integer",
"null"
],
"description": "Account id of the accountingEntry",
"examples": [
1000001
]
},
"event_date": {
"type": "string",
"title": "Event date",
"description": "The event date",
"examples": [
"2019-09-16"
]
},
"amount": {
"type": "number",
"description": "Total amount of the accounting entry",
"examples": [
240.48
]
},
"program_id": {
"type": "integer",
"description": "Program id of the accountingEntry",
"examples": [
252
]
},
"debit_account": {
"type": "string",
"description": "Debit account of the accountingEntry",
"examples": [
1000002
]
},
"credit_account": {
"type": "string",
"description": "Credit account of the accountingEntry",
"examples": [
1000003
]
},
"entry_type_id": {
"type": "integer",
"description": "Entry type of the accountingEntry",
"examples": [
999
]
},
"tracking_id": {
"type": "string",
"description": "A unique 36 character long identification for the operation.",
"examples": [
"6af8d777-5c18-4fd3-8018-665cc792bfa6"
]
}
}
}
}
}
{
"method": "POST",
"uri": "/v1/accounting-entry",
"email": "[email protected]",
"roles": [
"backoffice-operator",
"crm-operator",
"treasury-operator"
],
"tracking_id": "75f845de-b135-4cbf-8498-7d76aaa3a29a",
"created_at": "2019-09-16T18:57:30",
"object": {
"transaction_id": 15335085,
"account_id": 1000001,
"event_date": "2019-09-16",
"amount": 240.48,
"program_id": 252,
"debit_account": 1000002,
"credit_account": 1000003,
"entry_type_id": 999,
"tracking_id": "6af8d777-5c18-4fd3-8018-665cc792bfa6"
}
}
Updated about 2 months ago