Monto API (v2)

Download OpenAPI specification:Download

E-mail: dev@monto.ai License: Monto AB

About this API

The API is built as a "RESTFUL" API with JSON as data transfer.

RateLimit

This API has a rate limit of 10 request / second for each unique API key. A status code of 429 (Too Many Requests) will be returned if breached.

Page size limit

For endpoints that supports pagination with a cursor parameter, there is a maximum page-size of 200. A status code of 422 (Unprocessable Entity) will be returned if max page size is breached.

DateTime fields

All date-time fields are using the ISO-8601 format (ex 2019-06-13T09:29:12+02:00). Usually specified in local time. Dates are specified in the Y-m-d format (ex 2001-03-10).

Postman

Postman supports open api, click on the download button above and import directly to postman.

Integration

An Integration represents a data source, that a Company can connect towards via Connection's.

Get integrations

Returns all integrations supported by Monto.

SecurityAPIKeyAuth
Request
query Parameters
cursor
string <uuid>

The cursor to start from.

size
integer <int32>
Default: 50

The pagination page size.

Responses
200

OK

Get integration

Returns a single integration.

SecurityAPIKeyAuth
Request
path Parameters
integration-key
required
string

The key of a specific Integration.

Example: FORTNOX
Responses
200

OK

404

Not Found

get/integrations/{integration-key}
Response samples
application/json
{
  • "key": "FORTNOX",
  • "label": "Fortnox",
  • "sourceType": "ERP",
  • "authType": "REDIRECT",
  • "enabled": true,
  • "fields": [ ]
}

Connection

A Connection represents a link between a Company and a third-party Integration.

Get connections

Get a list of all Connections.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/connections
Response samples
application/json
{
  • "connections": [
    ]
}

Create connection

Creates a new Connection.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Request Body schema: application/json
integrationKey
string (IntegrationEnum)

The key of the Integration.

Enum: "FORTNOX" "SANDBOX" "VISMA_EEKONOMI" "PEACCOUNTING" "BJORNLUNDEN" "MS_DYNAMICS" "BILLOGRAM" "POWER_OFFICE" "VISMA_NET" "TRIPLETEX"
redirectUrl
string

An redirect url to which the end user is redirected to after completing the auth steps. Only required on integrations with authType REDIRECT

Array of objects

An array of fields, specified on each Integration.

Responses
200

OK

404

Not Found

422

Unprocessable Entity

post/companies/{company-uuid}/connections
Request samples
application/json
{}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "status": "PENDING",
  • "integration": {
    },
  • "lastUsedAt": null,
  • "createdAt": "2022-01-01T17:00:00Z"
}

Update connection

Updates a Connection by UUID.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
connection-uuid
required
string <uuid>

Unique identifier of connection.

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Request Body schema: application/json
status
string

The status of an Connection.

Enum: "ENABLED" "DISABLED_MANUALLY"
Responses
200

OK

404

Not Found

422

Unprocessable Entity

patch/companies/{company-uuid}/connections/{connection-uuid}
Request samples
application/json
{
  • "status": "DISABLED_MANUALLY"
}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "status": "PENDING",
  • "integration": {
    },
  • "lastUsedAt": null,
  • "createdAt": "2022-01-01T17:00:00Z"
}

Company

A Company represents a business, sharing access to their data via Connections.

Get companies

Returns a list of companies.

SecurityAPIKeyAuth
Request
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

search
string >= 2

Search for companies by name, legalName, or businessId.

status
string

A company has one of the following statuses:

  • NO_CONNECTION: If the company has no connections.
  • PENDING_CONNECTION: If the company has a pending connection.
  • SYNC_FAILED: If the initial or nightly sync has failed for this company.
  • UP_TO_DATE: If the initial and nightly sync was completed.
  • SYNC_IN_PROGRESS: If a sync is currently in progress.
Enum: "NO_CONNECTION" "PENDING_CONNECTION" "SYNC_FAILED" "UP_TO_DATE" "SYNC_IN_PROGRESS"
Responses
200

OK

get/companies
Response samples
application/json
{}

Create company

Create a new company.

SecurityAPIKeyAuth
Request
Request Body schema: application/json
name
string

Name of the company

Responses
200

OK

422

Unprocessable Entity

