inChurch
inChurch API

Financial - Entries

Endpoint:https://inradar.com.br/public

List Financial Entries

GET
https://inradar.com.br/public
/v1/financial_entries/

Get a list of financial entries based on the user's access level.

List Financial Entries › query Parameters

  • limitinteger

    Number of results to return per page.

  • offsetinteger

    The initial index from which to return the results.

List Financial Entries › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

List Financial Entries › Responses

  • 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

Create a Financial Entry

POST
https://inradar.com.br/public
/v1/financial_entries/

Create a new financial entry record.

Create a Financial Entry › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

  • Content-Typestring · enum · required
    Enum values:
    application/json

Create a Financial Entry › Request Body

  • 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

Create a Financial Entry › Responses

  • 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

Retrieve a Financial Entry

GET
https://inradar.com.br/public
/v1/financial_entries/{id}/

Get detailed information about a specific financial entry.

Retrieve a Financial Entry › path Parameters

  • idinteger · required

    A unique integer value identifying this financial entry.

Retrieve a Financial Entry › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

Retrieve a Financial Entry › Responses

  • 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

Delete a Financial Entry

DELETE
https://inradar.com.br/public
/v1/financial_entries/{id}/

Delete an existing financial entry record.

Delete a Financial Entry › path Parameters

  • idinteger · required

    A unique integer value identifying this financial entry.

Delete a Financial Entry › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

Delete a Financial Entry › Responses

No response body

No data returned

Update a Financial Entry

PATCH
https://inradar.com.br/public
/v1/financial_entries/{id}/

Update an existing financial entry record.

Update a Financial Entry › path Parameters

  • idinteger · required

    A unique integer value identifying this financial entry.

Update a Financial Entry › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

  • Content-Typestring · enum · required
    Enum values:
    application/json

Update a Financial Entry › Request Body

  • 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

Update a Financial Entry › Responses

  • 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
Financial - Cost CenterFinancial - Suppliers