Aritma Banking API (v3)

Download OpenAPI specification:Download

Account

POST request for new bank integration

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
Request Body schema:

Update model

companyId
required
string <uuid>

Company id to associate with bankaccount

accountNumber
required
string >= 6 characters

Account number

bic
required
string

Bank identifier code

currency
string or null

Currency

ledger
string or null

Ledger

object (BankAccountAliases)
Responses
200

Returns account id. Request added for ZData approval

400

Invalid model

401

User not authorized

post/api/v3/accounts/bank
Request samples
{
  • "Bic": "DNBANOKK",
  • "Currency": "NOK",
  • "Ledger": "1920",
  • "Aliases": {
    },
  • "CompanyId": "262d3f94-8817-487b-98d7-8f91b9ecb308",
  • "AccountNumber": "123456789012"
}
Response samples
No sample

Lists all accounts for a company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

Responses
200

A list of accounts

401

Unauthorized

404

Accounts for company not found

get/api/v3/accounts/{companyId}
Request samples
Response samples
{
  "CompanyId": "7ddde189-f85f-4803-941b-928ac9eae094",
  "Accounts": [
    {
      "AccountId": "602c2ef9-d98f-4553-ab8f-9fb0b0fd2379",
      "AccountNumber": "123456789012",
      "Bic": "DNBANOKK",
      "Currency": "NOK",
      "AccountGroupId": "a8d7822d-f6cb-40df-9a02-78915d5d0c4b",
      "Ledger": "1920",
      "Aliases": {
        "Iban": "NO22123456789012",
        "PlusGirot": "1234567",
        "BankGirot": "1234567",
        "GiroKonto": "1234567"
      },
      "ReadyForPayments": true
    }
  ]
}

Get account status for creating payments

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
bban
required
string or null

BBAN

Responses
200

The account status for creating payments

401

Unauthorized

404

Account not found

get/api/v3/accounts/{bban}/readiness
Request samples
Response samples
No sample

Get account data for a specific account in a specific company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

bankAccountId
required
string or null

Bank account id or bban

Responses
200

The account details

401

Unauthorized

404

Account not found

get/api/v3/accounts/{companyId}/{bankAccountId}
Request samples
Response samples
{
  "AccountId": "0e4b4d5c-d600-43d2-8310-7742df34b65f",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "8c0f3b68-f89f-43d8-9c9d-00e2134f4d34",
  "Ledger": "1920",
  "Aliases": {
    "Iban": "NO22123456789012",
    "PlusGirot": "1234567",
    "BankGirot": "1234567",
    "GiroKonto": "1234567"
  }
}

Updates bankaccount

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

bankAccountId
required
string <uuid>

Bank account id

Request Body schema:

Bank account model

bic
required
string

Bank identifier code

currency
string or null

Currency

ledger
string or null

Ledger

object (BankAccountAliases)
Responses
200

The updated account details

400

Invalid update request

401

Unauthorized

404

Account not found

put/api/v3/accounts/{companyId}/{bankAccountId}
Request samples
{
  • "Bic": "DNBANOKK",
  • "Currency": "NOK",
  • "Ledger": "1920",
  • "Aliases": {
    }
}
Response samples
{
  "AccountId": "7cd703c8-0bbb-48cd-9dcd-0a3a6e242b2f",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "2722b867-0522-4f43-a2b0-7ab1cc918bb9",
  "Ledger": "1920",
  "Aliases": {
    "Iban": "NO22123456789012",
    "PlusGirot": "1234567",
    "BankGirot": "1234567",
    "GiroKonto": "1234567"
  }
}

Deletes an account by companyId and accountId

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

bankAccountId
required
string <uuid>

Bank account id

Responses
200

Deleted

400

Account connected to statement, balance, receivable or payment

401

Unauthorized

403

Action not permitted for user

404

Account not found

delete/api/v3/accounts/{companyId}/{bankAccountId}
Request samples
Response samples
No sample

Changes company on bankaccount

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
bankAccountId
required
string <uuid>

Bank account id

Request Body schema:

Request with new company id

companyId
required
string <uuid>

New company id

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Account not found

put/api/v3/accounts/{bankAccountId}/companySwitch
Request samples
{
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda"
}
Response samples
{
  "AccountId": "4dcbec57-a1b0-4598-aa10-8c0f6473d070",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "8c799861-6dcc-4597-9e1f-2601f9d014f3",
  "Ledger": "1920",
  "Aliases": {
    "Iban": "NO22123456789012",
    "PlusGirot": "1234567",
    "BankGirot": "1234567",
    "GiroKonto": "1234567"
  }
}