post/companies
Request samples
application/json
{
  • "name": "Monto AB"
}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "name": "Monto AB",
  • "legalName": "Monto AB",
  • "businessId": "559028-3601",
  • "contactFirstName": "Erik",
  • "contactLastName": "Steve",
  • "email": "contact@company.com",
  • "phone1": 123456789,
  • "phone2": 123456789,
  • "hasConnections": true,
  • "syncStatus": "PENDING",
  • "status": "NO_CONNECTION",
  • "addresses": [
    ]
}

Get company

Returns a single company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "name": "Monto AB",
  • "businessId": "559028-3601",
  • "contactFirstName": "Erik",
  • "contactLastName": "Steve",
  • "email": "contact@company.com",
  • "phone1": 123456789,
  • "phone2": 123456789,
  • "status": "NO_CONNECTION",
  • "addresses": [
    ],
  • "sniCode": 12345,
  • "sniGroup": "Datakonsultverksamhet",
  • "sniDetails": "Data, IT & Telekommunikation"
}

Delete company

Deletes a company

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

delete/companies/{company-uuid}
Response samples
application/json
{
  • "status": "success"
}

Account Transaction

Account Transactions represents all activities within a Journal Entry.

Get account transactions

Returns a list of account transactions for a company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

accounts
string

A text explaining which account(s) to be included

Example: accounts=1500-1599,1667,1200-1299
updatedAt
string

Filter on updatedAt. The endpoint will return all entities that have been updated after the specified date.

Example: updatedAt=2022-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/account-transactions
Response samples
application/json
{}

Journal

A Journal represents all business activies registered as Journal Entries.

Get journal entries

Returns a list of all Journal Entries for a Company sorted by Journal date desc.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

fromDate
string

Filter from specified Journal date

Example: fromDate=2021-12-31
updatedAt
string

Filter on updatedAt. The endpoint will return all entities that have been updated after the specified date.

Example: updatedAt=2022-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/journals
Response samples
application/json
{}

Get journal entry

Returns a single Journal Entry for a Company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
journal-uuid
required
string <uuid>

Unique identifier of journal

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/journals/{journal-uuid}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "number": 14,
  • "currency": "SEK",
  • "series": "A",
  • "description": "Kassarapport 2022-01-01",
  • "date": "2022-01-01T17:00:00Z",
  • "registrationDate": "2022-01-01T17:00:00Z",
  • "fiscalYear": {
    },
  • "updatedAt": "2022-01-01T17:00:00Z",
  • "accountTransactions": [
    ]
}

Account

Accounts are used to register account transactions in Journal Entries.

Get accounts

Returns the account values, separated for each account of the selected accounts

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

accounts
required
string

A text explaining which account(s) to be included. This can either be a range of accounts (1500-1599) or a single account (1667).

Example: accounts=1500-1599,1667,1200,1299
fromDate
string
Default: "Default fromDate is 36 months back"

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/accounts
Response samples
application/json

Get account bundles

Returns an aggregated bundle of Account Transactions for a Company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
accounts
required
string

A text explaining which account(s) to be included. This can either be a range of accounts (1500-1599) or a single account (1667).

Example: accounts=1500-1599,1667,1200-1299
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/account-bundles
Response samples
application/json
{
  • "accounts": "1500-1599,1667,1200-1299",
  • "name": "Aggregated values for selected accounts.",
  • "history": [
    ]
}

Account chart

An account chart is a list of all accounts that a company has in its general ledger.

Get account chart

Returns an account chart for a company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
search
string

Search for an account by either its name or number.

Example: search=Patent
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/account-charts
Response samples
application/json
{
  • "accountCharts": [
    ]
}

Fiscal Year

A fiscal year of the company.

Get fiscal years

Returns a list of fiscal years.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

Responses
200

OK

Reliability

Get reliability dates

Returns reliability dates for a company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of a company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/reliabilities
Response samples
application/json
{
  • "ranges": [
    ],
  • "updatedAt": "2022-01-01T17:00:00Z"
}

Liquidity

A Liquidity forecast contains predictions on a company's future liquidity position.

Get liquidity forecasts (alpha version)

This is an alpha version of the endpoint. It's subject to change and not recommended for production use. Returns liquidity forecasts for a company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of a company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/liquidities
Response samples
application/json
{
  • "predictionDate": "2022-01-01T17:00:00Z",
  • "forecast": {
    },
  • "history": {
    }
}

