account-constraints
Operations addressed under /account-constraints — 16 operations.
get-account-constraint-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<AccountConstraintDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ConstraintType | int? | yes |
ConstraintStartDate | DateTime? | yes |
ConstraintDueDate | DateTime? | yes |
CustomerId | Guid? | yes |
AccountId | Guid? | yes |
Description | string | no |
OrganizationId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-account-constraint-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountIdconstraintDueDateconstraintStartDateconstraintTypedescriptionidorganizationIdcreate-account-constraint
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_140 | 400 | ACCOUNT_CONSTRAINT_ALREADY_EXISTS_IN_DATE_RANGE | This account is restricted from receiving funds for this organization or form. |
create-account-constraint › Request Body
accountIdconstraintDueDateconstraintStartDateconstraintTypedescriptionorganizationIdcreate-account-constraint › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
check-account-constraint
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CheckAccountConstraintDto.
| Field | Declared type | Nullable |
|---|---|---|
IsValid | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_16 | 400 | ACCOUNT_MUST_BE_NOT_NULL | Account not found. |
path Parameters
accountIdcheck-account-constraint › Request Body
constraintTypePermitted values — validated against the constraint_type parameter.
| Value | Meaning |
|---|---|
1 | Account cannot be viewed |
2 | Balance cannot be viewed |
3 | Account cannot debit |
4 | Account cannot credit |
formDefinitionIdorganizationIdcheck-account-constraint › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-account-constraint-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AccountConstraintDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ConstraintType | int? | yes |
ConstraintStartDate | DateTime? | yes |
ConstraintDueDate | DateTime? | yes |
CustomerId | Guid? | yes |
AccountId | Guid? | yes |
Description | string | no |
OrganizationId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
path Parameters
idget-account-constraint-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountIdconstraintDueDateconstraintStartDateconstraintTypedescriptionidorganizationIdupdate-account-constraint
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
path Parameters
idupdate-account-constraint › Request Body
accountIdconstraintDueDateconstraintStartDateconstraintTypedescriptionorganizationIdupdate-account-constraint › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-account-constraint
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
path Parameters
iddelete-account-constraint › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-account-constraint-form-map-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-account-constraint-form-map-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountConstraintIdconstraintFormDefinitionIdidcreate-account-constraint-form-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_143 | 400 | DUPLICATE_ACCOUNT_CONSTRAINT_FORM_MAP | Duplicate account constraint form map. |
path Parameters
idcreate-account-constraint-form-map › Request Body
constraintFormDefinitionIdcreate-account-constraint-form-map › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-constraint-form-map-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_145 | 400 | ACCOUNT_CONSTRAINT_FORM_MAP_NOT_FOUND | Account constraint form map not found. |
path Parameters
idaccountConstraintFormMapIdget-account-constraint-form-map-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountConstraintIdconstraintFormDefinitionIdidupdate-account-constraint-form-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_145 | 400 | ACCOUNT_CONSTRAINT_FORM_MAP_NOT_FOUND | Account constraint form map not found. |
path Parameters
idaccountConstraintFormMapIdupdate-account-constraint-form-map › Request Body
constraintFormDefinitionIdupdate-account-constraint-form-map › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-account-constraint-form-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_145 | 400 | ACCOUNT_CONSTRAINT_FORM_MAP_NOT_FOUND | Account constraint form map not found. |
path Parameters
idaccountConstraintFormMapIddelete-account-constraint-form-map › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-account-constraint-organization-map-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<AccountConstraintOrganizationMapDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountConstraintId | Guid? | yes |
ConstraintOrganizationId | Guid? | yes |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-account-constraint-organization-map-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountConstraintIdconstraintOrganizationIdidcreate-account-constraint-organization-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_144 | 400 | DUPLICATE_ACCOUNT_CONSTRAINT_ORGANIZATION_MAP | Duplicate account constraint organization map. |
path Parameters
idcreate-account-constraint-organization-map › Request Body
constraintOrganizationIdcreate-account-constraint-organization-map › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-constraint-organization-map-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AccountConstraintOrganizationMapDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountConstraintId | Guid? | yes |
ConstraintOrganizationId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_146 | 400 | ACCOUNT_CONSTRAINT_ORGANIZATION_MAP_NOT_FOUND | Account constraint organization map not found. |
path Parameters
idaccountConstraintOrganizationMapIdget-account-constraint-organization-map-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountConstraintIdconstraintOrganizationIdidupdate-account-constraint-organization-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_146 | 400 | ACCOUNT_CONSTRAINT_ORGANIZATION_MAP_NOT_FOUND | Account constraint organization map not found. |
path Parameters
idaccountConstraintOrganizationMapIdupdate-account-constraint-organization-map › Request Body
constraintOrganizationIdupdate-account-constraint-organization-map › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-account-constraint-organization-map
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_142 | 400 | ACCOUNT_CONSTRAINT_NOT_FOUND | Account constraint not found. |
ERR_ACCNT_146 | 400 | ACCOUNT_CONSTRAINT_ORGANIZATION_MAP_NOT_FOUND | Account constraint organization map not found. |
path Parameters
idaccountConstraintOrganizationMapIddelete-account-constraint-organization-map › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.