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": "07954f85-c284-4ce1-8329-2e7821bbfe05",
  • "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": "7a1df05b-d619-45d8-b8e9-ce42a1801ed4",
  "Accounts": [
    {
      "AccountId": "0c1db369-3acc-4e7f-bb06-3b33e5d0035d",
      "AccountNumber": "123456789012",
      "Bic": "DNBANOKK",
      "Currency": "NOK",
      "AccountGroupId": "488ceac9-9c91-496c-83dc-b44d4482c6c8",
      "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": "783d715a-ae96-4ae5-b0b9-31c423a4dff9",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "8beb1cf2-82f2-49ae-8e59-a65e9a791385",
  "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": "59094c7d-b4e0-4150-93e3-81cc09352296",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "cfb940de-06ec-4cd5-be37-1b2612db3ba0",
  "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": "307e361d-52d8-47c7-b236-e36dca679e12",
  "AccountNumber": "123456789012",
  "Bic": "DNBANOKK",
  "Currency": "NOK",
  "AccountGroupId": "70791d20-9aab-4b14-b69e-275b8e82fec1",
  "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": "9979cdeb-5f00-4b88-b939-fe645361547b",
  • "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": "14ec6a92-eb56-4621-b71c-dd65663d9669",
  "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 
Create or update event subscription for multiple companies.
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
subscriptionName
required
string or null
Subscription name (only A-Z a-z 0-9 and "-") (3-64 characters).


 
query Parameters
skip
integer or null <int32> 
Number of entries to skip.


 
take
integer or null <int32> 
Number of entries to return.


 
Request Body schema: 
Event subscription batch.


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


400
Bad request


401
Unauthorized


404
Company ids not found


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": "3dd9da3d-5fb7-465f-81a5-d2fe1f5a14a0",
      "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": "a7c53c7b-facc-4e16-9aa9-92148929ab00",
      "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": "dec5ae28-e95a-464a-82c9-e75faa658399",
  "Status": 0,
  "RejectionCode": "RR09",
  "RejectionMessage": "ISO Invalid Structured Creditor Reference",
  "Amount": 50,
  "Currency": "NOK",
  "ExecutionDate": "0001-01-01T00:00:00",
  "DebtorAccountNumber": "5337431043",
  "CreditorName": "Kreditor AS",
  "CreditorAccountNumber": "123456789012",
  "CreditorAccountCurrency": "NOK",
  "ChargeAmount": 70,
  "ChargeCurrency": "NOK",
  "Description": "Invoice number 32",
  "InvoiceNumber": "Something",
  "Settlement": {
    "BookingDate": "2024-12-20T00:49:21.8292979+01:00",
    "ValueDate": "2024-12-20T00:49:21.829298+01: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": "8f59a88d-8976-4729-8040-e8457040d973",
      "Timestamp": "2024-12-20T00:49:21.8311745+01:00",
      "FirstExecutionDate": "2024-12-20T00:49:21.8311738+01:00",
      "LastExecutionDate": "2024-12-20T00:49:21.8311739+01: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-12-20T00:49:21.8338301+01: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-12-20T00:49:21.8345701+01: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": "d1daa905-9618-45d3-a314-e3ce59c6de55",
  • "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": "2b6db91c-3a25-4464-821e-68a3d6cf8cef",
      "EntryId": "2f6bd73d-f425-4205-84dd-52e0f9f1160c",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2024-12-20T00:49:21.8427103+01:00",
      "ValueDate": "2024-12-20T00:49:21.8427118+01: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": "16b02032-3f67-493f-aa06-3a29cd643109",
      "EntryId": "5e4bad3d-1f4f-41dd-bf18-0ae8c65e9bb6",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2024-12-20T00:49:21.8438369+01:00",
      "ValueDate": "2024-12-20T00:49:21.8438379+01: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: 
Update model


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": "045713e5-9860-4e20-89dc-c7eb51f025d6"
}
Response samples 
No sample
Recipients
Lists all payments recipients for a company
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Company identification


 
Responses 
200
A list of recipients


401
Unauthorized


404
Recipients for company not found


get/api/v3/receipt/suppliernotification/{companyId}
Request samples 
Response samples 
No sample
Create new recipient
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
 
Request Body schema: 
name
string or null
 
accountNumber
string or null
 
email
string or null
 
Responses 
200
401
Unauthorized


403
Action not permitted for user


404
Recipients for company not found


post/api/v3/receipt/suppliernotification/{companyId}
Request samples 
{
  • "name": "string",
  • "accountNumber": "string",
  • "email": "string"
}
Response samples 
No sample
Update recipient
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Company id


 
recipientId
required
integer <int32> 
Id of recipient


 
Request Body schema: 
Update model


name
string or null
 
accountNumber
string or null
 
email
string or null
 
Responses 
200
401
Unauthorized


403
Action not permitted for user


404
Recipient not found


put/api/v3/receipt/suppliernotification/{companyId}/{recipientId}
Request samples 
{
  • "name": "string",
  • "accountNumber": "string",
  • "email": "string"
}
Response samples 
No sample
Delete recipient
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
 
recipientId
required
integer <int32> 
 
Responses 
200
401
Unauthorized


403
Action not permitted for user


404
Recipient not found


delete/api/v3/receipt/suppliernotification/{companyId}/{recipientId}
Request samples 
Response samples 
No sample
Services
POST request for new bank integration
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
Request Body schema: 
Model


companyId
required
string <uuid> 
Company id to register associate with service


 
bic
required
string
Bank identifier code


 
bankApproval
boolean
 
Responses 
200
Returns service id. Request added for ZData approval


400
Unknown BIC, contact ZData to have this bank added


401
User not authorized


post/api/v3/services/bank
Request samples 
{
  • "CompanyId": "b7aff530-c37a-4a2d-a678-fa87c0308fa9",
  • "Bic": "DNBANOKK",
  • "BankApproval": true
}
Response samples 
No sample
Gets company services
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Company id


 
query Parameters
state
integer <int32>  (BankServiceState) 
Optional state filter


 Enum: 0 1 2 3 4 5  
Responses 
200
Service dto's


400
Bad Request


401
Unauthorized


get/api/v3/services/bank/{companyId}
Request samples 
Response samples 
No sample
Gets company service
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Company id


 
serviceId
required
string <uuid> 
Service id


 
Responses 
200
Service dto


400
Bad Request


401
Unauthorized


404
Service not found


get/api/v3/services/bank/{companyId}/{serviceId}
Request samples 
Response samples 
{
  "Id": "98b647ff-a360-436b-bd77-f968bb8c86d4",
  "CompanyId": "36d7fec5-34f8-408b-b273-17782924df7f",
  "Name": "Agreenet for Donal Duck",
  "State": 0,
  "BIC": "DNBANOKK",
  "Created": "2024-12-20T00:49:21.8516997+01:00"
}
Statement
Returns bank statements for a given company. All statements are given in aggregated form, to get detailed transactions use the transactions link
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
 
query Parameters
accountNo
string or null
 Default:  ""
Optional filtering on account number


 
fromDate
string or null <date-time> 
Timeframe limitation, must be provided together with toDate


 
toDate
string or null <date-time> 
Timeframe limitation, must be provided together with fromDate


 
state
integer <int32>  (BankStatementState) 
Optional filtering on transaction state, state can be used to avoid downloading statements twice, use state link (PUT) to set state


 Enum: 0 1 2  
Responses 
200
Success


400
Invalid account number or date format


401
User not authorized


404
Statements not found for this company


get/api/v3/statements/{companyId}
Request samples 
Response samples 
{
  "Statements": [
    {
      "StatementId": "a9cf11a4-1a14-4aa6-a961-23e9382359de",
      "Name": "Donal Duck",
      "AccountNumber": "123456789012",
      "AccountCurrency": "NOK",
      "ArchiveReference": "121212",
      "BankInformation": "NO124123 23123",
      "StructuredReference": "123123",
      "Amount": 55,
      "AmountCurrency": "NOK",
      "Description": "Description",
      "BookingDate": "2024-12-20T00:49:21.8584662+01:00",
      "ValueDate": "2024-12-20T00:49:21.8584679+01:00",
      "BankTransactionCodes": "PMNT-ICDT-DMCT",
      "EntryReference": "123123",
      "TransactionCount": 1,
      "Links": [
        {
          "Rel": "details",
          "Href": "https://bankservicedemo.zdata.no/api/v3/statements/c32e6b5b-ca63-48d0-91ab-d5c6cb781737/7eeda2b9-e57e-49e3-8591-f3fc2cad2cd7/transactions"
        },
        {
          "Rel": "state",
          "Href": "https://bankservicedemo.zdata.no/api/v3/statements/c32e6b5b-ca63-48d0-91ab-d5c6cb781737/7eeda2b9-e57e-49e3-8591-f3fc2cad2cd7/state"
        }
      ]
    }
  ]
}
Returns bank statements for a given id in aggregated form. To get detailed transactions use the transactions link
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
entryId
required
string <uuid> 
The entry id


 
Responses 
200
Success


400
Bad Request


401
User not authorized


404
Statements not found for this company


get/api/v3/statements/{companyId}/entries/{entryId}
Request samples 
Response samples 
{
  "StatementId": "6fb06f1f-9337-4c6b-b50c-38750841887f",
  "Name": "Donal Duck",
  "AccountNumber": "123456789012",
  "AccountCurrency": "NOK",
  "ArchiveReference": "121212",
  "BankInformation": "NO124123 23123",
  "StructuredReference": "123123",
  "Amount": 55,
  "AmountCurrency": "NOK",
  "Description": "Description",
  "BookingDate": "2024-12-20T00:49:21.8593843+01:00",
  "ValueDate": "2024-12-20T00:49:21.8593856+01:00",
  "BankTransactionCodes": "PMNT-ICDT-DMCT",
  "EntryReference": "123123",
  "TransactionCount": 1,
  "Links": [
    {
      "Rel": "details",
      "Href": "https://bankservicedemo.zdata.no/api/v3/statements/c32e6b5b-ca63-48d0-91ab-d5c6cb781737/7eeda2b9-e57e-49e3-8591-f3fc2cad2cd7/transactions"
    },
    {
      "Rel": "state",
      "Href": "https://bankservicedemo.zdata.no/api/v3/statements/c32e6b5b-ca63-48d0-91ab-d5c6cb781737/7eeda2b9-e57e-49e3-8591-f3fc2cad2cd7/state"
    }
  ]
}
Returns all transactions for a given statement.Deprecated
Renamed to /{companyId}/entries/{entryId}/transactions


Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Id of company that owns the statement


 
statementId
required
string <uuid> 
Unique StatementId


 
Responses 
200
Success


get/api/v3/statements/{companyId}/{statementId}/transactions
Request samples 
Response samples 
{
  "StatementId": "d502c3b4-d133-4bbc-aadd-fb89b5529e1d",
  "Transactions": [
    {
      "StatementId": "f9417789-91b7-449a-9c11-49ad49fa0e10",
      "Name": "Some name",
      "AccountNumber": "1233456",
      "AccountCurrency": "NOK",
      "ArchiveReference": "12345677",
      "BankInformation": "123123",
      "StructuredReference": "31231231",
      "Amount": 56,
      "AmountCurrency": "NOK",
      "Description": "Description",
      "BookingDate": "2024-12-20T00:49:21.8625451+01:00",
      "BankTransactionCodes": "PMNT-ICDT-DMCT",
      "Type": "Debit",
      "TransactionId": "05b8ff14-05f3-433d-9edc-15abd6a4f706",
      "InvoiceNumber": "123345",
      "ReceiverName": "Donald Duck",
      "ReceiverAccount": "123445678978",
      "SenderName": "Dolly Duck",
      "SenderAccount": "098765432112",
      "UnstructuredText": {
        "Ustrd": [],
        "AddtlTxInf": [],
        "InstrId": [
          "InstrId A, InstrId B"
        ],
        "PrtryCd": [],
        "AddtlNtryInf": [
          "AddtlNtryInf Text"
        ]
      }
    }
  ]
}
Returns all transactions for a given statement.
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Id of company that owns the statement


 
entryId
required
string <uuid> 
Unique statement entry id


 
Responses 
200
Success


get/api/v3/statements/{companyId}/entries/{entryId}/transactions
Request samples 
Response samples 
{
  "StatementId": "a5f4de87-7f3d-4ca7-9000-74cd9245bfce",
  "Transactions": [
    {
      "StatementId": "6fdc9c5b-4f03-446a-b7d2-81cc51320efe",
      "Name": "Some name",
      "AccountNumber": "1233456",
      "AccountCurrency": "NOK",
      "ArchiveReference": "12345677",
      "BankInformation": "123123",
      "StructuredReference": "31231231",
      "Amount": 56,
      "AmountCurrency": "NOK",
      "Description": "Description",
      "BookingDate": "2024-12-20T00:49:21.8630046+01:00",
      "BankTransactionCodes": "PMNT-ICDT-DMCT",
      "Type": "Debit",
      "TransactionId": "42499ff5-24a2-46b5-888a-792a8c7d807c",
      "InvoiceNumber": "123345",
      "ReceiverName": "Donald Duck",
      "ReceiverAccount": "123445678978",
      "SenderName": "Dolly Duck",
      "SenderAccount": "098765432112",
      "UnstructuredText": {
        "Ustrd": [],
        "AddtlTxInf": [],
        "InstrId": [
          "InstrId A, InstrId B"
        ],
        "PrtryCd": [],
        "AddtlNtryInf": [
          "AddtlNtryInf Text"
        ]
      }
    }
  ]
}
Updates state of all transactions for a given statement.
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Id of company that owns the statement


 
statementId
required
string <uuid> 
Unique StatementId


 
Request Body schema: 
Update request


state
required
integer <int32>  (BankStatementState) 
BankStatementState


    

  • 0 - Created
    • 

  • 1 - Transferred
    • 

  • 2 - Error
    • 



 Enum: 0 1 2  
errorMessage
string or null
Error message (used if State is set to Error)


 
Responses 
200
Success


put/api/v3/statements/{companyId}/{statementId}/state
Request samples 
{
  • "state": 0,
  • "errorMessage": "string"
}
Response samples 
No sample
User
Gets user details
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
path Parameters
userId
required
string <uuid> 
User id


 
Responses 
200
Success


401
Unauthorized


404
User not found


get/api/v3/users/{userId}
Request samples 
Response samples 
{
  "Id": "123321123",
  "CompanyId": "ee0ea28e-98d9-4e3c-8df7-3963d73a9bfe",
  "Username": "duck@duck.com",
  "Email": "duck@duck.com",
  "Name": "Duck corp",
  "PhoneNumber": "52 52 52 52",
  "ActiveUser": true
}
POST new user
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 user


 
username
required
string
Username


 
email
required
string <email> 
Users email


 
name
required
string
Name


 
phoneNumber
required
string
Phone number


 
password
string or null
Password (optional), if not set user will receive email to complete registration


 
Responses 
200
User created


202
User created, but failed to set password


400
Bad Request


401
User not authorized


404
Company not found


post/api/v3/users
Request samples 
{
  • "companyId": "c32e6b5b-ca63-48d0-91ab-d5c6cb781737",
  • "username": "user1@mycompany.com",
  • "email": "user1@mycompany.com",
  • "name": "Ola Nordmann",
  • "phoneNumber": "90001337",
  • "password": "sdf35asty4q3g5ehgg%¤"
}
Response samples 
No sample
Sends mail to user for password reset
Securityclient_credentials or implicit or client_credentials_dev or implicit_dev 
Request 
Request Body schema: 
Model for password reset


username
required
string
Username


 
Responses 
200
Success


post/api/v3/users/resetpassword
Request samples 
{
  • "Username": "myusername"
}