inChurch
inChurch API

Schemas

Bank

  • idinteger · readOnly · required
  • namestring · maxLength: 130 · required
  • codeinteger · min: -2147483648 · max: 2147483647 · required

BankAccount

  • idinteger · readOnly · required
  • branch_numberstring · required
  • bankobject · required
  • account_typestring | null · maxLength: 20
  • account_numberstring | null · maxLength: 20
  • holderstring | null · maxLength: 500
  • holder_registrationstring | null · maxLength: 20

Cell

  • idinteger · readOnly · required
  • distancenumber · double · readOnly · required
  • leadersobject[] · readOnly · required
  • supervisorsobject[] · readOnly · required
  • locationreadOnly · required
  • dates_textstring · readOnly · required
  • weekdaysinteger[] · readOnly · required
  • categorystring · readOnly · required
  • frequencystring · readOnly · required
  • addressstring · readOnly · required
  • namestring · maxLength: 200
  • imagestring | null · uri
  • auxiliariesinteger[]

CellCategory

  • idinteger · readOnly · required
  • namestring | null · readOnly · required

DeeplinkConf

  • target_idinteger · required
  • target_typestring · required

DeeplinkConfRequest

  • target_idinteger · required
  • target_typestring · minLength: 1 · required

Donation

  • idinteger · readOnly · required
  • amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • payment_methodstring · required
  • payment_statusstring · required
  • donation_typestring · readOnly · required
  • donorinteger · readOnly · required
  • regionalreadOnly · required
  • churchreadOnly · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • currencystring | null · maxLength: 3
  • installmentsinteger · min: -2147483648 · max: 2147483647
  • cell_membershipsinteger[]

Event

  • idinteger · readOnly · required
  • show_on_calendarboolean · readOnly · required
  • short_url_codestring · readOnly · required
  • end_datetimestring · date-time · readOnly · required
  • incompleteboolean · readOnly · required
  • shareableboolean · readOnly · required
  • subscription_deadlinestring · date-time · readOnly · required
  • paid_eventboolean · readOnly · required
  • has_registrationsboolean · readOnly · required
  • start_datetimestring · date-time · readOnly · required
  • activeboolean · readOnly · required
  • enabledboolean · readOnly · required
  • show_in_appboolean · readOnly · required
  • highlightedboolean · readOnly · required
  • publicboolean · readOnly · required
  • availableboolean · readOnly · required
  • buyer_only_answersboolean · readOnly · required
  • ticket_sortingstring · readOnly · required
  • contact_emailstring · email · readOnly · required
  • contact_phonestring · readOnly · required
  • contact_whatsappstring · readOnly · required
  • public_urlboolean · readOnly · required
  • public_subscriptionboolean · readOnly · required
  • recurrence_modelboolean · readOnly · required
  • send_push_notificationsboolean · readOnly · required
  • legacy_v1boolean · readOnly · required
  • hybridboolean · readOnly · required
  • has_paid_ticketsboolean · readOnly · required
  • locationobject · required
  • regionalreadOnly · required
  • responsible_churchobject · required
  • imagestring | null · uri
  • thumbnailstring | null · uri
  • app_imagestring | null · uri
  • image_webpstring | null · uri
  • descriptionstring
  • namestring · maxLength: 150
  • show_on_siteboolean
  • facebook_urlstring | null · uri · maxLength: 200
  • instagram_urlstring | null · uri · maxLength: 200
  • twitter_urlstring | null · uri · maxLength: 200
  • youtube_urlstring | null · uri · maxLength: 200
  • event_urlstring | null · maxLength: 300
  • push_sentboolean
  • allow_outsidersboolean
  • has_free_ticketsboolean
  • has_available_ticketsboolean
  • has_active_ticketsboolean
  • has_external_subscriptionboolean
  • issued_ticketsinteger · min: 0 · max: 2147483647
  • available_ticketsstring | null · maxLength: 50
  • external_subscription_urlstring | null · uri · maxLength: 2000
  • hide_ticket_quantityboolean
  • event_feesnumber | null · double

