Registration

Create a new entitlement registration line

Changed on Sep 29, 2026

Creates a new entitlement registration line with an optional file attachment.

Attachment Rules:

Whether an attachment is required or not allowed is determined by the entitlement configuration.
entitlements API can be used to fetch the entitlement configuration, which includes whether an attachment is required or not allowed for a specific entitlement.
If an attachment is required but not provided, the request will be rejected with a 400 error.
If an attachment is provided when not configured in entitlement, the document will still be stored
Supported file types for attachments are PDF, PNG and JPEG. If the provided file is not one of these types, the request will be rejected with a 400 error.

post/public/registrations/v1/register-entitlement

Request

Base URL
https://api.maqqie.app (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Client credentials
Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token
TypeScript
https://skmtc.dev/maqqie/apis/maqqie-public-api/docs/public/registrations/v1/register-entitlement/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body multipart/form-data

attachmentstring binary nullable

PDF or image file attachment (receipt, invoice, etc.). Whether required or not is determined by the entitlement configuration.

Example request

{
  "request": {
    "date": "2024-10-30"
  }
}

Response

Entitlement registration line created successfully

registrationIdstring uuid required

The ID of the created entitlement registration line

attachmentFileIdstring uuid

The ID of the uploaded attachment file. Null if no attachment was uploaded.

Changes

Sep 29, 2026f9510f3f4b22 Revision changes
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  the //// request property type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Sep 29, 20263352b56bb8fe Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the request property /////
- warning
  removed the request property /////
- warning
  removed the request property /////
- warning
  removed the request property /////
- warning
  removed the request property /////
- warning
  removed the request property /////
- warning
  removed the optional property from the response with the status
- info
  the //// request property type was generalized from object to no type

Operation history (8 revisions)