post
https://api.zenoti.com//v1/reports/membership_tries/flat_file?page=&size=
This API retrieves a flat-file report of membership recurring invoice collection tries with detailed try status, payment information, and decline details. Supports filtering by centers, date ranges, invoice statuses, try statuses, recurring statuses, payment types, days pending buckets, and grouping columns. Results are paginated.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Details
MembershipTriesReportRequest
| JSON Property | Data Type | Description |
|---|---|---|
| centers | MultiGuidFilterRequestModel | List of center IDs to filter the report. |
| date_type | ReportTriesDateType | Date type filter. |
| invoice_statuses | List | List of current invoice statuses to filter. |
| try_statuses | List | List of try statuses to filter. |
| recurring_statuses | List | List of recurring statuses to filter. |
| payment_type | List | List of payment types to filter. |
| days_pending_bucket | List | List of days pending bucket values. |
| try_start_date | DateTime | Try date range start. |
| try_end_date | DateTime | Try date range end. |
| group_columns | List | List of group columns for grouping. |
| guest_id | Guid | Guest ID filter for group expansion. |
| membership_id | Guid | Membership ID filter for group expansion. |
| invoice_status_id | ScheduledCollectionStatus | Invoice status filter for group expansion. |
| try_status_id | ReportTryStatus | Try status filter for group expansion. |
| membership_status_id | ReportMembershipStatus | Membership status filter for group expansion. |
| recurring_status_id | ReportMembershipRecurrenceStatus | Recurring status filter for group expansion. |
| invoice_type | string | Invoice type filter. |
| collection_type | string | Collection type filter. |
| try_method | string | Try method filter. |
| type_of_decline | TypeOfDeclineEnum | Type of decline filter. |
| what_payment_method_used | string | Payment method used filter. |
| primary_payment_type | string | Primary payment type filter. |
| primary_payment_method | string | Primary payment method filter. |
| backup_payment_type | string | Backup payment type filter. |
| backup_payment_method | string | Backup payment method filter. |
| guest_gender | string | Guest gender filter. |
| guest_code | string | Guest code filter. |
| member_code | string | Member code filter. |
| invoice_number | string | Invoice number filter. |
| try_number | string | Try number filter. |
| try_date | string | Try date filter. |
| original_scheduled_date | string | Original scheduled date filter. |
| payment_method_type | string | Payment method type filter. |
| payment_method_used | string | Payment method used filter. |
| employee_id | Guid | Employee ID filter. |
| decline_reason | string | Decline reason filter. |
| decline_fee_charged | string | Decline fee charged filter. |
| remaining_retry_attempts | string | Remaining retry attempts filter. |
MembershipTriesReportResponse
| JSON Property | Data Type | Description |
|---|---|---|
| membership_tries | List | List of membership tries report records. |
| total | MembershipTriesTotal | Summary totals for the report. |
| pagination | PaginationResponseModel | Pagination details. |
| error | APIV2ErrorModel | Error information if the request fails. |
MembershipTriesItem
| JSON Property | Data Type | Description |
|---|---|---|
| center_name | string | Center name. |
| invoice_number | string | Invoice number. |
| try_number | string | Try number. |
| try_date | DateTime | Date and time of the try. |
| try_status | string | Try status. |
| current_invoice_status | string | Current invoice status. |
| guest_name | string | Guest name. |
| guest_gender | string | Guest gender. |
| membership_name | string | Membership name. |
| primary_payment_type | string | Primary payment type. |
| primary_payment_method | string | Primary payment method. |
| backup_payment_type | string | Backup payment type. |
| backup_payment_method | string | Backup payment method. |
| membership_status | string | Membership status. |
| current_recurring_status | string | Current recurring status. |
| original_scheduled_date | DateTime | Original scheduled date. |
| amount_to_be_paid | decimal | Amount to be paid. |
| payment_method_used | string | Payment method used. |
| payment_method_type | string | Payment method type. |
| try_method | string | Try method. |
| employee_name | string | Employee name. |
| collection_type | string | Collection type. |
| invoice_type | string | Invoice type. |
| what_payment_method_used | string | Payment method category used. |
| decline_reason | string | Decline reason. |
| type_of_decline | TypeOfDeclineEnum | Type of decline. |
| decline_fee_charged | string | Indicates whether a decline fee was charged. |
| decline_fee_invoice_number | string | Decline fee invoice number. |
| decline_fee_amount | decimal | Decline fee amount. |
| remaining_retry_attempts | string | Remaining retry attempts. |
| days_pending_bucket | string | Days pending bucket. |
| guest_code | string | Guest code. |
| member_code | string | Member code. |
| invoice_id | Guid | Invoice ID. |
| guest_id | Guid | Guest ID. |
| center_id | Guid | Center ID. |
| decline_fee_invoice_id | Guid | Decline fee invoice ID. |
| membership_id | Guid | Membership ID. |
| try_status_id | ReportTryStatus | Try status identifier. |
| invoice_status_id | ScheduledCollectionStatus | Invoice status identifier. |
| membership_status_id | ReportMembershipStatus | Membership status identifier. |
| recurring_status_id | ReportMembershipRecurrenceStatus | Recurring status identifier. |
| employee_id | Guid | Employee ID. |
MembershipTriesTotal
| JSON Property | Data Type | Description |
|---|---|---|
| amount_to_be_paid | decimal | Total amount to be paid. |
| decline_fee_amount | decimal | Total decline fee amount. |