EventCheckinRequest

  • codestring · minLength: 1 · maxLength: 255 · required

EventRegistration

  • idinteger · readOnly · required
  • event_idinteger · readOnly · required
  • event_namestring · readOnly · required
  • coupon_code_usedstring · readOnly · required
  • profile_idinteger | null · readOnly · required
  • created_atstring · date-time · readOnly · required
  • ticketsobject[] · required

EventTransaction

  • idinteger · readOnly · required
  • event_idinteger · readOnly · required
  • event_namestring · readOnly · required
  • coupon_code_usedstring · readOnly · required
  • payment_methodstring · readOnly · required
  • amount_paidstring · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • payment_statusstring · readOnly · required
  • transaction_recordsstring · readOnly · required
  • participantinteger · readOnly · required
  • registration_datetimestring · date-time · readOnly · required
  • boleto_codestring · readOnly · required
  • is_recurringboolean · readOnly · required
  • payment_gatewaystring · readOnly · required
  • has_active_ticketsboolean
  • installmentsinteger · min: -2147483648 · max: 2147483647
  • pix_keystring | null
  • pix_qr_codestring | null · uri · maxLength: 300
  • currencystring | null · maxLength: 3
  • gateway_transaction_idstring | null · maxLength: 100

EventTransactionRetrieve

  • idinteger · readOnly · required
  • event_idinteger · readOnly · required
  • event_namestring · readOnly · required
  • coupon_code_usedstring · readOnly · required
  • payment_methodstring · readOnly · required
  • amount_paidstring · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • payment_statusstring · readOnly · required
  • transaction_recordsstring · readOnly · required
  • participantinteger · readOnly · required
  • registration_datetimestring · date-time · readOnly · required
  • boleto_codestring · readOnly · required
  • is_recurringboolean · readOnly · required
  • payment_gatewaystring · readOnly · required
  • entriesstring · readOnly · required
  • has_active_ticketsboolean
  • installmentsinteger · min: -2147483648 · max: 2147483647
  • pix_keystring | null
  • pix_qr_codestring | null · uri · maxLength: 300
  • currencystring | null · maxLength: 3
  • gateway_transaction_idstring | null · maxLength: 100

FinancialAccount

  • idinteger · readOnly · required
  • namestring · required
  • is_primaryboolean · required
  • is_activeboolean · required
  • initial_balancestring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • opening_datestring · date · required
  • current_balancestring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • bank_accountobject · required
  • churchreadOnly · required
  • account_typestring · enum
    • control - Control
    • processing - Processing
    Enum values:
    control
    processing

FinancialCategory

  • idinteger · readOnly · required
  • namestring · required
  • financial_statement_sectionstring · required
  • transaction_typestring · required
  • default_cost_centerreadOnly · required
  • churchreadOnly · required
  • descriptionstring | null

FinancialCostCenter

  • idinteger · readOnly · required
  • namestring · required
  • churchreadOnly · required
  • descriptionstring | null

