Skip to content
API Reference
/
/
Get receivables for a giv...

Aritma Banking API (v3)

Download OpenAPI description
bankservice-openapi.json
bankservice-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v3/openapi/bankservice-openapi
Open Banking API
https://bankservice.zdata.no
Open Banking API (Dev)
https://bankservicedemo.zdata.no

Account

Operations

AccountGroup

Operations

Balance

Operations

Company

Operations

EventGridDeadLetter

Operations

EventGridSubscription

Operations

Onboarding

Operations

Payment

Operations

Receivable

Operations

Get incoming payments

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

stateinteger(int32)(InpaymentState)required

Receivable state filter

Enum012
Query
accountstring

Account filter (optional)

fromDatestring

Time frame limitation

toDatestring

Time frame limitation

takeinteger(int32)

Pagination: Max number to return (default 100)

Default 100
skipinteger(int32)

Pagination: Number to skip (default 0)

Default 0
No request payload

Responses

OK

Body
stateinteger(int32)(InpaymentState)required

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
receivablesArray of objects(ReceivableDto)required

Transactions

receivableIdstring(uuid)

Unique reference for receivable

entryIdstring or null(uuid)

Entry id from account statement

entryReferencestring or null

EntryReference

accountNumberstring or null

Deposit account

debtorAccountNumberstring or null

Withdrawal account

debtorNamestring or null

Customer name

debtorAddressstring or null

Customer address

archiveReferencestring or null

Bank reference

structuredReferencestring or null

KID, FIK, OCR (SCOR reference)

descriptionstring or null

Unstructured reference (payment message)

invoiceNumberstring or null

Invoice number

bookingDatestring(date-time)

Processed date

valueDatestring(date-time)

Exchange date

amountnumber(double)

Payment amount or fee amount

currencystring or null

Payment or fee currency type

bookedAmountnumber or null(double)

Booked amount

exchangeRatenumber or null(double)

Exchange rate

accountCurrencystring or null

Currency of bank account;

chargeAmountnumber or null(double)

Charge amount

chargeCurrencystring or null

Charge Currency

typeinteger(int32)(TransactionType)

TransactionType

  • 0 - Payment
  • 1 - Charge
Enum01
bankTransactionCodestring or null

Bank Transaction Codes Domain, Family and Sub-Familiy, dash separated.

errorMessagestring or null

Error message, only exists on error state

totalinteger(int32)required
Response
{
  "State": 0,
  "Receivables": [
    {
      "ReceivableId": "15757c4b-9fcf-4427-8933-fe5bdfa69f3f",
      "EntryId": "067b2505-d2c1-43fe-bc08-337ee2693770",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2026-03-24T12:08:23.0881616+01:00",
      "ValueDate": "2026-03-24T12:08:23.0881629+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

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

batchIdstring(uuid)required

Batch id

Query
takeinteger(int32)

Pagination: Max number to return (default 100)

Default 100
skipinteger(int32)

Pagination: Number to skip (default 0)

Default 0
No request payload

Responses

OK

Body
totalCountinteger(int32)
skipinteger or null(int32)
takeinteger or null(int32)
itemsArray of objects or null(ReceivableDto)
Response
{
  "TotalCount": 1,
  "Skip": 0,
  "Take": 10,
  "Items": [
    {
      "ReceivableId": "2177a2b0-bada-4d95-a759-3a81d25138c3",
      "EntryId": "5fa5d083-b19f-4a96-91f0-bc41d98da5d9",
      "AccountNumber": "123456789012",
      "DebtorAccountNumber": "098765432112",
      "DebtorName": "Donald Duck",
      "DebtorAddress": "Veien 12A",
      "ArchiveReference": "1234",
      "Description": "Submitted to Onkel Skrue",
      "InvoiceNumber": "12345",
      "BookingDate": "2026-03-24T12:08:23.0886041+01:00",
      "ValueDate": "2026-03-24T12:08:23.0886054+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.

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Path
companyIdstring(uuid)required

Company Id

batchIdstring(uuid)required

Batch id

Body

Update model

stateinteger(int32)(InpaymentState)

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
errorMessagestring or null

Error message (used if State is set to Error)

{
  "state": 0,
  "errorMessage": "string"
}

Responses

OK

Update transaction state

Request

Security
client_credentials(Required scopes:
openid
profile
bankservice
) or implicit(Required scopes:
openid
profile
bankservice
) or client_credentials_dev(Required scopes:
openid
profile
bankservice
) or implicit_dev(Required scopes:
openid
profile
bankservice
)
Body

Update model

stateinteger(int32)(InpaymentState)required

InpaymentState

  • 0 - Queued
  • 1 - Transferred
  • 2 - Error
Enum012
errorMessagestring or null

Error message (used if State is set to Error)

idstring(uuid)required

Inpayment Id

{
  "State": 2,
  "ErrorMessage": "Something failed",
  "Id": "511cdf4e-19ae-4234-acad-6478d88098b1"
}

Responses

Updated states

Response
No content

Recipients

Operations

Services

Operations

Statement

Operations

User

Operations