invantive documentation
Invantive Support ForumsLog In / Sign Up

Receivables: Minox Receivables

read only per partition REST

  • Catalog: Minox
  • Schema: FinancialReceivable
  • Label: Receivables

Retrieve all the receivables from an administration. Retrieve all the receivables from an administration.

The data in this table is partitioned per value of the administration_code column.

Can only retrieve data.

Summary

Retrieve all the receivables from an administration.

API Source

  • Endpoint: /tenant/{tenant_id}/administration/{administration_id}/receivable
  • Operation: get /tenant/{tenant_id}/administration/{administration_id}/receivable

Parameters

Name Data Type Required Default Documentation
administration_code `` Partition to retrieve data from.
date_from `` An option to filter on invoices from the given date and onwards in a YYYY-MM-DD pattern
next `` A single request returns a maximum of 20000 receivables. In case more receivables have been found, a token will be provided in the response body. The next page can be accessed by providing this token to the next request. An example: GET /receivable?next=[token] where [token] is the provided token
status `` An option to filter on invoices with a certain payment status. This option can be 'open' to show all receivables that still need to be paid, or 'paid' receivables only to show all receivables that have already been paid. (Values: open, paid)

Table Columns

The columns of the table Receivables are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
account_description varchar2 Account Description filters on the platform, writable, account.description
account_id int64 Account ID filters on the platform, writable, account_id The account identifier for a payable or receivable
account_id_2 varchar2 itgen_minox_account_id_2 filters on the platform, writable, account.id
account_scheme varchar2 Account Scheme filters on the platform, writable, account.scheme
account_type varchar2 Account Type filters on the platform, writable, account.type
age int64 Age filters on the platform, writable, age The age of the post in days
balance decimal Balance filters on the platform, writable, balance The amount that still has to be paid to or received from a post. In case this amount is negative, there is a possibility that this is a credit note
blocked_active char Blocked Active filters on the platform, writable, blocked.active Indicates if the post is blocked
blocked_reason varchar2 Blocked Reason filters on the platform, writable, blocked.reason The reason the post is blocked, with a corresponding code
collection_date datetime Collection Date filters on the platform, writable, collection_date The date at which a debt collection (Dutch: 'incasso') was performed
credit_restriction decimal Credit Restriction filters on the platform, writable, credit_restriction The credit restriction amount, calculated by the payment term, that has been added to the total amount
currency_description varchar2 Currency Description filters on the platform, writable, currency.description
currency_exchange_rate decimal Currency Exchange Rate filters on the platform, writable, currency.exchange_rate
currency_id varchar2 Currency ID filters on the platform, writable, currency.id
document_id varchar2 Document ID filters on the platform, writable, document_id
due_date datetime Due Date filters on the platform, writable, due_date The due date of the invoice with a YYYY-MM-DD pattern
invoice_date datetime Invoice Date filters on the platform, writable, invoice_date The date of the invoice with a YYYY-MM-DD pattern
invoice_number int64 Invoice Number filters on the platform, writable, invoice_number The identifying number for an invoice
memo varchar2 Memo filters on the platform, writable, memo The memo attached to the post
paid decimal Paid filters on the platform, writable, paid The amount that has already been paid to or received from a post
payment_discount decimal Payment Discount filters on the platform, writable, payment_discount The payment discount amount, calculated by the payment term, that can be subtracted from the total amount
payment_id varchar2 Payment ID filters on the platform, writable, payment_id The identification of a payment that is associated with this post
payment_term_days decimal Payment Term Days filters on the platform, writable, payment_term.days
payment_term_description varchar2 Payment Term Description filters on the platform, writable, payment_term.description
payment_term_id int64 Payment Term ID filters on the platform, writable, payment_term.id
payment_term_mandate varchar2 Payment Term Mandate filters on the platform, writable, payment_term.mandate
payment_term_start varchar2 Payment Term Start filters on the platform, writable, payment_term.start
reminder_last_sent datetime Reminder Last Sent filters on the platform, writable, reminder.last_sent The last time a reminder has been sent to the corresponding account
reminder_number_sent decimal Reminder Number Sent filters on the platform, writable, reminder.number_sent The number of times a reminder has been sent to the corresponding account
total decimal Total filters on the platform, writable, total The total amount that needs to be paid to or received from the post
type varchar2 Type filters on the platform, writable, type An identifier for whether a post is a payable or a receivable

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

  • - administration_code
  • - administration_name

All changes of the driver, 26.0 to 27.0