Cashflow

Get cash flow statements

Returns cash flow statements for a company. Response is only available for API consumers that have access to the feature. Please talk to your Monto contact or support@monto.ai for details.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of a company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/cash-flow-statements
Response samples
application/json
{
  • "operatingActivities": {
    },
  • "changeInOperatingCapital": {
    },
  • "investmentActivities": {
    },
  • "financingActivities": {
    }
}

Get cash flow statements PDF

Returns cash flow statement results for a Company, in a PDF file. Response is only available for API consumers that have access to the feature. Please talk to your Monto contact or support@monto.ai for details.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

Ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/cash-flow-statements/pdf

Balance Sheet

A Balance Sheet shows the monthly balances by pre-defined account groups.

Get balance sheets

Returns bundled account balances for a Company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
classic
boolean

A classic balance sheet will not include the following account groups: longTermLiabilitiesToCreditInstitutions, otherLongTermLiabilities, accountPayables, totalLiabilities

Example: classic=true
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/balance-sheets
Response samples
application/json
{
  • "intangibleFixedAssets": {
    },
  • "tangibleFixedAssets": {
    },
  • "financialFixedAssets": {
    },
  • "capitalAssets": {
    },
  • "inventoriesEtc": {
    },
  • "receivables": {
    },
  • "shortTermInvestments": {
    },
  • "cashAndBank": {
    },
  • "currentAssets": {
    },
  • "totalAssets": {
    },
  • "equity": {
    },
  • "untaxedReserves": {
    },
  • "provisions": {
    },
  • "longTermLiabilities": {
    },
  • "longTermLiabilitiesToCreditInstitutions": {
    },
  • "otherLongTermLiabilities": {
    },
  • "shortTermLiabilities": {
    },
  • "accountPayables": {
    },
  • "totalLiabilities": {
    },
  • "equityAndLiabilities": {
    },
  • "calculatedResult": {
    }
}

Get balance sheets PDF

Returns bundled account balances for a Company, in a PDF file.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

Ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/balance-sheets/pdf

Income Statement

An Income Statement shows the aggregated operating income and operating costs, by pre-defined account groups.

Get income statements

Returns bundled account results for a Company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
resultType
string
Default: "MONTHLY36"

Monthly results for the latest 36 months or aggregated rolling results per 12 months.

Enum: "MONTHLY36" "ROLLING12"
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
classic
boolean

A classic income statement will not include the following account groups: interestToCreditInstitutions, otherFinancialExpenses and financialIncome

Example: classic=true
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/income-statements
Response samples
application/json
{
  • "netSales": {
    },
  • "ownWorkCapitalized": {
    },
  • "otherOperatingIncome": {
    },
  • "totalRevenue": {
    },
  • "purchaseGoodsMaterials": {
    },
  • "unspecifiedAccounts": {
    },
  • "changeInInventories": {
    },
  • "grossProfit": {
    },
  • "otherExternalOperatingExpenses": {
    },
  • "personnelCosts": {
    },
  • "ebitda": {
    },
  • "writeDowns": {
    },
  • "depreciations": {
    },
  • "otherOperatingExpenses": {
    },
  • "ebit": {
    },
  • "financialAndOtherIncomes": {
    },
  • "extraordinaryIncomeAndExpenses": {
    },
  • "appropriations": {
    },
  • "taxes": {
    },
  • "financialYearResult": {
    },
  • "earningsAfterTaxes": {
    },
  • "operatingCosts": {
    },
  • "calculatedResult": {
    }
}

Get income statements PDF

Returns bundled account results for a Company, in a PDF file.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

Ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/income-statements/pdf

Metrics

A financial KPI or metric is a measurable value that indicates a company’s financial results and performance, provides information about expenses, sales, profit, and cash flow, in order to optimize and achieve business’ financial goals and objectives.

Get metrics

Returns metrics for a Company.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Starting date

Example: fromDate=2021-12-31
toDate
string

ending date

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

422

Unprocessable Entity

get/companies/{company-uuid}/metrics
Response samples
application/json
{
  • "profitMargin": {
    },
  • "interestCoverageRatio": {
    },
  • "equityToAssetsRatio": {
    },
  • "returnOnAssets": {
    },
  • "returnOnEquity": {
    },
  • "currentRatio": {
    },
  • "cashRatio": {
    },
  • "grossMargin": {
    },
  • "quickRatio": {
    }
}