AccountGroup

Get all account groups for company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
query Parameters
includeUnassociated
boolean
Default: false
includeUnassociatedDaughters
boolean
Default: false
Responses
200

Account groups for company

401

Unauthorized

403

Action not permitted for user

404

Company not found

get/api/v3/accountgroups/{companyId}
Request samples
Response samples
No sample

Get account group by AccountGroupId

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
Responses
200

Account groups

401

Unauthorized

403

Action not permitted for user

404

Account group not found

get/api/v3/accountgroups/{companyId}/{accountGroupId}
Request samples
Response samples
No sample

Update account group name

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
Request Body schema:
name
string or null
Responses
200
401

Unauthorized

403

Action not permitted for user

404

Account group not found

put/api/v3/accountgroups/{companyId}/{accountGroupId}
Request samples
{
  • "name": "string"
}
Response samples
No sample

Delete account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
Responses
200
401

Unauthorized

403

Action not permitted for user

404

Account group not found

delete/api/v3/accountgroups/{companyId}/{accountGroupId}
Request samples
Response samples
No sample

Post new account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
Request Body schema:
companyId
string <uuid>
name
string or null
Responses
200
401

Unauthorized

403

Action not permitted for user

404

Company not found

post/api/v3/accountgroups
Request samples
{
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "name": "string"
}
Response samples
No sample

Add user to account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
Request Body schema:
id
string <uuid>
Responses
200
401

Unauthorized

403

Action not permitted for user

404

User/Account group not found

post/api/v3/accountgroups/{companyId}/{accountGroupId}/user
Request samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Response samples
No sample

Remove user from account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
userId
required
string <uuid>
Responses
200
401

Unauthorized

403

Action not permitted for user

404

User/Account group not found

delete/api/v3/accountgroups/{companyId}/{accountGroupId}/user/{userId}
Request samples
Response samples
No sample

Add account to account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
Request Body schema:
id
string <uuid>
Responses
200
401

Unauthorized

403

Action not permitted for user

404

AccountGroup/Account not found

post/api/v3/accountgroups/{companyId}/{accountGroupId}/account
Request samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Response samples
No sample

Remove account from account group

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
accountGroupId
required
string <uuid>
accountId
required
string <uuid>
Responses
200
401

Unauthorized

403

Action not permitted for user

404

AccountGroup/Account not found

delete/api/v3/accountgroups/{companyId}/{accountGroupId}/account/{accountId}
Request samples
Response samples
No sample

Balance

Get balance for account.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company Id

account
required
string or null

Account number

query Parameters
date
string or null <date-time>

Date (yyyy-mm-dd). Returns balance. When no balance, returns the nearest older balance.

dateSwitch
boolean
Default: false

False, same as above. When True , Returns balance. When no balance, returns the nearest newer balance.

Responses
200

Success

400

Invalid state

401

User not authorized

404

Balance not found

get/api/v3/balances/{companyId}/{account}
Request samples
Response samples
No sample

Company

Gets details for all valid companies

Subject to change. Data may be migrated to another API

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
query Parameters
state
integer <int32> (CompanyState)

Optional state filter

Enum: 0 1 2 999
Responses
200

Flat list of valid companies

get/api/v3/companies
Request samples
Response samples
No sample

Create new company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
Request Body schema:

Company model

organizationNumber
required
string

Company organization number. If matched in Brønnøysund, company name and adress will be overwritten

companyId
string or null <uuid>

Desired company id (optional)

parentCompanyId
string or null <uuid>

Id of parent company. Can be used to request subsidiary status for company.

name
string or null

Company name. Mandatory for companies outside Norway

address
string or null

Company address

zipCode
string or null

Company zipcode

zipArea
string or null

Company zip area

country
string or null

Company country required if company is not found in The Brønnøysund Register. Mandatory for companies outside Norway

Responses
200

"Company id"

401

Unauthorized

403

User not authorized for parent company

404

Not Found

post/api/v3/companies
Request samples
{
  • "CompanyId": "dfeaee8c-8534-48e2-80e0-27f43b884948",
  • "Name": "Duck corp",
  • "Address": "Apalveien 222",
  • "ZipCode": "0010",
  • "ZipArea": "Oslo",
  • "Country": "Norway"
}
Response samples
No sample

Gets company details

