5 changed files with 54 additions and 2695 deletions

No files matched your search

File diff suppressed because it is too large. Load diff
@@ -1,403 +0,0 @@
openapi: 3.0.3
info:
title: Integration layer APIs for token storage for ABT
description: >-
APIs that give business processes access to the security and authorization state of a token within the scope of HTM. In the backend this is connected to a container which handles the accessToken en refreshToken management for an OVpas as given by GBO.
version: "1.0"
servers:
- url: https://services.acc.api.htm.nl/abt/containertokens/1.0
security:
- oAuthSample: [profile]
tags:
- name: securitytokens
paths:
/securitytokens:
post:
tags:
- securitytokens
summary: Create a new security token entry in the vault
description: Create a new security token entry in the vault, if the customerProfileId has been supplied create in the customerToken DB otherwise in the AnonymousToken DB
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSecurityTokenBody"
examples:
token details:
value:
{
"xTat": "cf694905-7f76-4799-b0bc-490716921323",
"otpKey": "123456789123456789123456789abcde",
"customerProfileId": 12314
}
responses:
"201":
description: Created
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT not found:
value:
status: 404
title: Not Found
detail: TAT Account Not Found
"409":
description: Conflict
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT already exists:
value:
status: 409
title: Conflict
detail: Security Token already exists
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Internal Server Error:
value:
status: 500
title: Internal Server Error
detail: An unknown error has occurred
/securitytokens/{xTat}/status:
parameters:
- name: xTat
in: path
schema:
type: string
example: 85dbeacc-b9aa-4d5b-bdec-9319010c597f
required: true
description: The xTat of the OVpastoken for which the status needs to be checked
- name: customerProfileId
in: query
schema:
type: integer
example: 323
required: false
description: The id of the customer Profile for which the request is being done, if customer has identified themselves
get:
tags:
- securitytokens
summary: Request the security and authorization status of an OV pas token
description: Request the security and authorization status of an OV pas token, if the customerProfileId has been supplied look in the customerToken DB otherwise check the AnonymousToken DB.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/SecurityTokenStatusResponse"
examples:
Not secured and not authorized :
summary: Not secured, not authorized
value:
{
"isAuthorized": false,
"isSecured": false
}
Secured and not authorized :
summary: Secured, not authorized
value:
{
"isAuthorized": false,
"isSecured": true
}
Secured and authorized :
summary: Secured and authorized
value:
{
"isAuthorized": true,
"isSecured": true
}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT not found:
value:
status: 404
title: Not Found
detail: TAT Account Not Found
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Internal Server Error:
value:
status: 500
title: Internal Server Error
detail: An unknown error has occurred
/securitytokens/{xTat}:
parameters:
- name: xTat
in: path
schema:
type: string
example: uuid
required: true
description: The xTat of the ovPastoken for which the status needs to be checked
- name: customerProfileId
in: query
schema:
type: integer
example: 323
required: false
description: The id of the customer Profile for which the request is being done, if customer has identified themselves
patch:
tags:
- securitytokens
summary: Validate the supplied OTP and secure and/or authorize the token
description: Validate the supplied OTP and secure and/or authorize the token if the customerProfileId has been supplied look in the customerToken DB otherwise check the AnonymousToken DB.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SecurityValidateTokenBody"
examples:
token:
value:
{
"otp": "123456"
}
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/SecurityTokenStatusResponse"
examples:
Not secured and not authorized :
summary: Not secured, not authorized
value:
{
"isAuthorized": false,
"isSecured": false
}
Secured and not authorized :
summary: Secured, not authorized
value:
{
"isAuthorized": false,
"isSecured": true
}
Secured and authorized :
summary: Secured and authorized
value:
{
"isAuthorized": true,
"isSecured": true
}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Validation failed:
value:
status: 422
title: OTP validation failed
detail: The supplied OTP could not be validated
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT not found:
value:
status: 404
title: Not Found
detail: TAT Account Not Found
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Internal Server Error:
value:
status: 500
title: Internal Server Error
detail: An unknown error has occurred
components:
securitySchemes:
oAuthSample:
type: oauth2
description: This API uses OAuth 2 with the clientCredentials flow. [More info](https://api.example.com/docs/auth)
flows:
clientCredentials: # <---- OAuth flow( clientCredentials)
tokenUrl: https://identity.{env}.api.htm.nl/oauth2/token
scopes:
profile: "Access user profile"
schemas:
ErrorResponse:
description: Default response when an invalid request has been sent
type: object
properties:
status:
type: integer
description: >-
A status IS An integer that represents the HTTP status code of the
response.
example: 400
title:
type: string
description: A title IS A string that provides a brief summary of the error.
detail:
type: string
description: A detail IS A string that provides more details about the error.
CreateSecurityTokenBody:
description: Body for when the a new security token entry is created
type: object
required:
- xTat
- otpKey
properties:
xTat:
type : string
description: >-
Unique identifier for the GBO transit account
example: 03071794-482a-4168-b60f-84669a9e6a76
otpKey:
type : string
description: >-
Key used to validate the OTP at GBO
example: 123456789123456789123456789abcde
customerProfileId:
type : integer
description: >-
CustomerProfileId of the account requesting security or giving authorization
example: 123456
SecurityTokenStatusResponse:
description: Response for when the status of a token is requested
type: object
properties:
isSecured:
type: boolean
description: >-
Is the OVpas secured according to the GBO
example: false
isAuthorized:
type: boolean
description: >-
Does HTM have the authorization to access the secured the data of the OVpas
example: false
SecurityValidateTokenBody:
description: Body for when the a token entry is validated
type: object
required:
- otp
properties:
otp:
type : string
description: >-
OTP to be used to secure the token and retrieve the JWT at GBO
example: 123456
+8 -66
View File
@@ -1081,10 +1081,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -1134,9 +1130,9 @@ paths:
}, },
}, },
} }
OV pas without PAD, without AGO: OV pas without PAD:
summary: OV pas without PAD, without AGO summary: OV pas without PAD
description: OV pas without PAD, without AGO description: OV pas without PAD
value: value:
{ {
"ovPayTokens": "ovPayTokens":
@@ -1168,10 +1164,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": false,
"isAuthorized": null,
},
"_links": "_links":
{ {
"self": "self":
@@ -1221,9 +1213,9 @@ paths:
}, },
}, },
} }
OV pas with PAD, with autoReload, with AGO: OV pas with PAD and autoReload:
summary: OV pas with PAD, with autoReload, with AGO summary: OV pas with PAD and autoReload
description: OV pas with PAD, with autoReload, with AGO description: OV pas with PAD and autoReload
value: value:
{ {
"ovPayTokens": "ovPayTokens":
@@ -1295,10 +1287,6 @@ paths:
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11, "ageToInclusive": 11,
}, },
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -1397,10 +1385,6 @@ paths:
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11, "ageToInclusive": 11,
}, },
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -1517,10 +1501,6 @@ paths:
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11, "ageToInclusive": 11,
}, },
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -1619,10 +1599,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
{ {
"customerProfileId": 18, "customerProfileId": 18,
@@ -1645,10 +1621,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
{ {
"customerProfileId": 132, "customerProfileId": 132,
@@ -1671,10 +1643,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
{ {
"customerProfileId": 166, "customerProfileId": 166,
@@ -1700,10 +1668,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
{ {
"customerProfileId": 166, "customerProfileId": 166,
@@ -1726,10 +1690,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
{ {
"customerProfileId": 1, "customerProfileId": 1,
@@ -1752,10 +1712,6 @@ paths:
"photo": null, "photo": null,
}, },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
}, },
], ],
_links: _links:
@@ -1856,10 +1812,6 @@ paths:
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -1938,10 +1890,6 @@ paths:
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -2138,10 +2086,6 @@ paths:
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -2205,10 +2149,6 @@ paths:
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null, "gboAgeProfile": null,
"tatSecurity": {
"isSecured": true,
"isAuthorized": true,
},
"_links": "_links":
{ {
"self": "self":
@@ -3696,6 +3636,7 @@ paths:
"vouchers": [] "vouchers": []
} }
} }
/customers/devices: /customers/devices:
post: post:
summary: Add a new device to a customer profile. summary: Add a new device to a customer profile.
@@ -4662,3 +4603,4 @@ components:
customerDataItem: customerDataItem:
type: string type: string
example: emailAddress example: emailAddress
-341
View File
@@ -1,341 +0,0 @@
openapi: 3.0.1
info:
title: Service Engine APIs for TAT security
description: >-
Service Engine APIs for TAT security. These are NOT the raw GBO APIs to access TAT security at GBO directly.
To be used by touch points to get secure a TAT.
version: "2.0"
servers:
- url: https://services.acc.api.htm.nl/abt/touchpoint/2.0
tags:
- name: TAT Security
paths:
/tokens/securetoken:
parameters:
- name: X-HTM-JWT-AUTH-HEADER
in: header
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: false
description: The JWT of a customer in case of touchpoint were customer logs in themselves
- name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
in: header
schema:
type: integer
example: 323
required: false
description: The id of the customer Profile
- name: X-HTM-ROLE-HEADER
in: header
schema:
type: string
example: Customer
required: false
description: The role of the HTM employee in the case of the SMP
post:
tags:
- TAT Security
summary: Request additional OV-pas security for a token either in profile or anonymous.
description: Request additional OV-pas security for a token either in profile or anonymous
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SecureTokenRequest"
examples:
With customer account:
value:
ovPayTokenId: 42
emailAddress: stasjo@htm.nl
Without customer account:
value:
xtat: 62914b49-2c7f-437f-b4b0-2ad61a9f902d
emailAddress: stasjo@htm.nl
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/EmailNotPreApprovedResponse"
example:
uid: 7594f3ee-cd3d-40a3-8e82-73b90d16c481
recipient: xxxxxx.user@gmail.com
key: 123456789123456789123456789abcde
description: OTP Sent
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT not found:
value:
status: 404
title: Not Found
detail: TAT Account Not Found
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
TAT Already Secured:
value:
status: 409
title: Conflict
detail: TAT Already Secured
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
error: An unknown error has occurred
/tokens/verifyotp:
parameters:
- name: X-HTM-JWT-AUTH-HEADER
in: header
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: false
description: The JWT of a customer in case of touchpoint were customer logs in themselves
- name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
in: header
schema:
type: integer
example: 323
required: false
description: The id of the customer Profile
- name: X-HTM-ROLE-HEADER
in: header
schema:
type: string
example: Customer
required: false
description: The role of the HTM employee in the case of the SMP
post:
tags:
- TAT Security
summary: Submit an OTP for a triggered OTP flow.
description: |
Submit an OTP for a triggered OTP flow. This can either be result of an AGO activation, or
result of an AGO authorization flow. Since the backoffice behaves slightly different depending
on which use case is executed, the calling TP needs to provide an `action` in the request body.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/VerifyOtpRequest"
examples:
OTP verification for TAT security activation for token in customer account:
value:
ovPayTokenId: 42
otp: 123456
action: secure
OTP verification for TAT security authorization for anonymous token:
value:
xtat: 0f0defe8-828c-48e5-97e5-26d1d0179ef0
otp: 123456
action: authorize
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyOtpResponse'
examples:
Tat Secured:
value:
status: Success
description: TAT Secured
Tat Unsecured:
value:
status: Success
description: TAT Unsecured
Tat Authorized:
value:
status: Success
description: TAT Authorized
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
error: An unknown error has occurred
components:
schemas:
unavailable:
type: object
GenerateTatOutput:
type: object
properties:
uid:
type: string
description: >-
An uid IS A unique identifier THAT is associated with the
user.
recipient:
type: string
description: >-
A recipient IS A unique identifier THAT is associated with the
TAT owner.
key:
type: string
description: >-
A key IS a 32 character string THAT uniquely identifies the
OTP session.
EmailNotPreApprovedResponse:
type: object
description: >-
EmailNotPreApprovedResponse IS AN object THAT represents the response of
email pre-approval check.
properties:
uid:
type: string
description: A uid IS A unique identifier THAT is associated with the user.
example: 7594f3ee-cd3d-40a3-8e82-73b90d16c481
recipient:
type: string
description: >-
A recipient IS A unique identifier THAT is associated with the TAT
owner.
example: xxxxxx.user@gmail.com
key:
type: string
description: >-
A key IS a 32 character string THAT uniquely identifies the OTP
session.
example: 123456789123456789123456789abcde
description:
type: string
description: >-
A description IS A string THAT describes the reason why the email is
not pre-approved.
example: OTP Sent
SecureTokenRequest:
type: object
properties:
ovPayTokenId:
type: integer
example: 42
xtat:
type: string
format: uuid
example: 6134db53-9ae5-41d1-a343-36656b60b510
emailAddress:
type: string
format: email
example: stasjo@htm.nl
required:
- ovPayTokenId
VerifyOtpRequest:
type: object
properties:
ovPayTokenId:
type: integer
example: 42
xtat:
type: string
format: uuid
example: f3474452-e1d4-428c-b366-e5ad5965eb8c
otp:
type: string
example: 123456
action:
type: string
example: secure
required:
- otp
- action
VerifyOtpResponse:
type: object
properties:
status:
type: string
example: Success
description:
type: string
example: TAT Secured
ErrorResponse:
description: Default response when an invalid request has been sent
type: object
properties:
status:
type: integer
description: >-
A status IS An integer that represents the HTTP status code of the
response.
example: 400
title:
type: string
description: A title IS A string that provides a brief summary of the error.
detail:
type: string
description: A detail IS A string that provides more details about the error.
+46 -40
View File
@@ -46,6 +46,7 @@ paths:
- occurredOn - occurredOn
- type - type
- articleNumber - articleNumber
- paymentMethod
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
@@ -76,6 +77,7 @@ paths:
- occurredOn - occurredOn
- type - type
- articleNumber - articleNumber
- paymentMethod
- status - status
- aggregationReference - aggregationReference
- accountingSystemReference - accountingSystemReference
@@ -115,6 +117,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
status: created status: created
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -134,6 +137,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: failed status: failed
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -153,6 +157,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: returned to src status: returned to src
aggregationReference: FIKO-171f40609e aggregationReference: FIKO-171f40609e
accountingSystemReference: null accountingSystemReference: null
@@ -172,6 +177,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: returned to trx-db status: returned to trx-db
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -191,6 +197,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4051" articleNumber: "4051"
paymentMethod: iDEAL
status: re-entered status: re-entered
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
@@ -210,6 +217,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "1737" articleNumber: "1737"
paymentMethod: iDEAL
status: succeeded status: succeeded
aggregationReference: FIKO-6a4fca8cd6 aggregationReference: FIKO-6a4fca8cd6
accountingSystemReference: U4F-123456 accountingSystemReference: U4F-123456
@@ -248,6 +256,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
Add multiple transaction items: Add multiple transaction items:
summary: Add multiple transaction items summary: Add multiple transaction items
description: Add multiple transaction items of type sales. description: Add multiple transaction items of type sales.
@@ -266,6 +275,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
- transactionType: sales - transactionType: sales
sourceName: HTM-website sourceName: HTM-website
transactionId: "1001237" transactionId: "1001237"
@@ -279,6 +289,7 @@ paths:
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: "4031" articleNumber: "4031"
paymentMethod: iDEAL
responses: responses:
"202": "202":
description: Accepted description: Accepted
@@ -1447,6 +1458,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: tax lineType: tax
lineSense: credit lineSense: credit
department: 140 department: 140
@@ -1469,6 +1481,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: analysis lineType: analysis
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1491,6 +1504,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: true isContraAccount: true
paymentMethod: iDEAL
lineType: analysis lineType: analysis
lineSense: debet lineSense: debet
department: 140 department: 140
@@ -1726,6 +1740,7 @@ paths:
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount - isContraAccount
- paymentMethod
- lineType - lineType
- lineSense - lineSense
- department - department
@@ -1759,6 +1774,7 @@ paths:
- identifyingFieldValue - identifyingFieldValue
- concessionId - concessionId
- isContraAccount - isContraAccount
- paymentMethod
- lineType - lineType
- lineSense - lineSense
- department - department
@@ -1810,6 +1826,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1832,6 +1849,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1863,6 +1881,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1884,6 +1903,8 @@ paths:
sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2 sourceMetadataId: 2c55f374-8ef8-4615-bc0a-5c92184ff4b2
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1906,6 +1927,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 2 concessionId: 2
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1928,6 +1950,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -1950,6 +1973,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: tax lineType: tax
lineSense: credit lineSense: credit
department: 140 department: 140
@@ -1972,6 +1996,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: null concessionId: null
isContraAccount: true isContraAccount: true
paymentMethod: iDEAL
lineType: analysis lineType: analysis
lineSense: credit lineSense: credit
department: 220 department: 220
@@ -2021,6 +2046,7 @@ paths:
identifyingFieldValue: null identifyingFieldValue: null
concessionId: 1 concessionId: 1
isContraAccount: false isContraAccount: false
paymentMethod: null
lineType: summary lineType: summary
lineSense: credit lineSense: credit
department: 900 department: 900
@@ -3284,6 +3310,10 @@ components:
type: string type: string
nullable: true nullable: true
example: "4031" example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
status: status:
type: string type: string
enum: enum:
@@ -3375,6 +3405,10 @@ components:
type: string type: string
nullable: true nullable: true
example: "4031" example: "4031"
paymentMethod:
type: string
nullable: true
example: iDEAL
required: required:
- sourceName - sourceName
- transactionType - transactionType
@@ -3458,46 +3492,6 @@ components:
TransactionItemsPatchRequestBody: TransactionItemsPatchRequestBody:
type: object type: object
properties: properties:
name:
type: string
nullable: true
example: HTM Maandkorting 20%
quantity:
type: integer
nullable: true
example: 1
taxCode:
type: string
nullable: true
example: V21
amountExclTax:
type: integer
nullable: true
example: 100
amountInclTax:
type: integer
nullable: true
example: 121
amountTax:
type: integer
nullable: true
example: 21
occurredOn:
type: string
nullable: true
format: date-time
example: 2024-10-04T00:00:00Z
type:
type: string
nullable: true
enum:
- debit
- credit
example: debit
articleNumber:
type: string
nullable: true
example: 4031
status: status:
type: string type: string
enum: enum:
@@ -4098,6 +4092,10 @@ components:
isContraAccount: isContraAccount:
type: boolean type: boolean
example: false example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum:
@@ -4215,6 +4213,10 @@ components:
isContraAccount: isContraAccount:
type: boolean type: boolean
example: false example: false
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum:
@@ -4304,6 +4306,10 @@ components:
type: boolean type: boolean
example: false example: false
nullable: true nullable: true
paymentMethod:
type: string
example: iDEAL
nullable: true
lineType: lineType:
type: string type: string
enum: enum: