Event structure and samples for Input Reports.
Note: Version 2 Webhooks can contain more that one event per webhook. Please see “V2 Webhook Structure” for more details.
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| created_at | datetime (ISO8601) | Date and time the record was created |
| edited_at | datetime (ISO8601) | Date and time the record was edited |
| created_by | string or null | String containing the created_by information, if set |
| edited_by | string or null | String containing the edited_by information, if set |
| event_id | string | The ID of the Event |
| event_source | string | The Source that triggered the event |
| event_type | string | This will be “input_report.create” |
| volume_serial_number | string | Serial number for the submitted file |
| service_user_number:id | string | Service User Number: ID of the record |
| service_user_number:sun_number | string | Service User Number: Number |
| service_user_number:sun_name | string | Service User Number: Name |
| produced_on_date | string | Date the report was produced. Formatted as “YYYY-MM-DD” |
| produced_on_time | string | Time the report was produced. formatted as “HH:MM:SS” |
| bacs_file:id | string | Bacs file: ID of the record |
| client:id | string | Client: ID of the record |
| credit_entry:accepted_records:number_of | string | Credit Entry: Accepted Records: Number of records |
| credit_entry:accepted_records:currency | string | Credit Entry: Accepted Records: Currency of records |
| credit_entry:accepted_records:value_of | string | Credit Entry: Accepted Records: Value of records |
| credit_entry:rejected_records:number_of | string | Credit Entry: Rejected Records: Number of records |
| credit_entry:rejected_records:currency | string | Credit Entry: Rejected Records: Currency of records |
| credit_entry:rejected_records:value_of | string | Credit Entry: Rejected Records: Value of records |
| credit_entry:user_trailer_totals:number_of | string | Credit Entry: User Trailer Totals: Number of records |
| credit_entry:user_trailer_totals:currency | string | Credit Entry: User Trailer Totals: Currency of records |
| credit_entry:user_trailer_totals:value_of | string | Credit Entry: User Trailer Totals: Value of records |
| credit_entry:adjustment_records:number_of | string | Credit Entry: Adjustment Records: Number of records |
| credit_entry:adjustment_records:currency | string | Credit Entry: Adjustment Records: Currency of records |
| credit_entry:adjustment_records:value_of | string | Credit Entry: Adjustment Records: Value of records |
| debit_entry:accepted_records:number_of | string | Debit Entry: Accepted Records: Number of records |
| debit_entry:accepted_records:currency | string | Debit Entry: Accepted Records: Currency of records |
| debit_entry:accepted_records:value_of | string | Debit Entry: Accepted Records: Value of records |
| debit_entry:rejected_records:number_of | string | Debit Entry: Rejected Records: Number of records |
| debit_entry:rejected_records:currency | string | Debit Entry: Rejected Records: Currency of records |
| debit_entry:rejected_records:value_of | string | Debit Entry: Rejected Records: Value of records |
| debit_entry:user_trailer_totals:number_of | string | Debit Entry: User Trailer Totals: Number of records |
| debit_entry:user_trailer_totals:currency | string | Debit Entry: User Trailer Totals: Currency of records |
| debit_entry:user_trailer_totals:value_of | string | Debit Entry: User Trailer Totals: Value of records |
| debit_entry:adjustment_records:number_of | string | Debit Entry: Adjustment Records: Number of records |
| debit_entry:adjustment_records:currency | string | Debit Entry: Adjustment Records: Currency of records |
| debit_entry:adjustment_records:value_of | string | Debit Entry: Adjustment Records: Value of records |
| account_totals:created_at | datetime (ISO8601) | Date and time the record was created |
| account_totals:edited_at | datetime (ISO8601) | Date and time the record was edited |
| account_totals:created_by | string or null | String containing the created_by information, if set |
| account_totals:edited_by | string or null | String containing the edited_by information, if set |
| account_totals:id | string | Account Totals: ID of the record |
| account_totals:originating_bank_account:id | string | Account Totals: Originating Bank Account: ID of the record |
| account_totals:originating_bank_account:legacy_id | string | Account Totals: Originating Bank Account: Legacy ID of the record, if set |
| account_totals:originating_bank_account:account_name | string | Account Totals: Originating Bank Account: Account Name |
| account_totals:originating_bank_account:account_number | string | Account Totals: Originating Bank Account: Account Number |
| account_totals:originating_bank_account:sort_code | string | Account Totals: Originating Bank Account: Sort Code |
| account_totals:credit_entry:accepted_records:number_of | string | Account Totals: Credit Entry: Accepted Records: Number of records |
| account_totals:credit_entry:accepted_records:currency | string | Account Totals: Credit Entry: Accepted Records: Currency of records |
| account_totals:credit_entry:accepted_records:value_of | string | Account Totals: Credit Entry: Accepted Records: Value of records |
| account_totals:credit_entry:rejected_records:number_of | string | Account Totals: Credit Entry: Rejected Records: Number of records |
| account_totals:credit_entry:rejected_records:currency | string | Account Totals: Credit Entry: Rejected Records: Currency of records |
| account_totals:credit_entry:rejected_records:value_of | string | Account Totals: Credit Entry: Rejected Records: Value of records |
| account_totals:credit_entry:total_records:number_of | string | Account Totals: Credit Entry: Total Records: Number of records |
| account_totals:credit_entry:total_records:currency | string | Account Totals: Credit Entry: Total Records: Currency of records |
| account_totals:credit_entry:total_records:value_of | string | Account Totals: Credit Entry: Total Records: Value of records |
| account_totals:debit_entry:accepted_records:number_of | string | Account Totals: Debit Entry: Accepted Records: Number of records |
| account_totals:debit_entry:accepted_records:currency | string | Account Totals: Debit Entry: Accepted Records: Currency of records |
| account_totals:debit_entry:accepted_records:value_of | string | Account Totals: Debit Entry: Accepted Records: Value of records |
| account_totals:debit_entry:rejected_records:number_of | string | Account Totals: Debit Entry: Rejected Records: Number of records |
| account_totals:debit_entry:rejected_records:currency | string | Account Totals: Debit Entry: Rejected Records: Currency of records |
| account_totals:debit_entry:rejected_records:value_of | string | Account Totals: Debit Entry: Rejected Records: Value of records |
| account_totals:debit_entry:total_records:number_of | string | Account Totals: Debit Entry: Total Records: Number of records |
| account_totals:debit_entry:total_records:currency | string | Account Totals: Debit Entry: Total Records: Currency of records |
| account_totals:debit_entry:total_records:value_of | string | Account Totals: Debit Entry: Total Records: Value of records |
| account_totals:credit_contra_entry:accepted_records:number_of | string | Account Totals: Credit Contra Entry: Accepted Records: Number of records |
| account_totals:credit_contra_entry:accepted_records:currency | string | Account Totals: Credit Contra Entry: Accepted Records: Currency of records |
| account_totals:credit_contra_entry:accepted_records:value_of | string | Account Totals: Credit Contra Entry: Accepted Records: Value of records |
| account_totals:credit_contra_entry:rejected_records:number_of | string | Account Totals: Credit Contra Entry: Rejected Records: Number of records |
| account_totals:credit_contra_entry:rejected_records:currency | string | Account Totals: Credit Contra Entry: Rejected Records: Currency of records |
| account_totals:credit_contra_entry:rejected_records:value_of | string | Account Totals: Credit Contra Entry: Rejected Records: Value of records |
| account_totals:credit_contra_entry:total_records:number_of | string | Account Totals: Credit Contra Entry: Total Records: Number of records |
| account_totals:credit_contra_entry:total_records:currency | string | Account Totals: Credit Contra Entry: Total Records: Currency of records |
| account_totals:credit_contra_entry:total_records:value_of | string | Account Totals: Credit Contra Entry: Total Records: Value of records |
| account_totals:debit_contra_entry:accepted_records:number_of | string | Account Totals: Debit Contra Entry: Accepted Records: Number of records |
| account_totals:debit_contra_entry:accepted_records:currency | string | Account Totals: Debit Contra Entry: Accepted Records: Currency of records |
| account_totals:debit_contra_entry:accepted_records:value_of | string | Account Totals: Debit Contra Entry: Accepted Records: Value of records |
| account_totals:debit_contra_entry:rejected_records:number_of | string | Account Totals: Debit Contra Entry: Rejected Records: Number of records |
| account_totals:debit_contra_entry:rejected_records:currency | string | Account Totals: Debit Contra Entry: Rejected Records: Currency of records |
| account_totals:debit_contra_entry:rejected_records:value_of | string | Account Totals: Debit Contra Entry: Rejected Records: Value of records |
| account_totals:debit_contra_entry:total_records:number_of | string | Account Totals: Debit Contra Entry: Total Records: Number of records |
| account_totals:debit_contra_entry:total_records:currency | string | Account Totals: Debit Contra Entry: Total Records: Currency of records |
| account_totals:debit_contra_entry:total_records:value_of | string | Account Totals: Debit Contra Entry: Total Records: Value of records |
{
"id": {VALUE},
"idempotency_key": {VALUE},
"sent_at": {VALUE},
"client": {
"id": {VALUE}
},
"events": [
{
"id": {VALUE},
"created_at": {VALUE},
"edited_at": {VALUE},
"created_by": {VALUE},
"edited_by": {VALUE},
"event_id": {VALUE},
"event_source": {VALUE},
"event_type": {VALUE},
"volume_serial_number": {VALUE},
"service_user_number": {
"id": {VALUE},
"sun_number": {VALUE},
"sun_name": {VALUE}
},
"produced_on_date": {VALUE},
"produced_on_time": {VALUE},
"bacs_file": {
"id": {VALUE}
},
"client": {
"id": {VALUE}
},
"credit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"user_trailer_totals": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"adjustment_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"user_trailer_totals": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"adjustment_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"account_totals": [
{
"created_at": {VALUE},
"edited_at": {VALUE},
"created_by": {VALUE},
"edited_by": {VALUE},
"id": {VALUE},
"originating_bank_account": {
"id": {VALUE},
"legacy_id": {VALUE},
"account_name": {VALUE},
"account_number": {VALUE},
"sort_code": {VALUE}
},
"credit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"credit_contra_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_contra_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
}
}
]
}
]
}
Note: Property display order for documentation purposes, actual order may vary.
Note: Property display order for documentation purposes, actual order may vary.
Input Report Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| id | “IR011Q7ZGLJLYQ8W53EO” |
| created_at | “2024-04-26T11:10:00Z” |
| edited_at | “2024-04-26T11:10:00Z” |
| created_by | null |
| edited_by | null |
| event_id | “HI09LG420EJ9RD81VQWR” |
| event_source | “DDMS Service” |
| event_type | “input_report.create” |
| volume_serial_number | “JV3WK8” |
| service_user_number:id | “SN019LVZMGJ2KD8K46WE” |
| service_user_number:sun_number | “123456” |
| service_user_number:sun_name | “Smarterpay Test” |
| produced_on_date | “2024-04-26” |
| produced_on_time | “10:00:51” |
| bacs_file:id | “FS01LVZMGJ2XOZPK46WE” |
| client:id | “CL01LG420EJ9DP1VQWR9” |
| credit_entry:accepted_records:number_of | “1” |
| credit_entry:accepted_records:currency | “GBP” |
| credit_entry:accepted_records:value_of | “11662” |
| credit_entry:rejected_records:number_of | “0” |
| credit_entry:rejected_records:currency | “GBP” |
| credit_entry:rejected_records:value_of | “0” |
| credit_entry:user_trailer_totals:number_of | “1” |
| credit_entry:user_trailer_totals:currency | “GBP” |
| credit_entry:user_trailer_totals:value_of | “11662” |
| credit_entry:adjustment_records:number_of | “0” |
| credit_entry:adjustment_records:currency | “GBP” |
| credit_entry:adjustment_records:value_of | “0” |
| debit_entry:accepted_records:number_of | “2” |
| debit_entry:accepted_records:currency | “GBP” |
| debit_entry:accepted_records:value_of | “11662” |
| debit_entry:rejected_records:number_of | “0” |
| debit_entry:rejected_records:currency | “GBP” |
| debit_entry:rejected_records:value_of | “0” |
| debit_entry:user_trailer_totals:number_of | “2” |
| debit_entry:user_trailer_totals:currency | “GBP” |
| debit_entry:user_trailer_totals:value_of | “11662” |
| debit_entry:adjustment_records:number_of | “0” |
| debit_entry:adjustment_records:currency | “GBP” |
| debit_entry:adjustment_records:value_of | “0” |
| account_totals:created_at | “2024-04-26T12:10:00Z” |
| account_totals:edited_at | “2024-04-26T12:10:00Z” |
| account_totals:created_by | null |
| account_totals:edited_by | null |
| account_totals:id | “AT012WZQ0583EY86KNOE” |
| account_totals:originating_bank_account:id | “OB01O6YQRDJZWJVL359M” |
| account_totals:originating_bank_account:legacy_id | “CBA-0000002” |
| account_totals:originating_bank_account:account_name | “CBA - FTB - 01” |
| account_totals:originating_bank_account:account_number | “*645” |
| account_totals:originating_bank_account:sort_code | “00” |
| account_totals:credit_entry:accepted_records:number_of | “0” |
| account_totals:credit_entry:accepted_records:currency | “GBP” |
| account_totals:credit_entry:accepted_records:value_of | “0” |
| account_totals:credit_entry:rejected_records:number_of | “0” |
| account_totals:credit_entry:rejected_records:currency | “GBP” |
| account_totals:credit_entry:rejected_records:value_of | “0” |
| account_totals:credit_entry:total_records:number_of | “0” |
| account_totals:credit_entry:total_records:currency | “GBP” |
| account_totals:credit_entry:total_records:value_of | “0” |
| account_totals:debit_entry:accepted_records:number_of | “2” |
| account_totals:debit_entry:accepted_records:currency | “GBP” |
| account_totals:debit_entry:accepted_records:value_of | “11662” |
| account_totals:debit_entry:rejected_records:number_of | “0” |
| account_totals:debit_entry:rejected_records:currency | “GBP” |
| account_totals:debit_entry:rejected_records:value_of | “0” |
| account_totals:debit_entry:total_records:number_of | “2” |
| account_totals:debit_entry:total_records:currency | “GBP” |
| account_totals:debit_entry:total_records:value_of | “11662” |
| account_totals:credit_contra_entry:accepted_records:number_of | “0” |
| account_totals:credit_contra_entry:accepted_records:currency | “GBP” |
| account_totals:credit_contra_entry:accepted_records:value_of | “0” |
| account_totals:credit_contra_entry:rejected_records:number_of | “0” |
| account_totals:credit_contra_entry:rejected_records:currency | “GBP” |
| account_totals:credit_contra_entry:rejected_records:value_of | “0” |
| account_totals:credit_contra_entry:total_records:number_of | “0” |
| account_totals:credit_contra_entry:total_records:currency | “GBP” |
| account_totals:credit_contra_entry:total_records:value_of | “0” |
| account_totals:debit_contra_entry:accepted_records:number_of | “1” |
| account_totals:debit_contra_entry:accepted_records:currency | “GBP” |
| account_totals:debit_contra_entry:accepted_records:value_of | “11662” |
| account_totals:debit_contra_entry:rejected_records:number_of | “0” |
| account_totals:debit_contra_entry:rejected_records:currency | “GBP” |
| account_totals:debit_contra_entry:rejected_records:value_of | “0” |
| account_totals:debit_contra_entry:total_records:number_of | “1” |
| account_totals:debit_contra_entry:total_records:currency | “GBP” |
| account_totals:debit_contra_entry:total_records:value_of | “11662” |
{
"id": {VALUE},
"idempotency_key": {VALUE},
"sent_at": {VALUE},
"client": {
"id": {VALUE}
},
"events": [
{
"id": {VALUE},
"created_at": {VALUE},
"edited_at": {VALUE},
"created_by": {VALUE},
"edited_by": {VALUE},
"event_id": {VALUE},
"event_source": {VALUE},
"event_type": {VALUE},
"volume_serial_number": {VALUE},
"service_user_number": {
"id": {VALUE},
"sun_number": {VALUE},
"sun_name": {VALUE}
},
"produced_on_date": {VALUE},
"produced_on_time": {VALUE},
"bacs_file": {
"id": {VALUE}
},
"client": {
"id": {VALUE}
},
"credit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"user_trailer_totals": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"adjustment_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"user_trailer_totals": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"adjustment_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"account_totals": [
{
"created_at": {VALUE},
"edited_at": {VALUE},
"created_by": {VALUE},
"edited_by": {VALUE},
"id": {VALUE},
"originating_bank_account": {
"id": {VALUE},
"legacy_id": {VALUE},
"account_name": {VALUE},
"account_number": {VALUE},
"sort_code": {VALUE}
},
"credit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"credit_contra_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
},
"debit_contra_entry": {
"accepted_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"rejected_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
},
"total_records": {
"number_of": {VALUE},
"currency": {VALUE},
"value_of": {VALUE}
}
}
}
]
}
]
}
Note: Property display order for documentation purposes, actual order may vary.