Add Addison Accounting System
Allows adding an Addison accounting system in Basecone.
POST accountingsystems/addison
Request properties
Property | Type | Length | Description | Optional |
---|---|---|---|---|
Connection name | String | 90 | Accounting system connection name. | No |
Secret | String | 255 | Addison | It is required if secret token authentication is used. Not required if basic authentication (username and password) is provided. |
Username | String | 100 | Accounting system password | It is required if basic authentication (username and password) is used. Not required if secret token authentication is provided. |
Password | String | 100 | Accounting system password | It is required if basic authentication (username and password) is used. Not required if secret token authentication is provided. |
BaseconeUserId | Guid | - | Basecone user id. | No |
Please note that unlike other API requests, pagination and sorting are not supported.
Example request
{ "connectionname": "Addison connection", "secret": "some super secret", "username": "some username", "password": "super secret password", "baseconeUserId": "45080DFE-316C-4EB0-8C84-676942D792F1" }
Success response
Upon successful operation a 200 status code will be returned, containing the created accounting system identifier.
Example response:
{ "accountingSystemId": "f5278262-b4a6-4503-9e7b-a89b65b2f214" }
Error response
Case an error occurs, a 400 status code will be returned, containing error message(s).
Example response:
{ "message": "One or more validation errors occurred.", "code": "validation_error", "_metadata":[ { "field": "result", "message": "AccountingSystemNameInUse", "code": "accounting_system_name_in_use" } ] }
Possible error responses
Status code | Error code | Details |
---|---|---|
400 | accounting_system_name_in_use | Accounting system name is in use. |
400 | accounting_system_credentials_incorrect | Accounting system credentials are not valid. |
400 | provided_user_does_not_belong_to_office | User identified by BaseconeUserId does not belong to the office. |