FinancialEntry

  • idinteger · readOnly · required
  • transaction_typestring · required
  • base_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • base_amount_centsstring · readOnly · required
  • display_amountstring · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • paid_amount_centsinteger · readOnly · required
  • intereststring · readOnly · required
  • interest_centsinteger · readOnly · required
  • penalty_centsinteger · readOnly · required
  • discountstring · readOnly · required
  • discount_centsinteger · readOnly · required
  • admin_fee_centsinteger · readOnly · required
  • original_due_datestring | null · date · readOnly · required
  • original_accrual_datestring | null · date · readOnly · required
  • amount_multiplierinteger · readOnly · required
  • financial_accountreadOnly · required
  • statusstring · readOnly · required
  • churchreadOnly · required
  • categoryreadOnly · required
  • subcategoryreadOnly · required
  • cost_centerreadOnly · required
  • business_unitreadOnly · required
  • supplierreadOnly · required
  • small_groupsreadOnly · required
  • attachmentsobject[] · readOnly · required
  • created_atstring | null · date-time · readOnly · required
  • updated_atstring | null · date-time · readOnly · required
  • created_byinteger | null · readOnly · required
  • updated_byinteger | null · readOnly · required
  • descriptionstring | null · maxLength: 300
  • currencystring | null · maxLength: 3
  • paid_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • penaltystring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • admin_feestring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • due_datestring | null · date
  • accrual_datestring | null · date
  • payment_datestring | null · date
  • is_paidboolean
  • payment_methodstring | null · enum
    • billet - Billet
    • pix - Pix
    • credit_card - Credit card
    • debit_card - Debit card
    • money - Money
    • transference - Transference
    • bank_check - Bank check
    • direct_debit - Direct debit
    • other - Other
    Enum values:
    billet
    pix
    credit_card
    debit_card
    money
    transference
    bank_check
    direct_debit
  • installment_numberinteger
  • recurrence_configobject
  • payment_transaction_idinteger

FinancialEntryRequest

  • transaction_typestring · minLength: 1 · required
  • financial_account_idinteger · writeOnly · required
  • base_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • church_idinteger · writeOnly · required
  • supplier_idinteger · writeOnly · required
  • descriptionstring | null · maxLength: 300
  • currencystring | null · maxLength: 3
  • paid_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • penaltystring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • admin_feestring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • due_datestring | null · date
  • accrual_datestring | null · date
  • payment_datestring | null · date
  • is_paidboolean
  • payment_methodstring | null · enum
    • billet - Billet
    • pix - Pix
    • credit_card - Credit card
    • debit_card - Debit card
    • money - Money
    • transference - Transference
    • bank_check - Bank check
    • direct_debit - Direct debit
    • other - Other
    Enum values:
    billet
    pix
    credit_card
    debit_card
    money
    transference
    bank_check
    direct_debit
  • installment_numberinteger
  • category_idinteger · writeOnly
  • subcategory_idinteger · writeOnly
  • recurrence_configobject
  • payment_transaction_idinteger

FinancialSupplier

  • idinteger · readOnly · required
  • namestring · maxLength: 255 · required
  • personobject · required
  • addressobject · required
  • tax_documentstring · required
  • websitestring · required
  • notesstring · required
  • entity_typestring · required
  • bankobject · required
  • branch_numberstring · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • churchreadOnly · required
  • emailstring | null · email · maxLength: 254
  • phonestring · maxLength: 20
  • has_whatsappboolean
  • nationalitystring | null · maxLength: 100
  • is_payerboolean
  • is_supplierboolean
  • is_trade_nameboolean
  • is_legal_nameboolean
  • account_numberstring | null · maxLength: 20
  • pix_keystring | null · maxLength: 100

Location

  • countrystring · readOnly · required
  • statestring · readOnly · required
  • citystring · readOnly · required
  • zip_codestring · readOnly · required
  • addressstring | null · maxLength: 200
  • address_numberstring | null · maxLength: 100
  • address_complementstring | null · maxLength: 100
  • neighborhoodstring | null · maxLength: 200
  • latitudenumber | null · double
  • longitudenumber | null · double

Member

  • namestring · required
  • emailstring · email · required
  • phonestring · required

MemberRoleHistory

  • roleobject · required
  • start_datestring · date · required
  • is_activeboolean · required

MemberRoleHistoryRequest

  • roleobject · required
  • start_datestring · date · required
  • is_activeboolean · required

PaginatedCellCategoryList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedCellList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedDonationList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedEventList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedEventRegistrationList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedEventTransactionList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedFinancialAccountList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedFinancialCategoryList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedFinancialCostCenterList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedFinancialEntryList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedFinancialSupplierList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedPeopleList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedPushNotificationList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedSmallGroupList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedSmallGroupMembershipList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedSubscriptionList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedSubscriptionPlanList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PaginatedTicketList

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

