Ledger | Subrite

Ledger

Endpoints for Ledger

ReferenceUpdated October 13, 2026View as Markdown

Get ledger of all members#

POST/api/v1/ledger/filter

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"

Request body

Required bodyapplication/json

Schema ExampleTransactionFilter

11 top-level fieldsSelect an object to expand

statusstringOptional
Allowed values: "open", "matched", "ignored"
typesarray of TransactionResponseTypeOptional
Allowed values: "payment", "refund", "invoice", "credit_note", "rounding_adjustment"
invoiceStatusarray of INVOICE_STATUSOptional
Allowed values: "paid", "unpaid", "over-due", "over-paid", "partially-paid", "refunded", "credited",

Responses

5 status codes

Responses 200

Status200 201 401 403 500application/json

Schema ExampleTransactionResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of TransactionResponseRequired15 fields
items
- transactionGroupIdnumberField path: items[].transactionGroupId

Example requestcurl

curl

curl https://api.subrite.no/api/v1/ledger/filter \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "open",
  "types": [
    "payment"
  ],
  "invoiceStatus": [
    "paid"
  ],
  "invoiceNumber": 0,
  "reference": "string",
  "memberSearch": "string",
  "memberId": "string",
  "memberEmail": "string",
  "dateFrom": "2019-08-24T14:15:22Z",
  "dateTo": "2019-08-24T14:15:22Z",
  "amountFilter": {
    "operator": "EQUALS",
    "amount": 0,
    "secondAmount": 0
  }
}'

Try it