Subject to change. Data may be migrated to another API

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

Responses
200

Company dto

401

Unauthorized

404

Company not found

get/api/v3/companies/{companyId}
Request samples
Response samples
{
  "Name": "Z Data AS",
  "Address": "Damsgårdsveien 167",
  "ZipCode": "5160",
  "ZipArea": "Laksevåg",
  "Country": "Norge",
  "OrganizationNumber": "976197976",
  "CompanyId": "f6a6b364-18dc-44e7-87a8-cd8445771c96",
  "State": 1
}

Deactivate company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

Responses
200

"Company id"

401

Unauthorized

404

Company not found

delete/api/v3/companies/{companyId}
Request samples

Gets company subsidiaries

Subject to change. Data may be migrated to another API

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

Responses
200

Subsidiary dto's

401

Unauthorized

404

Company not found

get/api/v3/companies/{companyId}/subsidiaries
Request samples
Response samples
No sample

Gets company users

Subject to change. Data may be migrated to another API

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

Responses
200

"Company id"

401

Unauthorized

404

Company not found

get/api/v3/companies/{companyId}/users
Request samples
Response samples
No sample

EventGridDeadLetter

Get dead letter event

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
eventId
required
string <uuid>
Responses
200

Success

401

Unauthorized

404

Dead letter event not found

get/api/v3/events/deadletters/{eventId}
Request samples
Response samples
No sample

Delete dead letter event

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
eventId
required
string <uuid>
Responses
200

Success

404

Dead letter event not found

delete/api/v3/events/deadletters/{eventId}
Request samples

Get list of dead letter event metadata for client

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
query Parameters
skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

404

No dead letter events found for client

get/api/v3/events/deadletters
Request samples
Response samples
No sample

Get list of dead letter event metadata for company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

query Parameters
skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

401

Unauthorized

404

No dead letter events found for company

get/api/v3/events/companies/{companyId}/deadletters
Request samples
Response samples
No sample

Get list of dead letter event metadata for subscription

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

subscriptionName
required
string or null

Subscription name

query Parameters
skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

401

Unauthorized

404

No dead letter events found for subscription

get/api/v3/events/companies/{companyId}/subscriptions/{subscriptionName}/deadletters
Request samples
Response samples
No sample

EventGridSubscription

Get event subscriptions for company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id

query Parameters
skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

401

Unauthorized

get/api/v3/companies/{companyId}/subscriptions
Request samples
Response samples
No sample

Get subscription.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id.

subscriptionName
required
string or null

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

Responses
200

Success

400

Bad request

401

Unauthorized

404

Subscription not found

get/api/v3/companies/{companyId}/subscriptions/{subscriptionName}
Request samples
Response samples
No sample

Create or update event subscription.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id.

subscriptionName
required
string or null

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

Request Body schema:

Event subscription.

eventTypes
Array of strings or null
object (EventSubscriptionDestination)
Responses
200

Success

400

Bad request

401

Unauthorized

put/api/v3/companies/{companyId}/subscriptions/{subscriptionName}
Request samples
{
  • "eventTypes": [
    ],
  • "destination": {
    }
}
Response samples
No sample

Delete event subscription

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company id.

subscriptionName
required
string or null

Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).

Responses
200

Success

400

Bad request

401

Unauthorized

404

Event subscription not found

delete/api/v3/companies/{companyId}/subscriptions/{subscriptionName}
Request samples

CreateEventGridSubscriptionBatch

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
subscriptionName
required
string or null
query Parameters
skip
integer or null <int32>
take
integer or null <int32>
Request Body schema:
companyIds
Array of strings or null
eventTypes
Array of strings or null
object (EventSubscriptionDestination)
Responses
200

Success

put/api/v3/subscriptions/{subscriptionName}
Request samples
{
  • "companyIds": [
    ],
  • "eventTypes": [
    ],
  • "destination": {
    }
}
Response samples
No sample

Onboarding

Returns an onboarding instruction on for the provided BIC

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
bic
required
string or null

The bank's BIC code

query Parameters
languageCode
string or null
Default: "NO"

Language code (EN, NO, SE, DK, etc), defaults to NO

payments
boolean
Default: false

Include onboarding info for payments (if applicable)

receivables
boolean
Default: false

Include onboarding info for receivables (if applicable)

statements
boolean
Default: false

Include onboarding info for statements (if applicable)

balances
boolean
Default: false

Include onboarding info for balances (if applicable)

Responses
200

Onboarding instructions as HTML