PatchedFinancialEntryRequest

  • descriptionstring | null · maxLength: 300
  • transaction_typestring · minLength: 1
  • currencystring | null · maxLength: 3
  • financial_account_idinteger · writeOnly
  • base_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • paid_amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • penaltystring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • admin_feestring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,…
  • due_datestring | null · date
  • accrual_datestring | null · date
  • payment_datestring | null · date
  • is_paidboolean
  • payment_methodstring | null · enum
    • billet - Billet
    • pix - Pix
    • credit_card - Credit card
    • debit_card - Debit card
    • money - Money
    • transference - Transference
    • bank_check - Bank check
    • direct_debit - Direct debit
    • other - Other
    Enum values:
    billet
    pix
    credit_card
    debit_card
    money
    transference
    bank_check
    direct_debit
  • installment_numberinteger
  • church_idinteger · writeOnly
  • category_idinteger · writeOnly
  • subcategory_idinteger · writeOnly
  • supplier_idinteger · writeOnly
  • recurrence_configobject
  • payment_transaction_idinteger

PatchedPeopleRequest

  • full_namestring · minLength: 1 · maxLength: 255
  • genderstring | null · enum
    • male - Male
    • female - Female
    Enum values:
    male
    female
  • church_idinteger | null · writeOnly
  • statusstring | null · enum
    • pending - Pending
    • approved - Approved
    • refused - Refused
    Enum values:
    pending
    approved
    refused
  • photostring
  • is_pastorboolean
  • is_leaderboolean
  • leadership_datestring | null · date
  • accepted_jesusboolean
  • decision_contextstring | null · minLength: 1
  • decision_datestring | null · date
  • birthdaystring | null · date
  • cpfstring | null · maxLength: 11
  • rgstring | null · maxLength: 14
  • rg_statestring | null · minLength: 1
  • church_profilestring | null · enum
    • visitor - Visitor
    • frequent - Frequent
    • member - Member
    Enum values:
    visitor
    frequent
    member
  • location_typestring | null · enum · writeOnly
    • national - national
    • international - international
    Enum values:
    national
    international
  • locationobject | null · writeOnly
  • baptizedboolean | null
  • baptism_datestring | null · date
  • baptism_typestring | null · enum
    • immersion - Immersion
    • aspersion - Aspersion
    Enum values:
    immersion
    aspersion
  • marital_statusstring | null · minLength: 1
  • marriage_datestring | null · date
  • emailstring | null · email · maxLength: 254
  • phonestring | null · maxLength: 24
  • mobile_phonestring | null · minLength: 1
  • has_whatsappboolean
  • membership_numberinteger | null
  • has_special_needsboolean
  • special_needs_detailsstring | null · minLength: 1
  • id_documentstring | null · minLength: 1
  • document_countrystring | null · minLength: 1
  • document_issuerstring | null · maxLength: 255
  • joining_reasonstring | null · minLength: 1
  • previous_churchstring | null · minLength: 1
  • education_levelstring | null · minLength: 1
  • occupationstring | null · maxLength: 100
  • membership_typestring | null · minLength: 1
  • visit_reasonstring | null · minLength: 1
  • blood_typestring | null · enum
    • o- - O-
    • o+ - O+
    • a- - A-
    • a+ - A+
    • b- - B-
    • b+ - B+
    • ab- - AB-
    • ab+ - AB+
    Enum values:
    o-
    o+
    a-
    a+
    b-
    b+
    ab-
    ab+
  • nationalitystring | null · maxLength: 100
  • birth_statestring | null · minLength: 1
  • birth_placestring | null · minLength: 1
  • death_datestring | null · date
  • membership_start_datestring | null · date
  • first_visit_datestring | null · date
  • is_activeboolean
  • inactive_reasonstring | null · enum
    • transference - Transference
    • death - Death
    • withdrawal - Withdrawal
    • exclusion - Exclusion
    • no_contact - No contact
    • other - Other
    Enum values:
    transference
    death
    withdrawal
    exclusion
    no_contact
    other
  • inactive_reason_detailsstring | null · minLength: 1
  • inactive_datestring | null · date