GET/api/v1/ledger/{memberId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

memberIdstringRequired

Query parameters1

statusstringOptional
Allowed values: "open", "matched", "ignored"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

PATCH/api/v1/ledger/{memberId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

memberIdstringRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateTransactionGroupStatusDto

2 top-level fields

transactionIdsarray of numberRequired
actionTRANSACTION_GROUP_ACTIONRequired

Get transaction summary before matching/unmatching transactions#

POST/api/v1/ledger/{memberId}/summary

Authentication: Bearer token (JWT)

Parameters

Path parameters1

memberIdstringRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateTransactionGroupStatusDto

Same fields as Match transactions (Request body).

Schema ExampleUpdateTransactionGroupStatusDto

PATCH/api/v1/ledger/{memberId}/{transactionId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

memberIdstringRequired
transactionIdnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateTransactionStatusDto

1 top-level field

"partially-credited"

Schema ExampleTransactionFilter

application/json

{
  "status": "open",
  "types": [
    "payment"
  ],
  "invoiceStatus": [
    "paid"
  ],
  "invoiceNumber": 0,
  "reference": "string",
  "memberSearch": "string",
  "memberId": "string",
  "memberEmail": "string",
  "dateFrom": "2019-08-24T14:15:22Z",
  "dateTo": "2019-08-24T14:15:22Z",
  "amountFilter": {
    "operator": "EQUALS",
    "amount": 0,
    "secondAmount": 0
  }
}

Example · 21 linesShow full heightShow compact view

Schema ExampleTransactionResponsePaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 403

Status200 201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema Examplearray of TransactionResponse

200 · application/json

[
  {
    "transactionGroupId": 0,
    "transactionId": 0,
    "memberId": "string",
    "memberEmail": "string",
    "memberName": "<memberName>",
    "type": "payment",
    "registrationDate": "2019-08-24T14:15:22Z",
    "accountingDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": 0,
    "invoiceStatus": "paid",
    "reference": "string",
    "amount": 0,
    "status": "open",
    "memberPackageId": 0,
    "memberNumber": 0
  }
]

Example · 19 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get ledger of all members (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 409 500application/json

Schema ExampleTransactionGroup

9 top-level fieldsSelect an object to expand

uuidstringRequired
isOpenbooleanRequired
isManualMatchbooleanRequired
transactionsarray of TransactionRequired24 fields
transactions
- transactionGroupIdnumberRequired when parent is presentField path: transactions[].transactionGroupId
- typestringRequired when parent is presentField path: transactions[].type
  Allowed values: "payment", "refund", "invoice", "credit_note", "rounding_adjustment"
- memberPackageIdnumberRequired when parent is presentField path: transactions[].memberPackageId
- amountnumberRequired when parent is presentField path: transactions[].amount
- reference
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

75 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleTransactionGroup

200 · application/json

{
  "uuid": "string",
  "isOpen": true,
  "isManualMatch": true,
  "transactions": [
    {
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 15 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 409 500application/json

matchWouldOrphanCreditNote

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "matchWouldOrphanCreditNote"
messagestring
errors

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get ledger of all members (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 409

Status200 400 401 403 409 500application/json

eventDateFallsInLockedPeriod

SchemaErrorResponse

Same fields as Get ledger of all members (403).

Responses 500

Status200 400 401 403 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get ledger of all members (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/ledger/{memberId}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactionIds": [
    0
  ],
  "action": "match"
}'

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleMatchSummary

3 top-level fieldsSelect an object to expand

transactionsarray of TransactionWithAmountRequired3 fields
transactions
- transactionIdnumberRequired when parent is presentField path: transactions[].transactionId
- amountnumberRequired when parent is presentField path: transactions[].amount
- typeTransactionResponseTypeRequired when parent is presentField path: transactions[].type
  Allowed values: "payment", "refund", "invoice", "credit_note", "rounding_adjustment"
roundingAdjustmentAmountnumber
transactionGroupIdnumber

6 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleMatchSummary

201 · application/json

{
  "transactions": [
    {}
  ],
  "roundingAdjustmentAmount": 0,
  "transactionGroupId": 0
}

Example · 7 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

crossTransactionGroups

Schema ExampleErrorResponse

Same fields as Get ledger of all members (403).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get ledger of all members (403).

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get ledger of all members (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/ledger/{memberId}/summary' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactionIds": [
    0
  ],
  "action": "match"
}'

Responses

5 status codes

Responses 200

This response has no body.

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get ledger of all members (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get ledger of all members (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/ledger/{memberId}/{transactionId}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "ignored"
}'

string

memberMemberRequired when parent is presentField path: transactions[].member21 fields

transactions[].member

userIdnumberRequired when parent is presentField path: transactions[].member.userId
Can be null
memberNumbernumberRequired when parent is presentField path: transactions[].member.memberNumber
Can be null
tenantIdnumberRequired when parent is presentField path: transactions[].member.tenantId
externalIdstringRequired when parent is presentField path: transactions[].member.externalId
Can be null
fullNamestringRequired when parent is presentField path: transactions[].member.fullName
nickNamestringRequired when parent is presentField path: transactions[].member.nickName
avatarstringRequired when parent is presentField path: transactions[].member.avatar
emailstringRequired when parent is presentField path: transactions[].member.email
birthDatestring (date-time)Required when parent is presentField path: transactions[].member.birthDate
Can be null
phonestringRequired when parent is presentField path: transactions[].member.phone
isCompanybooleanRequired when parent is presentField path: transactions[].member.isCompany
companyNamestringRequired when parent is presentField path: transactions[].member.companyName
Can be null
organizationNostringRequired when parent is presentField path: transactions[].member.organizationNo
Can be null
deleteAfterExpirationbooleanRequired when parent is presentField path: transactions[].member.deleteAfterExpiration
customPropertyValuesobjectRequired when parent is presentField path: transactions[].member.customPropertyValues
productRecipientsarray of MemberPackageProductRecipientRequired when parent is presentField path: transactions[].member.productRecipientsNested fields omitted: depth limit.
idstringRequired when parent is presentField path: transactions[].member.id
createdAtstring (date-time)Required when parent is presentField path: transactions[].member.createdAt
updatedAtstring (date-time)Required when parent is presentField path: transactions[].member.updatedAt
deletedAtstring (date-time)Required when parent is presentField path: transactions[].member.deletedAt
metaDataobjectRequired when parent is presentField path: transactions[].member.metaData

refundRefundRequired when parent is presentField path: transactions[].refund21 fields

transactions[].refund

refundNumbernumberRequired when parent is presentField path: transactions[].refund.refundNumber
invoiceNumbernumberRequired when parent is presentField path: transactions[].refund.invoiceNumber
invoiceIdnumberRequired when parent is presentField path: transactions[].refund.invoiceId
memberIdstringRequired when parent is presentField path: transactions[].refund.memberId
languagestringRequired when parent is presentField path: transactions[].refund.language
Allowed values: "en", "no", "sv", "da"
memberInfoMemberInfoRequired when parent is presentField path: transactions[].refund.memberInfoNested fields omitted: depth limit.
addressInfoAddressInfoRequired when parent is presentField path: transactions[].refund.addressInfoNested fields omitted: depth limit.
tenantInfoTenantInfoRequired when parent is presentField path: transactions[].refund.tenantInfoNested fields omitted: depth limit.
paymentProviderstringRequired when parent is presentField path: transactions[].refund.paymentProvider
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
amountnumberRequired when parent is presentField path: transactions[].refund.amount
accountingDatestring (date-time)Required when parent is presentField path: transactions[].refund.accountingDate
currencystringRequired when parent is presentField path: transactions[].refund.currency
notestringRequired when parent is presentField path: transactions[].refund.note
invoiceInvoiceRequired when parent is presentField path: transactions[].refund.invoiceNested fields omitted: depth limit.
memberMemberRequired when parent is presentField path: transactions[].refund.memberNested fields omitted: depth limit.
tenantTenantRequired when parent is presentField path: transactions[].refund.tenantNested fields omitted: depth limit.
idnumberRequired when parent is presentField path: transactions[].refund.id
createdAtstring (date-time)Required when parent is presentField path: transactions[].refund.createdAt
updatedAtstring (date-time)Required when parent is presentField path: transactions[].refund.updatedAt
deletedAtstring (date-time)Required when parent is presentField path: transactions[].refund.deletedAt
metaDataobjectRequired when parent is presentField path: transactions[].refund.metaData

array of FieldError

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "matchWouldOrphanCreditNote",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Get ledger of all members#

Parameters

Request body

Responses

Responses 200

Get ledger of a member#

Parameters

Responses

Responses 200

Match transactions#

Parameters

Request body

Get transaction summary before matching/unmatching transactions#

Parameters

Request body

Update transaction status of a particular transaction#

Parameters

Request body

Get ledger of all members#

Parameters

Request body

Responses

Responses 200

Get ledger of a member#

Parameters

Responses

Responses 200

Match transactions#

Parameters

Request body

Get transaction summary before matching/unmatching transactions#

Parameters

Request body

Update transaction status of a particular transaction#

Parameters

Request body

Responses 201

Responses 401

Responses 403

Responses 500

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 409

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500