# Amili Docs ## Docs - Root [Welcome to Amili Docs](https://docs.amili.dev/welcome-to-amili-docs-355473m0.md): - Root [Responsible disclosure](https://docs.amili.dev/responsible-disclosure-362460m0.md): - Root [Become a partner](https://docs.amili.dev/become-a-partner-362461m0.md): - Root [About the AutoCollect API](https://docs.amili.dev/about-the-autocollect-api-355475m0.md): - Root [Getting started with the AutoCollect API](https://docs.amili.dev/getting-started-with-the-autocollect-api-358592m0.md): - Root [Webhooks](https://docs.amili.dev/webhooks-361430m0.md): - Root [Example Workflow](https://docs.amili.dev/example-workflow-359631m0.md): - Root [ArItems](https://docs.amili.dev/joar.md): - [About the AutoCollect API](https://docs.amili.dev/about-the-autocollect-api-355475m0.md?nav=4): - [Getting started with the AutoCollect API](https://docs.amili.dev/getting-started-with-the-autocollect-api-358592m0.md?nav=4): - [Webhooks](https://docs.amili.dev/webhooks-361430m0.md?nav=4): - [Example Workflow](https://docs.amili.dev/example-workflow-359631m0.md?nav=4): - [ArItems](https://docs.amili.dev/joar.md?nav=5): ## API Docs - Root > Batches [GetBatchById](https://docs.amili.dev/getbatchbyid-4148060e0.md): Endpoints for organization management operations - Root > Batches [GetBatchesByOrganization](https://docs.amili.dev/getbatchesbyorganization-4148061e0.md): Endpoints for organization management operations - Root > Batches [GetBatchById - Legacy (To be removed)](https://docs.amili.dev/getbatchbyid-legacy-to-be-removed-3939029e0.md): Endpoints for batch management operations - Root > Collections [GetCasesByOrganization](https://docs.amili.dev/getcasesbyorganization-4326442e0.md): Endpoints for organization management operations - Root > Collections [AcceptDebtCollectionList](https://docs.amili.dev/acceptdebtcollectionlist-4148062e0.md): Endpoints for organization management operations - Root > Collections [RejectDebtCollectionList](https://docs.amili.dev/rejectdebtcollectionlist-4148063e0.md): Endpoints for organization management operations - Root > Collections [PauseCase](https://docs.amili.dev/pausecase-4148064e0.md): Endpoints for organization management operations - Root > Collections [WithdrawCase](https://docs.amili.dev/withdrawcase-4148065e0.md): Endpoints for organization management operations - Root > Collections [ResumeCase](https://docs.amili.dev/resumecase-4148066e0.md): Endpoints for organization management operations - Root > Collections [AcceptEvictionRequest](https://docs.amili.dev/acceptevictionrequest-4289928e0.md): Endpoints for organization management operations - Root > Collections [RejectEvictionRequest](https://docs.amili.dev/rejectevictionrequest-4289929e0.md): Endpoints for organization management operations - Root > Collections [AcceptEvictionConfirmation](https://docs.amili.dev/acceptevictionconfirmation-4289930e0.md): Endpoints for organization management operations - Root > Collections [RejectEvictionConfirmation](https://docs.amili.dev/rejectevictionconfirmation-4289931e0.md): Endpoints for organization management operations - Root > Correction [CreateCorrections](https://docs.amili.dev/createcorrections-4155388e0.md): Endpoints for organization management operations - Root > Invoice [CreateInvoices](https://docs.amili.dev/createinvoices-4148067e0.md): Endpoints for organization management operations - Root > Invoice [GetInvoicesByOrganization](https://docs.amili.dev/getinvoicesbyorganization-4148068e0.md): Endpoints for organization management operations - Root > Invoice [GetInvoiceById](https://docs.amili.dev/getinvoicebyid-4148069e0.md): Endpoints for organization management operations - Root > Payment [CreatePayments](https://docs.amili.dev/createpayments-4148070e0.md): Endpoints for organization management operations - Root > Settlement [GetSettlements](https://docs.amili.dev/getsettlements-4148071e0.md): Endpoints for organization management operations - Root > Settlement [GetSettlement on Id](https://docs.amili.dev/getsettlement-on-id-4148072e0.md): Endpoints for organization management operations - Root > AutoCollect Legacy API > Attachment [/webapi/api/Attachment](https://docs.amili.dev/webapiapiattachment-4161130e0.md): - Root > AutoCollect Legacy API > Batch [/webapi/api/Batch](https://docs.amili.dev/webapiapibatch-4161131e0.md): - Root > AutoCollect Legacy API > Batch [/webapi/api/Batch](https://docs.amili.dev/webapiapibatch-4161132e0.md): - Root > AutoCollect Legacy API > Ping [/webapi/api/Ping](https://docs.amili.dev/webapiapiping-4161133e0.md): - Root > Actions [POST (create) an action](https://docs.amili.dev/post-create-an-action-4205258e0.md): Creates one new action ready for execution. About required input, see the description for each action code - Root > Actions [POST (create) a reports action/generate a report](https://docs.amili.dev/post-create-a-reports-actiongenerate-a-report-4205259e0.md): Creates one new reports action (generate a report request, ready for execution). About required input, see the description for each report type code - Root > ArItems [GET a list of AR items](https://docs.amili.dev/get-a-list-of-ar-items-4205260e0.md): Get a list of AR items based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Root > ArItems [PUT (update) ar item details](https://docs.amili.dev/put-update-ar-item-details-4205261e0.md): Update details on an existing AR item. Can also be used to create a credit note for an existing invoice or interest note - Root > ArItems [GET one AR item](https://docs.amili.dev/get-one-ar-item-4205262e0.md): Get details for one AR item based on AR item ID as path parameter - Root > AutoPostings [POST (create) one or more auto postings](https://docs.amili.dev/post-create-one-or-more-auto-postings-4205263e0.md): Performs a set of one or more auto postings. An auto posting is a complex set of debit/credit entries to the GL/AR based on one event. - Root > Batches [GET one batch](https://docs.amili.dev/get-one-batch-4205264e0.md): Get details for one batch with asynchronous treatment - Root > ClientConfigs [GET a list of client config values](https://docs.amili.dev/get-a-list-of-client-config-values-4205265e0.md): Get details for a list of client config values - Root > ClientConfigs [GET values for one client config key](https://docs.amili.dev/get-values-for-one-client-config-key-4205266e0.md): Get details for a client config key - Root > Codes [GET ARM system code values](https://docs.amili.dev/get-arm-system-code-values-4205267e0.md): Get details for ARM system code values - Root > Customers [POST (create) one customer](https://docs.amili.dev/post-create-one-customer-4205268e0.md): Creates one new customer. If the customer already exists, it will be updated (same as PUT customer, see details under *PUT (update) one customer*). - Root > Customers [PUT (update) one customer](https://docs.amili.dev/put-update-one-customer-4205269e0.md): Update details on an existing customer. - Root > Customers [GET a list of customers](https://docs.amili.dev/get-a-list-of-customers-4205270e0.md): Get a list with details of one or more customers based on criteria given in query parameters. Default and upper limit maximumCount (maximum total number of records returned per query) = 10000; pageSize (maximum number of records per page) default = 100, pageSize (maximum number of records per page) upper limit = 1000. - Root > Customers [GET one customer](https://docs.amili.dev/get-one-customer-4205271e0.md): Get details for one customer based on customerNo as path parameter - Root > Customers [DELETE a customer](https://docs.amili.dev/delete-a-customer-4205272e0.md): Delete a customer. Only allowed if the customer has no documents or AR items attached - Root > Customers [POST (create) a batch of customers](https://docs.amili.dev/post-create-a-batch-of-customers-4205273e0.md): Creates a batch of new customers. If a customer already exists, it will be updated (same as PUT customer(s), see details under *PUT (update) one customer*). - Root > Customers [PUT (update) a batch of customers](https://docs.amili.dev/put-update-a-batch-of-customers-4205274e0.md): Update a batch of customers. - Root > DocumentBundles [GET a list of document bundles](https://docs.amili.dev/get-a-list-of-document-bundles-4205275e0.md): Get a list of document bundles based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Root > DocumentBundles [GET one document bundle](https://docs.amili.dev/get-one-document-bundle-4205276e0.md): Get details for one document bundle based on documentBundleId as path parameter - Root > Documents [POST (create) one document](https://docs.amili.dev/post-create-one-document-4205277e0.md): Create one document. - Root > Documents [GET a list of documents](https://docs.amili.dev/get-a-list-of-documents-4205278e0.md): Get a list of documents based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Root > Documents [GET one document](https://docs.amili.dev/get-one-document-4205279e0.md): Get details for one document based on documentNo as path parameter - Root > Documents [POST (create) a batch of documents](https://docs.amili.dev/post-create-a-batch-of-documents-4205280e0.md): Creates a batch of new documents. - Root > Files [GET one or more OS files](https://docs.amili.dev/get-one-or-more-os-files-4205281e0.md): Get (download) one or more OS files based on input query parameters. If you input a *logItemId* or a combination of parameters with one specific file *name*, you will only get one file in return. If you query for instance attachment files for a given *referenceNo*, you can get more than one file in return. Maximum count of files delivered is always 10 (cannot be altered). Output data are not paginated - Root > Files [POST (upload) one or more OS files](https://docs.amili.dev/post-upload-one-or-more-os-files-4205282e0.md): Upload one or more OS files. Access to upload for different types of OS files are configured for each ARM client - Root > Files [GET one OS file](https://docs.amili.dev/get-one-os-file-4205283e0.md): Get (download) one OS file based on log item ID as path parameter. The report or export file connected to the log item will be returned - Root > GlItems [Get one GL item](https://docs.amili.dev/get-one-gl-item-4205284e0.md): Get details for one GL item based on GL item ID as path parameter - Root > GlItems [GET a list of GL items](https://docs.amili.dev/get-a-list-of-gl-items-4205285e0.md): Get a list of GL items based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Root > GlMovements [Get movement/balance for the latest closed GL year/period](https://docs.amili.dev/get-movementbalance-for-the-latest-closed-gl-yearperiod-4205286e0.md): Get GL movement and incoming/outgoing balance for the latest closed GL year/period - Root > GlMovements [GET a list of GL movements/balances](https://docs.amili.dev/get-a-list-of-gl-movementsbalances-4205287e0.md): Get a list of GL periods' movements and incoming/outgoing balances based on criteria given in query parameters. You should input *either* glyear + glperiod *or* a combination of glyearfrom/glperiodfrom and glyearto/glperiodto. Filtering glaccountno is optional - Root > Insights [GET a list of ADB intervals](https://docs.amili.dev/get-a-list-of-adb-intervals-4205288e0.md): Get a list of cached ADB (Age Distributed Balance) intervals with relevant values. Items not due will be counted in interval no 0. Then follows 5 intervals (no 1 - 5) with the following lengths (days): 30, 30, 30, 90, 180. The last interval (no 6) is of indefinite length. - Root > LogItems [GET one log item](https://docs.amili.dev/get-one-log-item-4205289e0.md): Get details for one log item based on log item ID as path parameter - Root > LogItems [GET a list of log items](https://docs.amili.dev/get-a-list-of-log-items-4205290e0.md): Get a list of log items (also referred to as *BatchLog*) based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Root > PaymentReservations [POST (create) a new payment reservation](https://docs.amili.dev/post-create-a-new-payment-reservation-4205291e0.md): Creates a new payment reservation connected to an existing document's AR item or to an existing customer. There are alternative ways to identify this document or customer, you must fulfill at least one of them. - Root > Health [Check API health](https://docs.amili.dev/check-api-health-4205292e0.md): Check API health - Batches [GetBatchById](https://docs.amili.dev/getbatchbyid-4148060e0.md?nav=4): Endpoints for organization management operations - Batches [GetBatchesByOrganization](https://docs.amili.dev/getbatchesbyorganization-4148061e0.md?nav=4): Endpoints for organization management operations - Batches [GetBatchById - Legacy (To be removed)](https://docs.amili.dev/getbatchbyid-legacy-to-be-removed-3939029e0.md?nav=4): Endpoints for batch management operations - Collections [GetCasesByOrganization](https://docs.amili.dev/getcasesbyorganization-4326442e0.md?nav=4): Endpoints for organization management operations - Collections [AcceptDebtCollectionList](https://docs.amili.dev/acceptdebtcollectionlist-4148062e0.md?nav=4): Endpoints for organization management operations - Collections [RejectDebtCollectionList](https://docs.amili.dev/rejectdebtcollectionlist-4148063e0.md?nav=4): Endpoints for organization management operations - Collections [PauseCase](https://docs.amili.dev/pausecase-4148064e0.md?nav=4): Endpoints for organization management operations - Collections [WithdrawCase](https://docs.amili.dev/withdrawcase-4148065e0.md?nav=4): Endpoints for organization management operations - Collections [ResumeCase](https://docs.amili.dev/resumecase-4148066e0.md?nav=4): Endpoints for organization management operations - Collections [AcceptEvictionRequest](https://docs.amili.dev/acceptevictionrequest-4289928e0.md?nav=4): Endpoints for organization management operations - Collections [RejectEvictionRequest](https://docs.amili.dev/rejectevictionrequest-4289929e0.md?nav=4): Endpoints for organization management operations - Collections [AcceptEvictionConfirmation](https://docs.amili.dev/acceptevictionconfirmation-4289930e0.md?nav=4): Endpoints for organization management operations - Collections [RejectEvictionConfirmation](https://docs.amili.dev/rejectevictionconfirmation-4289931e0.md?nav=4): Endpoints for organization management operations - Correction [CreateCorrections](https://docs.amili.dev/createcorrections-4155388e0.md?nav=4): Endpoints for organization management operations - Invoice [CreateInvoices](https://docs.amili.dev/createinvoices-4148067e0.md?nav=4): Endpoints for organization management operations - Invoice [GetInvoicesByOrganization](https://docs.amili.dev/getinvoicesbyorganization-4148068e0.md?nav=4): Endpoints for organization management operations - Invoice [GetInvoiceById](https://docs.amili.dev/getinvoicebyid-4148069e0.md?nav=4): Endpoints for organization management operations - Payment [CreatePayments](https://docs.amili.dev/createpayments-4148070e0.md?nav=4): Endpoints for organization management operations - Settlement [GetSettlements](https://docs.amili.dev/getsettlements-4148071e0.md?nav=4): Endpoints for organization management operations - Settlement [GetSettlement on Id](https://docs.amili.dev/getsettlement-on-id-4148072e0.md?nav=4): Endpoints for organization management operations - AutoCollect Legacy API > Attachment [/webapi/api/Attachment](https://docs.amili.dev/webapiapiattachment-4161130e0.md?nav=4): - AutoCollect Legacy API > Batch [/webapi/api/Batch](https://docs.amili.dev/webapiapibatch-4161131e0.md?nav=4): - AutoCollect Legacy API > Batch [/webapi/api/Batch](https://docs.amili.dev/webapiapibatch-4161132e0.md?nav=4): - AutoCollect Legacy API > Ping [/webapi/api/Ping](https://docs.amili.dev/webapiapiping-4161133e0.md?nav=4): - Actions [POST (create) an action](https://docs.amili.dev/post-create-an-action-4205258e0.md?nav=5): Creates one new action ready for execution. About required input, see the description for each action code - Actions [POST (create) a reports action/generate a report](https://docs.amili.dev/post-create-a-reports-actiongenerate-a-report-4205259e0.md?nav=5): Creates one new reports action (generate a report request, ready for execution). About required input, see the description for each report type code - ArItems [GET a list of AR items](https://docs.amili.dev/get-a-list-of-ar-items-4205260e0.md?nav=5): Get a list of AR items based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - ArItems [PUT (update) ar item details](https://docs.amili.dev/put-update-ar-item-details-4205261e0.md?nav=5): Update details on an existing AR item. Can also be used to create a credit note for an existing invoice or interest note - ArItems [GET one AR item](https://docs.amili.dev/get-one-ar-item-4205262e0.md?nav=5): Get details for one AR item based on AR item ID as path parameter - AutoPostings [POST (create) one or more auto postings](https://docs.amili.dev/post-create-one-or-more-auto-postings-4205263e0.md?nav=5): Performs a set of one or more auto postings. An auto posting is a complex set of debit/credit entries to the GL/AR based on one event. - Batches [GET one batch](https://docs.amili.dev/get-one-batch-4205264e0.md?nav=5): Get details for one batch with asynchronous treatment - ClientConfigs [GET a list of client config values](https://docs.amili.dev/get-a-list-of-client-config-values-4205265e0.md?nav=5): Get details for a list of client config values - ClientConfigs [GET values for one client config key](https://docs.amili.dev/get-values-for-one-client-config-key-4205266e0.md?nav=5): Get details for a client config key - Codes [GET ARM system code values](https://docs.amili.dev/get-arm-system-code-values-4205267e0.md?nav=5): Get details for ARM system code values - Customers [POST (create) one customer](https://docs.amili.dev/post-create-one-customer-4205268e0.md?nav=5): Creates one new customer. If the customer already exists, it will be updated (same as PUT customer, see details under *PUT (update) one customer*). - Customers [PUT (update) one customer](https://docs.amili.dev/put-update-one-customer-4205269e0.md?nav=5): Update details on an existing customer. - Customers [GET a list of customers](https://docs.amili.dev/get-a-list-of-customers-4205270e0.md?nav=5): Get a list with details of one or more customers based on criteria given in query parameters. Default and upper limit maximumCount (maximum total number of records returned per query) = 10000; pageSize (maximum number of records per page) default = 100, pageSize (maximum number of records per page) upper limit = 1000. - Customers [GET one customer](https://docs.amili.dev/get-one-customer-4205271e0.md?nav=5): Get details for one customer based on customerNo as path parameter - Customers [DELETE a customer](https://docs.amili.dev/delete-a-customer-4205272e0.md?nav=5): Delete a customer. Only allowed if the customer has no documents or AR items attached - Customers [POST (create) a batch of customers](https://docs.amili.dev/post-create-a-batch-of-customers-4205273e0.md?nav=5): Creates a batch of new customers. If a customer already exists, it will be updated (same as PUT customer(s), see details under *PUT (update) one customer*). - Customers [PUT (update) a batch of customers](https://docs.amili.dev/put-update-a-batch-of-customers-4205274e0.md?nav=5): Update a batch of customers. - DocumentBundles [GET a list of document bundles](https://docs.amili.dev/get-a-list-of-document-bundles-4205275e0.md?nav=5): Get a list of document bundles based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - DocumentBundles [GET one document bundle](https://docs.amili.dev/get-one-document-bundle-4205276e0.md?nav=5): Get details for one document bundle based on documentBundleId as path parameter - Documents [POST (create) one document](https://docs.amili.dev/post-create-one-document-4205277e0.md?nav=5): Create one document. - Documents [GET a list of documents](https://docs.amili.dev/get-a-list-of-documents-4205278e0.md?nav=5): Get a list of documents based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - Documents [GET one document](https://docs.amili.dev/get-one-document-4205279e0.md?nav=5): Get details for one document based on documentNo as path parameter - Documents [POST (create) a batch of documents](https://docs.amili.dev/post-create-a-batch-of-documents-4205280e0.md?nav=5): Creates a batch of new documents. - Files [GET one or more OS files](https://docs.amili.dev/get-one-or-more-os-files-4205281e0.md?nav=5): Get (download) one or more OS files based on input query parameters. If you input a *logItemId* or a combination of parameters with one specific file *name*, you will only get one file in return. If you query for instance attachment files for a given *referenceNo*, you can get more than one file in return. Maximum count of files delivered is always 10 (cannot be altered). Output data are not paginated - Files [POST (upload) one or more OS files](https://docs.amili.dev/post-upload-one-or-more-os-files-4205282e0.md?nav=5): Upload one or more OS files. Access to upload for different types of OS files are configured for each ARM client - Files [GET one OS file](https://docs.amili.dev/get-one-os-file-4205283e0.md?nav=5): Get (download) one OS file based on log item ID as path parameter. The report or export file connected to the log item will be returned - GlItems [Get one GL item](https://docs.amili.dev/get-one-gl-item-4205284e0.md?nav=5): Get details for one GL item based on GL item ID as path parameter - GlItems [GET a list of GL items](https://docs.amili.dev/get-a-list-of-gl-items-4205285e0.md?nav=5): Get a list of GL items based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - GlMovements [Get movement/balance for the latest closed GL year/period](https://docs.amili.dev/get-movementbalance-for-the-latest-closed-gl-yearperiod-4205286e0.md?nav=5): Get GL movement and incoming/outgoing balance for the latest closed GL year/period - GlMovements [GET a list of GL movements/balances](https://docs.amili.dev/get-a-list-of-gl-movementsbalances-4205287e0.md?nav=5): Get a list of GL periods' movements and incoming/outgoing balances based on criteria given in query parameters. You should input *either* glyear + glperiod *or* a combination of glyearfrom/glperiodfrom and glyearto/glperiodto. Filtering glaccountno is optional - Insights [GET a list of ADB intervals](https://docs.amili.dev/get-a-list-of-adb-intervals-4205288e0.md?nav=5): Get a list of cached ADB (Age Distributed Balance) intervals with relevant values. Items not due will be counted in interval no 0. Then follows 5 intervals (no 1 - 5) with the following lengths (days): 30, 30, 30, 90, 180. The last interval (no 6) is of indefinite length. - LogItems [GET one log item](https://docs.amili.dev/get-one-log-item-4205289e0.md?nav=5): Get details for one log item based on log item ID as path parameter - LogItems [GET a list of log items](https://docs.amili.dev/get-a-list-of-log-items-4205290e0.md?nav=5): Get a list of log items (also referred to as *BatchLog*) based on criteria given in query parameters. Default and upper limit of maximumcount = 10000; pageSize default = 100, pageSize upper limit = 1000. (maximumcount = maximum total number of records returned per query, pagesize = maximum number of records per page) - PaymentReservations [POST (create) a new payment reservation](https://docs.amili.dev/post-create-a-new-payment-reservation-4205291e0.md?nav=5): Creates a new payment reservation connected to an existing document's AR item or to an existing customer. There are alternative ways to identify this document or customer, you must fulfill at least one of them. - Health [Check API health](https://docs.amili.dev/check-api-health-4205292e0.md?nav=5): Check API health