PatchedPushNotificationRequest

  • titlestring · minLength: 1 · maxLength: 160
  • messagestring · minLength: 1
  • imagestring | null · binary
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

People

  • idinteger · readOnly · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • churchreadOnly · required
  • profile_change_datestring · date · readOnly · required
  • rolesobject[] · readOnly · required
  • full_namestring · maxLength: 255
  • genderstring | null · enum
    • male - Male
    • female - Female
    Enum values:
    male
    female
  • statusstring | null · enum
    • pending - Pending
    • approved - Approved
    • refused - Refused
    Enum values:
    pending
    approved
    refused
  • photostring · uri
  • is_pastorboolean
  • is_leaderboolean
  • leadership_datestring | null · date
  • accepted_jesusboolean
  • decision_contextstring | null
  • decision_datestring | null · date
  • birthdaystring | null · date
  • cpfstring | null · maxLength: 11
  • rgstring | null · maxLength: 14
  • rg_statestring | null
  • church_profilestring | null · enum
    • visitor - Visitor
    • frequent - Frequent
    • member - Member
    Enum values:
    visitor
    frequent
    member
  • baptizedboolean | null
  • baptism_datestring | null · date
  • baptism_typestring | null · enum
    • immersion - Immersion
    • aspersion - Aspersion
    Enum values:
    immersion
    aspersion
  • marital_statusstring | null
  • marriage_datestring | null · date
  • emailstring | null · email · maxLength: 254
  • phonestring | null · maxLength: 24
  • mobile_phonestring | null
  • has_whatsappboolean
  • membership_numberinteger | null
  • has_special_needsboolean
  • special_needs_detailsstring | null
  • id_documentstring | null
  • document_countrystring | null
  • document_issuerstring | null · maxLength: 255
  • joining_reasonstring | null
  • previous_churchstring | null
  • education_levelstring | null
  • occupationstring | null · maxLength: 100
  • membership_typestring | null
  • visit_reasonstring | null
  • blood_typestring | null · enum
    • o- - O-
    • o+ - O+
    • a- - A-
    • a+ - A+
    • b- - B-
    • b+ - B+
    • ab- - AB-
    • ab+ - AB+
    Enum values:
    o-
    o+
    a-
    a+
    b-
    b+
    ab-
    ab+
  • nationalitystring | null · maxLength: 100
  • birth_statestring | null
  • birth_placestring | null
  • death_datestring | null · date
  • membership_start_datestring | null · date
  • first_visit_datestring | null · date
  • is_activeboolean
  • inactive_reasonstring | null · enum
    • transference - Transference
    • death - Death
    • withdrawal - Withdrawal
    • exclusion - Exclusion
    • no_contact - No contact
    • other - Other
    Enum values:
    transference
    death
    withdrawal
    exclusion
    no_contact
    other
  • inactive_reason_detailsstring | null
  • inactive_datestring | null · date