Supplier

A supplier who has sent supplier invoice(s) to the company.

Get suppliers

Returns a list of suppliers.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

Responses
200

OK

404

Not Found

get/companies/{company-uuid}/suppliers
Response samples
application/json
{}

Supplier Insight

Insights regarding a company's suppliers.

Get supplier insights

Returns insights on a suppliers.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/supplier-insights
Response samples
application/json
{
  • "supplierSpread": [
    ],
  • "sniSpread": [
    ],
  • "totalAmountOfSupplierInvoices": 0,
  • "totalBalanceAllSuppliers": [
    ]
}

Customer

A customer of the company.

Get customers

Returns a list of customers.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

search
string >= 1

Search for customer by its customer's name.

sortedBy
string

Comma-separated list of columns to sort by. This parameter is required if order has a value. Available options:

  • uuid
  • name
  • businessId
Example: sortedBy=name, businessId
order
string

Comma-separated list of sorting orders corresponding to the columns in sortedBy. Use 'asc' for ascending and 'desc' for descending. This parameter is required if sortedBy has a value.

Example: order=desc, asc
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customers
Response samples
application/json
{}

Customer Insight

Insights regarding a company's customers.

Get customer insights

Returns insights on a company's customers.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-insights
Response samples
application/json
{
  • "customerSpread": [
    ],
  • "sniSpread": [
    ],
  • "totalAmountOfSupplierInvoices": 0,
  • "totalBalanceAllSuppliers": [
    ]
}

Customer Invoice Payment

Payments made to the Customer Invoice.

Get payments

Returns a list of payments for a customer invoice.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
invoice-uuid
required
string <uuid>

Unique identifier of customer invoice

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-invoices/{invoice-uuid}/payments
Response samples
application/json
{
  • "payments": [
    ]
}

Customer Invoice

A record of sold goods or provided services to a Customer with a payment in demand.

Get customer invoices

Returns a list of customer invoices.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

search
string >= 1

Search for invoices by invoice_number or by its customer's name.

filterBy
string

Filter field to be used

Enum: "issueDate" "dueDate"
Example: filterBy=dueDate
fromDate
string

Filter on filter by field

Example: fromDate=2021-12-31
toDate
string

Filter on filter by field

Example: toDate=2021-12-31
sortedBy
string

Comma-separated list of columns to sort by. This parameter is required if order has a value. Available options:

  • uuid,
  • invoiceNumber,
  • amount.amount,
  • amount.currency,
  • balance.amount,
  • balance.currency,
  • issueDate,
  • dueDate,
  • paidInFullDate,
  • customer.name
Example: sortedBy=amount, invoiceNumber
order
string

Comma-separated list of sorting orders corresponding to the columns in sortedBy. Use 'asc' for ascending and 'desc' for descending. This parameter is required if sortedBy has a value.

Example: order=desc, asc
createdAt
string

Filter on createdAt. The endpoint will return all entities that have been created after the specified date.

Example: createdAt=2022-12-31
updatedAt
string

Filter on updatedAt. The endpoint will return all entities that have been updated after the specified date.

Example: updatedAt=2022-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-invoices
Response samples
application/json
{}

Get customer invoice

Returns a single customer invoice.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
invoice-uuid
required
string <uuid>

Unique identifier of customer invoice

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-invoices/{invoice-uuid}
Response samples
application/json
{
  • "uuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "invoiceNumber": "302",
  • "ocr": "72349263847",
  • "customer": {
    },
  • "amount": {
    },
  • "amountBaseCurrency": {
    },
  • "issueDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "paidInFullDate": "2019-08-24",
  • "balance": {
    },
  • "balanceBaseCurrency": {
    },
  • "connection": {
    },
  • "payments": [
    ],
  • "deliveryDate": "2019-08-24",
  • "createdAt": "2019-08-24",
  • "updatedAt": "2019-08-24",
  • "ourReference": "John Nilsson",
  • "yourReference": "string",
  • "invoiceRows": [
    ]
}

Get customer invoice pdf

Returns a pdf for a single customer invoice. Response is only available for API consumers that have access to the feature. Please talk to your Monto contact or support@monto.ai for details.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
invoice-uuid
required
string <uuid>

