# 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 [ErrorHandling](https://docs.amili.dev/errors.md): - Root > ErrorHandling [How to](https://docs.amili.dev/errors/how-to-handle-errors.md): - Root > ErrorHandling [Codes](https://docs.amili.dev/errors/codes.md): - Root > ErrorHandling > Codes [DUPLICATE_UNIQUE_SOURCE_PAYMENT_ID](https://docs.amili.dev/errors/codes/duplicate-unique-source-payment-id.md): - Root [ArItems](https://docs.amili.dev/joar.md): - Root [AmiliPay API Introduction](https://docs.amili.dev/amilipay-api-introduction-373743m0.md): - Root [Industry Categories Reference](https://docs.amili.dev/industry-categories-reference-373744m0.md): - Root [Webhooks Reference](https://docs.amili.dev/webhooks-reference-373745m0.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): - [ErrorHandling](https://docs.amili.dev/errors.md?nav=4): - ErrorHandling [How to](https://docs.amili.dev/errors/how-to-handle-errors.md?nav=4): - ErrorHandling [Codes](https://docs.amili.dev/errors/codes.md?nav=4): - ErrorHandling > Codes [DUPLICATE_UNIQUE_SOURCE_PAYMENT_ID](https://docs.amili.dev/errors/codes/duplicate-unique-source-payment-id.md?nav=4): - [ArItems](https://docs.amili.dev/joar.md?nav=5): - [AmiliPay API Introduction](https://docs.amili.dev/amilipay-api-introduction-373743m0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): - [Industry Categories Reference](https://docs.amili.dev/industry-categories-reference-373744m0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): - [Webhooks Reference](https://docs.amili.dev/webhooks-reference-373745m0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): ## 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 > Collections [GetCaseTimeline](https://docs.amili.dev/getcasetimeline-4539842e0.md): Endpoints for organization management operations - Root > Collections [GetTaskView](https://docs.amili.dev/gettaskview-4549205e0.md): Endpoints for organization management operations - Root > Collections [UpdateTask](https://docs.amili.dev/updatetask-4549206e0.md): Endpoints for organization management operations - Root > Collections [GetCaseById](https://docs.amili.dev/getcasebyid-4551061e0.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 - Root > Merchant [List all customers](https://docs.amili.dev/list-all-customers-4517974e0.md): Returns the list of customers. You can filter results by customer name using the name query parameter. - Root > Merchant [Create customer](https://docs.amili.dev/create-customer-4517975e0.md): Creates a new customer and returns the created customer payload. - Root > Merchant [Retrieve customer](https://docs.amili.dev/retrieve-customer-4517976e0.md): Returns a single customer by numeric customer_id. - Root > Merchant [Update customer](https://docs.amili.dev/update-customer-4517977e0.md): Updates an existing customer identified by numeric customer_id. - Root > Merchant [Create customer token](https://docs.amili.dev/create-customer-token-4517978e0.md): Creates a merchant-scoped partner API token for the specified customer (a bearer/API-key credential usable with X-API-KEY/Authorization: ApiKey to act as that merchant) - not the onboarding_token returned by POST /customers, which is unrelated and used only for the hosted-onboarding widget. - Root > Merchant [Retrieve pricing for a merchant](https://docs.amili.dev/retrieve-pricing-for-a-merchant-4517979e0.md): Returns the pricing configuration for the specified customer. Also reachable at the plural path GET /v1/customers/{customer_id}/pricing (undocumented alias, same behavior). - Root > Merchant [Update pricing for a merchant](https://docs.amili.dev/update-pricing-for-a-merchant-4517980e0.md): Updates the pricing configuration for the specified customer. - Root > Merchant [List a customer's accepted agreements](https://docs.amili.dev/list-a-customers-accepted-agreements-4517981e0.md): Returns the agreements this customer (merchant) has accepted, with acceptance timestamp and IP. - Root > User [List all users](https://docs.amili.dev/list-all-users-4517982e0.md): Returns the list of dashboard-login users within the caller's account hierarchy (own account for a partner token; all accounts for an admin token). - Root > User [Create user](https://docs.amili.dev/create-user-4517983e0.md): Creates a new user and associates the user with one or more accounts. - Root > User [Retrieve user](https://docs.amili.dev/retrieve-user-4517984e0.md): Returns a single user by UUID user_id. - Root > User [Update user](https://docs.amili.dev/update-user-4517985e0.md): Updates an existing user identified by UUID user_id. - Root > User [Delete user](https://docs.amili.dev/delete-user-4517986e0.md): Deletes a user identified by UUID user_id. This is a soft delete (sets a deleted timestamp), not an irreversible hard delete. - Root > Onboarding [Create onboarding application](https://docs.amili.dev/create-onboarding-application-4517987e0.md): Creates a new onboarding application for a customer account. Only account_id is required to start the application, but full onboarding requires company, payout, and shareholder details. Use hosted onboarding when you want the customer to complete the flow in the embedded widget; use self-hosted onboarding if you collect the data yourself and still finalize it through the hosted widget. Documents for the company and shareholders are uploaded separately through the onboarding documents endpoints. - Root > Onboarding [Retrieve onboarding application](https://docs.amili.dev/retrieve-onboarding-application-4517988e0.md): Returns a single onboarding application by application_id. The response includes the application status, company information, payout information, shareholders, uploaded documents, and timestamps. - Root > Onboarding [Update onboarding application](https://docs.amili.dev/update-onboarding-application-4517989e0.md): Updates an existing onboarding application by application_id. Use this to fill in or correct company, payout, and shareholder data before starting processing. The same UUID identifies the onboarding application throughout the flow. - Root > Onboarding [Delete onboarding application](https://docs.amili.dev/delete-onboarding-application-4517990e0.md): Deletes an onboarding application by application_id. This permanently removes the onboarding application and any associated onboarding progress for that UUID. - Root > Onboarding [Start processing onboarding](https://docs.amili.dev/start-processing-onboarding-4517991e0.md): Starts the onboarding validation and processing flow for the specified application. All required company, bank, shareholder, and document data should be completed before calling this endpoint; otherwise the API returns validation errors instead of processing the onboarding. - Root > Onboarding [Delete onboarding shareholder](https://docs.amili.dev/delete-onboarding-shareholder-4517992e0.md): Deletes a shareholder from an onboarding application. Both application_id and shareholder_id are UUID values. - Root > Onboarding [Create onboarding document](https://docs.amili.dev/create-onboarding-document-4517993e0.md): Uploads a document for an onboarding application. model_id is the UUID of the entity that owns the document, such as a company or shareholder. The document type must match one of the supported onboarding document types, and the content must be base64-encoded file data. - Root > Onboarding [Retrieve onboarding document](https://docs.amili.dev/retrieve-onboarding-document-4517994e0.md): Returns a single onboarding document for the specified application and document IDs. - Root > Onboarding [Delete onboarding document](https://docs.amili.dev/delete-onboarding-document-4517995e0.md): Deletes an onboarding document from the specified application. - Root > Onboarding [Retrieve available account agreements](https://docs.amili.dev/retrieve-available-account-agreements-4517996e0.md): Returns the agreements available to the account. Available to merchant, partner, and admin callers. - Root > Onboarding [Create onboarding agreement](https://docs.amili.dev/create-onboarding-agreement-4517997e0.md): Creates a new onboarding agreement. Partner or admin callers only - merchants cannot create agreements. - Root > Onboarding [Mark selected agreement as an accepted by the account](https://docs.amili.dev/mark-selected-agreement-as-an-accepted-by-the-account-4517998e0.md): Marks the selected agreement as accepted by account_id. Available to merchant, partner, and admin callers. account_id is never taken from the caller's token - it must be supplied explicitly in the body. A partner-API-token caller may only target one of its own direct-child accounts (403 otherwise); a JWT (dashboard user) caller may only target their own active account_id (403 otherwise). - Root > Onboarding [Retrieve a single agreement](https://docs.amili.dev/retrieve-a-single-agreement-4517999e0.md): Returns a single agreement by UUID. Available to merchant, partner, and admin callers. - Root > Onboarding [Update onboarding agreement](https://docs.amili.dev/update-onboarding-agreement-4518000e0.md): Updates the translation for one language of an existing onboarding agreement, identified by {agreement_id} in the path (not in the body). Partner or admin callers only - merchants cannot update agreements. - Root > Onboarding [Deactivate agreement](https://docs.amili.dev/deactivate-agreement-4518001e0.md): Deactivates the specified agreement (soft delete - IsActive set false, not hard-deleted). Partner or admin callers only - merchants cannot deactivate agreements. - Root > Invoice [List all invoices](https://docs.amili.dev/list-all-invoices-4518002e0.md): Returns invoices with optional sorting and filter parameters. Use sort_by and direction to control ordering, and pass filters in the filters[...] query format for status, amount ranges, dates, account, customer, invoice_id, and other supported invoice attributes. - Root > Invoice [Create invoice](https://docs.amili.dev/create-invoice-4518003e0.md): Creates a new invoice. A merchant token creates the invoice under its own account by default; a partner token must supply account_id to target one of its direct-child merchants. Supply the customer, invoice identifier, amount in cents, and due date. Optional fields let you attach an invoice URL, PDF content, payment window redirect URLs, notification settings, language, and recurring payment support. - Root > Invoice [Retrieve invoice](https://docs.amili.dev/retrieve-invoice-4518004e0.md): Returns a single invoice by unique_id. The response includes the invoice data and, when available, payment details such as card summary information. - Root > Invoice [Update invoice](https://docs.amili.dev/update-invoice-4518005e0.md): Updates an existing invoice by unique_id. Use this to adjust payment dates, notification behavior, payment method, invoice documents, or recurring configuration before the invoice is deactivated. - Root > Invoice [Delete invoice](https://docs.amili.dev/delete-invoice-4518006e0.md): Deletes an invoice by unique_id. This removes the invoice from the collection and should only be used when the invoice is no longer needed. A partner token may delete its direct-child merchants' invoices, the same as it may create/update them - this is not merchant-only, and no 403 is returned for a partner caller. Paid invoices cannot be deleted (422). This is a soft delete (sets deleted_at/deactivated_at). - Root > Invoice [Refund invoice](https://docs.amili.dev/refund-invoice-4518007e0.md): Starts a refund for the specified invoice. amount is optional - if omitted, the full remaining invoice amount is refunded; if provided it must be > 0. The cap enforced is the invoice's REMAINING refundable balance (original amount minus any prior refunds already recorded for it), not simply the original invoice amount - a second partial refund can be rejected even though it's below the original total. The invoice must already be paid, with an authorised payment transaction on file, or this returns 422. If currency is not resolvable from the invoice, EUR is used as a fallback. - Root > Transactions [Get invoice transactions](https://docs.amili.dev/get-invoice-transactions-4518008e0.md): Returns the transactions associated with the specified invoice. Use this to inspect payment state, result codes, PSP references, payment method details, and card summary information. - Root > Payout [List all payouts](https://docs.amili.dev/list-all-payouts-4518009e0.md): Returns the list of payout reports with optional sorting and account filters. - Root > Payout [Retrieve payout](https://docs.amili.dev/retrieve-payout-4518010e0.md): Returns a single payout report by payout_id. - Root > Payout [Retrieve payout details](https://docs.amili.dev/retrieve-payout-details-4518011e0.md): Returns the payout transaction details for the specified payout_id. Rows of transaction type Payout or VirtualAccountPayoutReturned are excluded from this response (undocumented elsewhere). - Root > Product lines classification [Upload a CSV file](https://docs.amili.dev/upload-a-csv-file-4518012e0.md): Uploads a CSV file and returns a path you can use with POST /pcm/classify/result to retrieve it again. Product-line classification is not currently available. Accepts either this JSON body (csv as base64) or a multipart/form-data request with a `csv` file field (must end in .csv) and a `language` form field - both are handled by the same endpoint. - Root > Product lines classification [Manually get processed CSV file path](https://docs.amili.dev/manually-get-processed-csv-file-path-4518013e0.md): Returns a download link for a previously uploaded CSV file, addressed by the path returned from POST /pcm/classify. Product-line classification is not currently available - the file returned is unmodified. - Root > Product lines classification [Download a previously uploaded CSV file](https://docs.amili.dev/download-a-previously-uploaded-csv-file-4518014e0.md): Downloads the file at the given path, as returned by POST /pcm/classify or POST /pcm/classify/result. This is a plain, unsigned endpoint - the path query value is used as-is (with path-traversal characters stripped), not a signed/expiring token. Any authenticated merchant/partner/admin caller can request any path, including one belonging to a different account - there is no ownership check on this endpoint today. - 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 - Collections [GetCaseTimeline](https://docs.amili.dev/getcasetimeline-4539842e0.md?nav=4): Endpoints for organization management operations - Collections [GetTaskView](https://docs.amili.dev/gettaskview-4549205e0.md?nav=4): Endpoints for organization management operations - Collections [UpdateTask](https://docs.amili.dev/updatetask-4549206e0.md?nav=4): Endpoints for organization management operations - Collections [GetCaseById](https://docs.amili.dev/getcasebyid-4551061e0.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 - Merchant [List all customers](https://docs.amili.dev/list-all-customers-4517974e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the list of customers. You can filter results by customer name using the name query parameter. - Merchant [Create customer](https://docs.amili.dev/create-customer-4517975e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a new customer and returns the created customer payload. - Merchant [Retrieve customer](https://docs.amili.dev/retrieve-customer-4517976e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single customer by numeric customer_id. - Merchant [Update customer](https://docs.amili.dev/update-customer-4517977e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates an existing customer identified by numeric customer_id. - Merchant [Create customer token](https://docs.amili.dev/create-customer-token-4517978e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a merchant-scoped partner API token for the specified customer (a bearer/API-key credential usable with X-API-KEY/Authorization: ApiKey to act as that merchant) - not the onboarding_token returned by POST /customers, which is unrelated and used only for the hosted-onboarding widget. - Merchant [Retrieve pricing for a merchant](https://docs.amili.dev/retrieve-pricing-for-a-merchant-4517979e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the pricing configuration for the specified customer. Also reachable at the plural path GET /v1/customers/{customer_id}/pricing (undocumented alias, same behavior). - Merchant [Update pricing for a merchant](https://docs.amili.dev/update-pricing-for-a-merchant-4517980e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates the pricing configuration for the specified customer. - Merchant [List a customer's accepted agreements](https://docs.amili.dev/list-a-customers-accepted-agreements-4517981e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the agreements this customer (merchant) has accepted, with acceptance timestamp and IP. - User [List all users](https://docs.amili.dev/list-all-users-4517982e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the list of dashboard-login users within the caller's account hierarchy (own account for a partner token; all accounts for an admin token). - User [Create user](https://docs.amili.dev/create-user-4517983e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a new user and associates the user with one or more accounts. - User [Retrieve user](https://docs.amili.dev/retrieve-user-4517984e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single user by UUID user_id. - User [Update user](https://docs.amili.dev/update-user-4517985e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates an existing user identified by UUID user_id. - User [Delete user](https://docs.amili.dev/delete-user-4517986e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deletes a user identified by UUID user_id. This is a soft delete (sets a deleted timestamp), not an irreversible hard delete. - Onboarding [Create onboarding application](https://docs.amili.dev/create-onboarding-application-4517987e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a new onboarding application for a customer account. Only account_id is required to start the application, but full onboarding requires company, payout, and shareholder details. Use hosted onboarding when you want the customer to complete the flow in the embedded widget; use self-hosted onboarding if you collect the data yourself and still finalize it through the hosted widget. Documents for the company and shareholders are uploaded separately through the onboarding documents endpoints. - Onboarding [Retrieve onboarding application](https://docs.amili.dev/retrieve-onboarding-application-4517988e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single onboarding application by application_id. The response includes the application status, company information, payout information, shareholders, uploaded documents, and timestamps. - Onboarding [Update onboarding application](https://docs.amili.dev/update-onboarding-application-4517989e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates an existing onboarding application by application_id. Use this to fill in or correct company, payout, and shareholder data before starting processing. The same UUID identifies the onboarding application throughout the flow. - Onboarding [Delete onboarding application](https://docs.amili.dev/delete-onboarding-application-4517990e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deletes an onboarding application by application_id. This permanently removes the onboarding application and any associated onboarding progress for that UUID. - Onboarding [Start processing onboarding](https://docs.amili.dev/start-processing-onboarding-4517991e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Starts the onboarding validation and processing flow for the specified application. All required company, bank, shareholder, and document data should be completed before calling this endpoint; otherwise the API returns validation errors instead of processing the onboarding. - Onboarding [Delete onboarding shareholder](https://docs.amili.dev/delete-onboarding-shareholder-4517992e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deletes a shareholder from an onboarding application. Both application_id and shareholder_id are UUID values. - Onboarding [Create onboarding document](https://docs.amili.dev/create-onboarding-document-4517993e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Uploads a document for an onboarding application. model_id is the UUID of the entity that owns the document, such as a company or shareholder. The document type must match one of the supported onboarding document types, and the content must be base64-encoded file data. - Onboarding [Retrieve onboarding document](https://docs.amili.dev/retrieve-onboarding-document-4517994e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single onboarding document for the specified application and document IDs. - Onboarding [Delete onboarding document](https://docs.amili.dev/delete-onboarding-document-4517995e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deletes an onboarding document from the specified application. - Onboarding [Retrieve available account agreements](https://docs.amili.dev/retrieve-available-account-agreements-4517996e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the agreements available to the account. Available to merchant, partner, and admin callers. - Onboarding [Create onboarding agreement](https://docs.amili.dev/create-onboarding-agreement-4517997e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a new onboarding agreement. Partner or admin callers only - merchants cannot create agreements. - Onboarding [Mark selected agreement as an accepted by the account](https://docs.amili.dev/mark-selected-agreement-as-an-accepted-by-the-account-4517998e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Marks the selected agreement as accepted by account_id. Available to merchant, partner, and admin callers. account_id is never taken from the caller's token - it must be supplied explicitly in the body. A partner-API-token caller may only target one of its own direct-child accounts (403 otherwise); a JWT (dashboard user) caller may only target their own active account_id (403 otherwise). - Onboarding [Retrieve a single agreement](https://docs.amili.dev/retrieve-a-single-agreement-4517999e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single agreement by UUID. Available to merchant, partner, and admin callers. - Onboarding [Update onboarding agreement](https://docs.amili.dev/update-onboarding-agreement-4518000e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates the translation for one language of an existing onboarding agreement, identified by {agreement_id} in the path (not in the body). Partner or admin callers only - merchants cannot update agreements. - Onboarding [Deactivate agreement](https://docs.amili.dev/deactivate-agreement-4518001e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deactivates the specified agreement (soft delete - IsActive set false, not hard-deleted). Partner or admin callers only - merchants cannot deactivate agreements. - Invoice [List all invoices](https://docs.amili.dev/list-all-invoices-4518002e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns invoices with optional sorting and filter parameters. Use sort_by and direction to control ordering, and pass filters in the filters[...] query format for status, amount ranges, dates, account, customer, invoice_id, and other supported invoice attributes. - Invoice [Create invoice](https://docs.amili.dev/create-invoice-4518003e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Creates a new invoice. A merchant token creates the invoice under its own account by default; a partner token must supply account_id to target one of its direct-child merchants. Supply the customer, invoice identifier, amount in cents, and due date. Optional fields let you attach an invoice URL, PDF content, payment window redirect URLs, notification settings, language, and recurring payment support. - Invoice [Retrieve invoice](https://docs.amili.dev/retrieve-invoice-4518004e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single invoice by unique_id. The response includes the invoice data and, when available, payment details such as card summary information. - Invoice [Update invoice](https://docs.amili.dev/update-invoice-4518005e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Updates an existing invoice by unique_id. Use this to adjust payment dates, notification behavior, payment method, invoice documents, or recurring configuration before the invoice is deactivated. - Invoice [Delete invoice](https://docs.amili.dev/delete-invoice-4518006e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Deletes an invoice by unique_id. This removes the invoice from the collection and should only be used when the invoice is no longer needed. A partner token may delete its direct-child merchants' invoices, the same as it may create/update them - this is not merchant-only, and no 403 is returned for a partner caller. Paid invoices cannot be deleted (422). This is a soft delete (sets deleted_at/deactivated_at). - Invoice [Refund invoice](https://docs.amili.dev/refund-invoice-4518007e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Starts a refund for the specified invoice. amount is optional - if omitted, the full remaining invoice amount is refunded; if provided it must be > 0. The cap enforced is the invoice's REMAINING refundable balance (original amount minus any prior refunds already recorded for it), not simply the original invoice amount - a second partial refund can be rejected even though it's below the original total. The invoice must already be paid, with an authorised payment transaction on file, or this returns 422. If currency is not resolvable from the invoice, EUR is used as a fallback. - Transactions [Get invoice transactions](https://docs.amili.dev/get-invoice-transactions-4518008e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the transactions associated with the specified invoice. Use this to inspect payment state, result codes, PSP references, payment method details, and card summary information. - Payout [List all payouts](https://docs.amili.dev/list-all-payouts-4518009e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the list of payout reports with optional sorting and account filters. - Payout [Retrieve payout](https://docs.amili.dev/retrieve-payout-4518010e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a single payout report by payout_id. - Payout [Retrieve payout details](https://docs.amili.dev/retrieve-payout-details-4518011e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns the payout transaction details for the specified payout_id. Rows of transaction type Payout or VirtualAccountPayoutReturned are excluded from this response (undocumented elsewhere). - Product lines classification [Upload a CSV file](https://docs.amili.dev/upload-a-csv-file-4518012e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Uploads a CSV file and returns a path you can use with POST /pcm/classify/result to retrieve it again. Product-line classification is not currently available. Accepts either this JSON body (csv as base64) or a multipart/form-data request with a `csv` file field (must end in .csv) and a `language` form field - both are handled by the same endpoint. - Product lines classification [Manually get processed CSV file path](https://docs.amili.dev/manually-get-processed-csv-file-path-4518013e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Returns a download link for a previously uploaded CSV file, addressed by the path returned from POST /pcm/classify. Product-line classification is not currently available - the file returned is unmodified. - Product lines classification [Download a previously uploaded CSV file](https://docs.amili.dev/download-a-previously-uploaded-csv-file-4518014e0.md?nav=01M3BRCFGNCNRTJ79E9FS4961E): Downloads the file at the given path, as returned by POST /pcm/classify or POST /pcm/classify/result. This is a plain, unsigned endpoint - the path query value is used as-is (with path-traversal characters stripped), not a signed/expiring token. Any authenticated merchant/partner/admin caller can request any path, including one belonging to a different account - there is no ownership check on this endpoint today.