PeopleRequest

  • full_namestring · minLength: 1 · maxLength: 255
  • genderstring | null · enum
    • male - Male
    • female - Female
    Enum values:
    male
    female
  • church_idinteger | null · writeOnly
  • statusstring | null · enum
    • pending - Pending
    • approved - Approved
    • refused - Refused
    Enum values:
    pending
    approved
    refused
  • photostring
  • is_pastorboolean
  • is_leaderboolean
  • leadership_datestring | null · date
  • accepted_jesusboolean
  • decision_contextstring | null · minLength: 1
  • decision_datestring | null · date
  • birthdaystring | null · date
  • cpfstring | null · maxLength: 11
  • rgstring | null · maxLength: 14
  • rg_statestring | null · minLength: 1
  • church_profilestring | null · enum
    • visitor - Visitor
    • frequent - Frequent
    • member - Member
    Enum values:
    visitor
    frequent
    member
  • location_typestring | null · enum · writeOnly
    • national - national
    • international - international
    Enum values:
    national
    international
  • locationobject | null · writeOnly
  • baptizedboolean | null
  • baptism_datestring | null · date
  • baptism_typestring | null · enum
    • immersion - Immersion
    • aspersion - Aspersion
    Enum values:
    immersion
    aspersion
  • marital_statusstring | null · minLength: 1
  • marriage_datestring | null · date
  • emailstring | null · email · maxLength: 254
  • phonestring | null · maxLength: 24
  • mobile_phonestring | null · minLength: 1
  • has_whatsappboolean
  • membership_numberinteger | null
  • has_special_needsboolean
  • special_needs_detailsstring | null · minLength: 1
  • id_documentstring | null · minLength: 1
  • document_countrystring | null · minLength: 1
  • document_issuerstring | null · maxLength: 255
  • joining_reasonstring | null · minLength: 1
  • previous_churchstring | null · minLength: 1
  • education_levelstring | null · minLength: 1
  • occupationstring | null · maxLength: 100
  • membership_typestring | null · minLength: 1
  • visit_reasonstring | null · minLength: 1
  • blood_typestring | null · enum
    • o- - O-
    • o+ - O+
    • a- - A-
    • a+ - A+
    • b- - B-
    • b+ - B+
    • ab- - AB-
    • ab+ - AB+
    Enum values:
    o-
    o+
    a-
    a+
    b-
    b+
    ab-
    ab+
  • nationalitystring | null · maxLength: 100
  • birth_statestring | null · minLength: 1
  • birth_placestring | null · minLength: 1
  • death_datestring | null · date
  • membership_start_datestring | null · date
  • first_visit_datestring | null · date
  • is_activeboolean
  • inactive_reasonstring | null · enum
    • transference - Transference
    • death - Death
    • withdrawal - Withdrawal
    • exclusion - Exclusion
    • no_contact - No contact
    • other - Other
    Enum values:
    transference
    death
    withdrawal
    exclusion
    no_contact
    other
  • inactive_reason_detailsstring | null · minLength: 1
  • inactive_datestring | null · date

PersonRole

  • idinteger · required
  • namestring · required

PersonRoleRequest

  • idinteger · required
  • namestring · minLength: 1 · required

PushNotification

  • idinteger · readOnly · required
  • messagestring · required
  • delivery_statusstring · readOnly · required
  • status_messagestring · readOnly · required
  • provider_responsereadOnly · required
  • titlestring · maxLength: 160
  • imagestring | null · uri
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

PushNotificationRequest

  • messagestring · minLength: 1 · required
  • titlestring · minLength: 1 · maxLength: 160
  • imagestring | null · binary
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

PushRecurrence

  • frequencystring · enum
    • daily - Daily
    • weekly - Weekly
    • monthly - Monthly
    • yearly - Yearly
    Enum values:
    daily
    weekly
    monthly
    yearly
  • occurrencesinteger | null · min: 0 · max: 2147483647
  • every_ninteger · min: 0 · max: 2147483647
  • untilstring | null · date
  • weekdaysstring | null · maxLength: 21

PushRecurrenceRequest

  • frequencystring · enum
    • daily - Daily
    • weekly - Weekly
    • monthly - Monthly
    • yearly - Yearly
    Enum values:
    daily
    weekly
    monthly
    yearly
  • occurrencesinteger | null · min: 0 · max: 2147483647
  • every_ninteger · min: 0 · max: 2147483647
  • untilstring | null · date
  • weekdaysstring | null · minLength: 1 · maxLength: 21

ReadAttachments

  • idinteger · readOnly · required
  • namestring · required

ReadAttachmentsRequest

  • namestring · minLength: 1 · required

ReadBusinessUnit

  • idinteger · readOnly · required
  • namestring · required

ReadBusinessUnitRequest

  • namestring · minLength: 1 · required