Unique identifier of customer invoice

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-invoices/{invoice-uuid}/pdf

Get customer invoice insights

Returns insights on month by month a company's customer invoices.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Filter on issueDate

Example: fromDate=2023-01-01
toDate
string

Filter on issueDate

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/customer-invoice-insights
Response samples
application/json
{
  • "amountTotalInvoices": {
    },
  • "amountNotDueNotPaidInvoices": {
    },
  • "amountOverDueNotPaidInvoices": {
    },
  • "averagePaymentTerms": {
    },
  • "averageOverdueDays": {
    }
}

Supplier Invoice

A record of bought goods or received services to a Supplier with a payment in demand.

Get supplier invoice insights (alpha version)

This is an alpha version of the endpoint. It's subject to change and not recommended for production use. Returns insights on month by month a company's supplier invoices.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
fromDate
string

Filter on issueDate

Example: fromDate=2023-01-01
toDate
string

Filter on issueDate

Example: toDate=2021-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/supplier-invoice-insights
Response samples
application/json
{
  • "amountTotalInvoices": {
    },
  • "amountNotDueNotPaidInvoices": {
    },
  • "amountOverDueNotPaidInvoices": {
    },
  • "averagePaymentTerms": {
    },
  • "averageOverdueDays": {
    }
}

Get supplier invoices

Returns a list of supplier invoices.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
query Parameters
size
integer <int32>
Default: 50

The pagination page size.

cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

filterBy
string

Filter field to be used

Enum: "issueDate" "dueDate"
Example: filterBy=dueDate
search
string >= 1

Search for supplier invoices by invoice_number or by its supplier's name.

fromDate
string

Filter on filter by field

Example: fromDate=2021-12-31
toDate
string

Filter on filter by field

Example: toDate=2021-12-31
sortedBy
string

Comma-separated list of columns to sort by. This parameter is required if order has a value. Available options:

  • uuid,
  • externalId,
  • invoiceNumber,
  • amount.amount,
  • amount.currency,
  • issueDate,
  • dueDate,
  • balance.amount,
  • balance.currency,
  • paidInFullDate,
  • supplier.name
Example: sortedBy=amount, invoiceNumber
order
string

Comma-separated list of sorting orders corresponding to the columns in sortedBy. Use 'asc' for ascending and 'desc' for descending. This parameter is required if sortedBy has a value.

Example: order=desc, asc
createdAt
string

Filter on createdAt. The endpoint will return all entities that have been created after the specified date.

Example: createdAt=2022-12-31
updatedAt
string

Filter on updatedAt. The endpoint will return all entities that have been updated after the specified date.

Example: updatedAt=2022-12-31
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/supplier-invoices
Response samples
application/json
{}

Supplier Invoice Payment

Payments made to the Supplier Invoice.

Get payments

Returns a list of payments for a supplier invoice.

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
supplier-invoice-uuid
required
string <uuid>

Unique identifier of supplier invoice

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/supplier-invoices/{supplier-invoice-uuid}/payments
Response samples
application/json
{
  • "payments": [
    ]
}

Subscription

In order to avoid polling for changes, we allow you to register subscriptions that will notify you when certain event occurs.

Get subscriptions

Returns a list of your registered subscriptions.

SecurityAPIKeyAuth
Request
query Parameters
cursor
string

The cursor to start from. This parameter is used for pagination in cursor-paginated endpoints. It points to the position in the dataset where the next set of results should be fetched from.

size
integer <int32>
Default: 50

The pagination page size.

Responses
200

OK

Create subscription

Create a new subscription.

SecurityAPIKeyAuth
Request
Request Body schema: application/json
protocol
string (SubscriptionProtocolEnum)

The protocol of the subscription.

Enum: "HTTPS" "EMAIL" "EMAIL_JSON" "SQS" "APPLICATION" "LAMBDA"
endpoint
string

The endpoint of the subscription. Make sure to verify the endpoint once created.

topics
Array of strings

The specified topics of the subscription.