400

Invalid grant type/client

get/api/v3/onboarding/{bic}
Request samples
Response samples
No sample

Get whether approval requirement is activated on account

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
account
required
string or null

Account number

Responses
200

Success

401

User not authorized

404

Account not found

get/api/v3/onboarding/preapproval/{account}
Request samples
Response samples
No sample

Payment

Get payments by messageId

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
messageId
required
string or null

Payment message id filter

query Parameters
skip
integer <int32>
Default: 0

Pagination: Number to skip (default 0)

take
integer <int32>
Default: 100

Pagination: Max number to return (default 100)

Responses
200

Success

401

User not authorized

404

Invalid messageId

get/api/v3/payments/{messageId}
Request samples
Response samples
{
  "Payments": [
    {
      "PaymentId": "8f2bbeec-c520-4899-b514-f4eabd027e92",
      "SourceReference": "100;101;22;6",
      "Status": 6,
      "ExecutionDate": "0001-01-01T00:00:00",
      "Links": [
        {
          "Rel": "payment",
          "Href": "https://bankservice.zdata.no/api/v3/payments/8043f884-0a70-40f9-9e57-58347102412a/c4dc6968-5161-4666-bd21-cee1a3c3ea72"
        }
      ]
    }
  ],
  "Total": 15,
  "Links": [
    {
      "Rel": "first",
      "Href": "https://bankservice.zdata.no/api/v3/payments/8043f884-0a70-40f9-9e57-58347102412a?skip=0&take=100"
    }
  ]
}

Get payments by batchId

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Unique Guid for company

batchId
required
string <uuid>

Unique Guid for the batch

query Parameters
skip
integer <int32>
Default: 0

Number of entries to skip

take
integer <int32>
Default: 100

Number of entries to return

Responses
200

Success

401

User not authorized

404

Invalid messageId

get/api/v3/payments/{companyId}/batches/{batchId}/transactions
Request samples
Response samples
{
  "Payments": [
    {
      "PaymentId": "d58dbeb7-4931-40d0-914e-1df031bc2497",
      "SourceReference": "100;101;22;6",
      "Status": 6,
      "ExecutionDate": "0001-01-01T00:00:00",
      "Links": [
        {
          "Rel": "payment",
          "Href": "https://bankservice.zdata.no/api/v3/payments/8043f884-0a70-40f9-9e57-58347102412a/c4dc6968-5161-4666-bd21-cee1a3c3ea72"
        }
      ]
    }
  ],
  "Total": 15,
  "Links": [
    {
      "Rel": "first",
      "Href": "https://bankservice.zdata.no/api/v3/payments/8043f884-0a70-40f9-9e57-58347102412a?skip=0&take=100"
    }
  ]
}

Get payment lines by batchId

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Unique Guid for company

batchId
required
string <uuid>

Unique Guid for the batch

query Parameters
skip
integer <int32>
Default: 0

Number of entries to skip

take
integer <int32>
Default: 10000

Number of entries to return

Responses
200

Success

401

User not authorized

404

Invalid messageId

get/api/v3/payments/{companyId}/batches/{batchId}
Request samples
Response samples
No sample

Get payment by sourceReference

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
messageId
required
string <uuid>

The unique id for the remittance

paymentId
required
string <uuid>

Payment id of payment line

Responses
200

Success

401

User not authorized

404

Invalid messageId

get/api/v3/payments/{messageId}/{paymentId}
Request samples
Response samples
{
  "PaymentId": "b8d1ade8-7c15-459c-b4b2-bb43b6a1a7b9",
  "Status": 0,
  "RejectionCode": "RR09",
  "RejectionMessage": "ISO Invalid Structured Creditor Reference",
  "Amount": 50,
  "Currency": "NOK",
  "ExecutionDate": "0001-01-01T00:00:00",
  "CreditorName": "Kreditor AS",
  "CreditorAccountNumber": "123456789012",
  "CreditorAccountCurrency": "NOK",
  "ChargeAmount": 70,
  "ChargeCurrency": "NOK",
  "Description": "Invoice number 32",
  "InvoiceNumber": "Something",
  "Settlement": {
    "BookingDate": "2024-06-18T11:28:48.7974507+02:00",
    "ValueDate": "2024-06-18T11:28:48.7974509+02:00",
    "ExchangeRate": 1.2,
    "Reference": "12345"
  }
}

Get summary of payments for company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Unique Guid for company

query Parameters
state
integer <int32> (TransactionState)