ReadCategory

  • idinteger · readOnly · required
  • namestring · required

ReadCategoryRequest

  • namestring · minLength: 1 · required

ReadCostCenter

  • idinteger · readOnly · required
  • namestring · required

ReadCostCenterRequest

  • namestring · minLength: 1 · required

ReadFinancialAccount

  • idinteger · readOnly · required
  • namestring · required

ReadFinancialAccountRequest

  • namestring · minLength: 1 · required

ReadSubCategory

  • idinteger · readOnly · required
  • namestring · required

ReadSubCategoryRequest

  • namestring · minLength: 1 · required

ReadSupplier

  • idinteger · readOnly · required
  • namestring · maxLength: 255 · required

ReadSupplierRequest

  • namestring · minLength: 1 · maxLength: 255 · required

Recurrence

  • recurrence_typestring | null · enum
    • in_installment - Installments
    • recurrent - Recurrent
    Enum values:
    in_installment
    recurrent
  • frequencystring · enum
    • daily - Daily
    • weekly - Weekly
    • biweekly - Bi-weekly
    • monthly - Monthly
    • bimonthly - Bi-monthly
    • quarterly - Quarterly
    • biannual - Semi-annually
    • annual - Annual
    Enum values:
    daily
    weekly
    biweekly
    monthly
    bimonthly
    quarterly
    biannual
    annual
  • occurrencesinteger | null · min: 0 · max: 2147483647
  • untilstring | null · date

RecurrenceRequest

  • recurrence_typestring | null · enum
    • in_installment - Installments
    • recurrent - Recurrent
    Enum values:
    in_installment
    recurrent
  • frequencystring · enum
    • daily - Daily
    • weekly - Weekly
    • biweekly - Bi-weekly
    • monthly - Monthly
    • bimonthly - Bi-monthly
    • quarterly - Quarterly
    • biannual - Semi-annually
    • annual - Annual
    Enum values:
    daily
    weekly
    biweekly
    monthly
    bimonthly
    quarterly
    biannual
    annual
  • occurrencesinteger | null · min: 0 · max: 2147483647
  • untilstring | null · date

Regional

  • idinteger · readOnly · required
  • namestring · maxLength: 200 · required

SmallGroup

  • idinteger · readOnly · required
  • namestring · maxLength: 200 · required

SmallGroupMembership

  • idinteger · readOnly · required
  • personinteger · required
  • group_idinteger · readOnly · required
  • is_approvedboolean · required
  • approval_datestring · date-time · readOnly · required
  • joined_atstring · date-time · readOnly · required

SmallGroupRequest

  • namestring · minLength: 1 · maxLength: 200 · required

Subscription

  • idinteger · readOnly · required
  • amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • payment_methodstring · required
  • payment_statusstring · required
  • donorinteger · readOnly · required
  • regionalreadOnly · required
  • churchreadOnly · required
  • planinteger · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • currencystring | null · maxLength: 3
  • installmentsinteger · min: -2147483648 · max: 2147483647

SubscriptionPlan

  • idinteger · readOnly · required
  • regionalreadOnly · required
  • churchreadOnly · required
  • namestring · required
  • additional_imagestring · uri · required
  • auto_assign_groupsinteger[] · readOnly · required
  • amountstring · decimal · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
  • billing_cyclestring · required
  • descriptionstring | null
  • is_activeboolean
  • has_freemiumboolean
  • freemium_daysinteger · min: 0 · max: 2147483647
  • has_terms_of_useboolean
  • terms_of_usestring | null
  • has_downloads_limitboolean
  • downloads_limitinteger · min: -2147483648 · max: 2147483647

TertiaryGroup

  • idinteger · readOnly · required
  • namestring · maxLength: 200 · required

TertiaryGroupRequest

  • namestring · minLength: 1 · maxLength: 200 · required

Ticket

  • idinteger · readOnly · required
  • codestring · readOnly · required
  • was_usedstring · readOnly · required