Items Enum: "*" "CONNECTION_ESTABLISHED" "CUSTOMER_INVOICE_CREATED" "CUSTOMER_INVOICE_UPDATED" "SUPPLIER_INVOICE_CREATED" "SUPPLIER_INVOICE_UPDATED" "CUSTOMER_INVOICE_IMPORTER_JOBS_DONE" "SUPPLIER_INVOICE_IMPORTER_JOBS_DONE" "ACCOUNTINGS_JOBS_DONE" "SYNC_COMPLETED" "SYNC_FAILED" "MESSAGE_CREATED"
Responses
200

OK

422

Unprocessable Entity

post/subscriptions
Request samples
application/json
{}
Response samples
application/json
{}

Delete subscription

Delete an existing subscription.

SecurityAPIKeyAuth
Request
path Parameters
subscription-uuid
required
string <uuid>

Unique identifier of a subscription

Example: e9bb5e02-b2e1-46a3-93fb-82dbe277087e
Responses
200

OK

404

Not Found

delete/subscriptions/{subscription-uuid}

Example webhook

The body described here of the webhook will included as a json string inside the field message. Full example of the actual webhook:

{
  "Type": "Notification",
  "MessageId": "8e49fb24-d140-5026-80d5-a0d152c677b7",
  "TopicArn": "arn:aws:sns:eu-north-1:580873861511:capcito-CONNECTION_ESTABLISHED",
  "Message": "{\"topic\":\"CONNECTION_ESTABLISHED\",\"entityUuid\":\"3b097418-bdfe-4cb4-a7e4-a2274d8b9f3b\",\"companyUuid\":\"d5ab0237-815b-48a1-b6bb-2758a30b64ab\"}",
  "Timestamp": "2022-11-21T13:46:46.691Z",
  "SignatureVersion": "1",
  "Signature": "ryZrfmXzSjqLmK1pUiAZAAy2jg+jTTxDwIqZgB+pMXp2GBh0+wXznVrLDX6Y+qzFqruaPEtDEnci8qpvbzq3dbpFfkspXqTEnDPC5L+I9xPeMDEoQTqKvU6rLV4uLQEO+KvtQAZgcZEYnqzkY6VMnmIAvU6FP+5DZS84+kuL6epQYzUCRNFOEzVLY3sW0ieQX3d4hpOeZlD+0UaKe2RaVZaQd8L3mf7tsER6Vxkl7FkEvRCTy/6OgeZYaIwJGNqSefqnIJFCgE70UCPJ4HStSDlKoZ/vju8c6rKZdsz/iCHqyBC22PoWKi0QLF4X7KME3ZCYJMElALZ50LFuFtJW0w==",
  "SigningCertURL": "https://sns.eu-north-1.amazonaws.com/SimpleNotificationService-56e67fcb41f6fec09b0196692625d385.pem",
  "UnsubscribeURL": "https://sns.eu-north-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-north-1:580873861511:capcito-CONNECTION_ESTABLISHED:323b0a2c-0a8e-4ccc-b606-7d96b29ff097"
}
SecurityAPIKeyAuth
Request
Request Body schema: application/json
entityUuid
string

Unique identifier for the entity.

companyUuid
string

Unique identifier for the affected company

topic
string

The topic of the received event.

Enum: "CONNECTION_ESTABLISHED" "CUSTOMER_INVOICE_CREATED" "CUSTOMER_INVOICE_UPDATED" "SUPPLIER_INVOICE_CREATED" "SUPPLIER_INVOICE_UPDATED" "CUSTOMER_INVOICE_IMPORTER_JOBS_DONE" "SUPPLIER_INVOICE_IMPORTER_JOBS_DONE" "ACCOUNTINGS_JOBS_DONE" "SYNC_COMPLETED" "SYNC_FAILED" "MESSAGE_CREATED"
Responses
200

OK

post/webhook
Request samples
application/json
{
  • "entityUuid": "9e0a58e5-60b5-4c15-ba2e-77b1bed4977d",
  • "companyUuid": "d5ab0237-815b-48a1-b6bb-2758a30b64ab",
  • "topic": "CUSTOMER_INVOICE_CREATED"
}
Response samples
application/json
{}

Message

A message notifies and highlights changes for a company.

Get messages

Returns a list of messages for a company

SecurityAPIKeyAuth
Request
path Parameters
company-uuid
required
string <uuid>

Unique identifier of company

Example: 9e0a58e5-60b5-4c15-ba2e-77b1bed4977d
Responses
200

OK

404

Not Found

get/companies/{company-uuid}/messages
Response samples
application/json
{}