Transaction state

Enum: 0 1 2 3 4 5 6 7 8
fromDate
string or null <date-time>

Earliest date to be included

toDate
string or null <date-time>

Latest date to be included

skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

401

User not authorized

404

Invalid companyId

get/api/v3/payments/{companyId}/summaries
Request samples
Response samples
{
  "Summaries": [
    {
      "MessageId": "8ad9516a-94e5-4937-bcc2-df9c60ce8c23",
      "Timestamp": "2024-06-18T11:28:48.7993378+02:00",
      "FirstExecutionDate": "2024-06-18T11:28:48.7993369+02:00",
      "LastExecutionDate": "2024-06-18T11:28:48.7993371+02:00",
      "Amounts": {
        "NOK": 55
      },
      "Links": [
        {
          "Rel": "payments",
          "Href": "https://bankservice.zdata.no/api/v3/payments/0a8f02d5-24e1-4ea5-be46-135c2fa4f8c9"
        }
      ]
    }
  ],
  "Total": 0
}

Gets booked payments for company

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Unique Guid for company

query Parameters
accountNumber
string or null

Bank account number

fromDate
string or null <date-time>

Earliest date to be included

toDate
string or null <date-time>

Latest date to be included

skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

sourceReference
string or null

Source reference of a payment. When included, all payments within the same payment bundle will be returned

Responses
200

Success

401

User not authorized

404

Invalid messageId/sourceReference

get/api/v3/payments/{companyId}/movements
Request samples
Response samples
{
  "BookedPayments": [
    {
      "BookedAmount": 55,
      "AccountCurrency": "NOK",
      "ExchangeRate": 0,
      "BookingDate": "2024-06-18T11:28:48.801911+02:00",
      "BankReference": "123321",
      "ChargeAmount": 66,
      "ChargeCurrency": "NOK",
      "Payments": [
        {
          "PaymentId": "00000000-0000-0000-0000-000000000000",
          "MessageId": "00000000-0000-0000-0000-000000000000",
          "Links": [
            {
              "Rel": "payment",
              "Href": "http://bankservice.zdata.no/api/v3/payments/5cfd18e2-f37b-4d67-9661-f897b152d459/d0bde9d1-569d-4f5c-aaa7-f8197631fe23"
            }
          ]
        }
      ]
    }
  ],
  "Total": 0
}

Gets booked payments for settlement

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Unique Guid for company

batchId
required
string <uuid>

Unique Guid for the batch

query Parameters
skip
integer or null <int32>

Number of entries to skip

take
integer or null <int32>

Number of entries to return

Responses
200

Success

401

User not authorized

404

Invalid companyId/settlementId

get/api/v3/payments/{companyId}/batches/{batchId}/movements
Request samples
Response samples
{
  "BookedPayments": [
    {
      "BookedAmount": 55,
      "AccountCurrency": "NOK",
      "ExchangeRate": 0,
      "BookingDate": "2024-06-18T11:28:48.8026487+02:00",
      "BankReference": "123321",
      "ChargeAmount": 66,
      "ChargeCurrency": "NOK",
      "Payments": [
        {
          "PaymentId": "00000000-0000-0000-0000-000000000000",
          "MessageId": "00000000-0000-0000-0000-000000000000",
          "Links": [
            {
              "Rel": "payment",
              "Href": "http://bankservice.zdata.no/api/v3/payments/5cfd18e2-f37b-4d67-9661-f897b152d459/d0bde9d1-569d-4f5c-aaa7-f8197631fe23"
            }
          ]
        }
      ]
    }
  ],
  "Total": 0
}

Dismiss payments

Tokens provided to this endpoint must use implicit or authorization code grant type flows.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
messageId
required
string <uuid>

The unique id for the payments

Request Body schema:

Rejection message

reason
string or null

Reason for rejection

Responses
200

Success

400

Already approved, Missing access to bankaccounts

401

User not authorized

404

Remittance not found

put/api/v3/payments/{messageId}/dismiss
Request samples
{
  • "reason": "string"
}
Response samples
No sample

Approves payments by message id.

Tokens provided to this endpoint must use implicit or authorization code grant type flows.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
messageId
required
string <uuid>

The unique id for the payments

Responses
200

Success

400

Already reviewed, Payments were approved

401

User not authorized

404

Remittance not found

put/api/v3/payments/{messageId}/approve
Request samples
Response samples
No sample

Get payment approval data

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
messageId
required
string or null

Payment message id filter

Responses
200

Success

401

User not authorized

404

Invalid messageId

get/api/v3/payments/{messageId}/approve
Request samples
Response samples
No sample

Submits payments for an account. <br>The AccountNumber MUST be owned by the company and in an account group that the user has access to.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>
Request Body schema:
messageId
required
string <uuid>
accountNumber
required
string
singlePayments
boolean

Always send single payments to creditor. This will not work with credit notes.

required
Array of objects (PaymentLine)
Responses
200

Success

post/api/v3/payments/{companyId}
Request samples
{
  • "MessageId": "acc3a819-a117-49b7-b100-77cb9cd6746b",
  • "AccountNumber": "52011976166",
  • "SinglePayments": false,
  • "PaymentLines": [
    ]
}
Response samples
No sample

Receivable

Get incoming payments

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company Id

state
required
integer <int32> (InpaymentState)

Receivable state filter

Enum: 0 1 2
query Parameters
account
string or null

Account filter (optional)

fromDate
string or null <date-time>

Time frame limitation

toDate
string or null <date-time>

Time frame limitation

take
integer <int32>
Default: 100

Pagination: Max number to return (default 100)

skip
integer <int32>
Default: 0

Pagination: Number to skip (default 0)

Responses
200

Success

400

"Invalid state"

401

User not authorized

get/api/v3/receivables/{companyId}/{state}
Request samples
Response samples
{
  "State": 0,
  "Receivables": [
    {
      "ReceivableId": "d4709568-474b-41af-b5f3-024336a4a60c",
      "EntryId": "bdeb81fb-3b17-4297-8f00-bd03533bd39f",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2024-06-18T11:28:48.811975+02:00",
      "ValueDate": "2024-06-18T11:28:48.8119761+02:00",
      "Amount": 55,
      "Currency": "NOK",
      "BookedAmount": 65,
      "AccountCurrency": "NOK",
      "ChargeAmount": 10,
      "ChargeCurrency": "NOK",
      "Type": 0,
      "BankTransactionCode": "PMNT-ICDT-DMCT"
    }
  ],
  "Total": 0
}

Get receivables for a given file. Only valid with client credentials flow

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company Id

batchId
required
string <uuid>

Batch id

query Parameters
take
integer <int32>
Default: 100

Pagination: Max number to return (default 100)

skip
integer <int32>
Default: 0

Pagination: Number to skip (default 0)

Responses
200

Success

401

User not authorized

404

Id not found

get/api/v3/receivables/{companyId}/batches/{batchId}/transactions
Request samples
Response samples
{
  "TotalCount": 1,
  "Skip": 0,
  "Take": 10,
  "Items": [
    {
      "ReceivableId": "8c29f907-eb69-4c03-95a4-ba1e24fd6801",
      "EntryId": "ed11d527-bfff-4a9f-b6b6-83b808a83a44",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2024-06-18T11:28:48.8131692+02:00",
      "ValueDate": "2024-06-18T11:28:48.8131703+02:00",
      "Amount": 55,
      "Currency": "NOK",
      "BookedAmount": 65,
      "AccountCurrency": "NOK",
      "ChargeAmount": 10,
      "ChargeCurrency": "NOK",
      "Type": 0,
      "BankTransactionCode": "PMNT-ICDT-DMCT"
    }
  ]
}

Change state of all receivables in batch.

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
path Parameters
companyId
required
string <uuid>

Company Id

batchId
required
string <uuid>

Batch id

Request Body schema:
state
integer <int32> (InpaymentState)

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum: 0 1 2
errorMessage
string or null

Error message (used if State is set to Error)

Responses
200

Success

401

User not authorized

404

Id not found

put/api/v3/receivables/{companyId}/batches/{batchId}
Request samples
{
  • "state": 0,
  • "errorMessage": "string"
}

Update transaction state

Securityclient_credentials or implicit or client_credentials_dev or implicit_dev
Request
Request Body schema:

Update model

state
required
integer <int32> (InpaymentState)

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum: 0 1 2
errorMessage
string or null

Error message (used if State is set to Error)

id
required
string <uuid>

Inpayment Id

Responses
200

Updated states

400

"Invalid model"

401

User not authorized

404

Incoming payment id not found

post/api/v3/receivables/update
Request samples
{
  • "State": 2,
  • "ErrorMessage": "Something failed",
  • "Id": "a6ebff54-5235-4099-b00c-137376d7843b"
}
Response samples
<