API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Billing

Reference

Financialaccount

The financialaccount object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this financialaccount
AccountType: Nexudus.Coworking.Core.Enums.eFinancialAccountType optional
BusinessId: Id required
Code: string required
Description: string optional
Name: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this financialaccount
SystemId: string optional api-only
User defined data about this financialaccount. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "AccountType": 1,
  "BusinessId": 12345678,
  "Code": "Code",
  "Description": "Description",
  "Name": "Name",
  "UniqueId": "d5836192-7a53-4ec6-9a91-bcc4c8012977",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a FinancialAccount

This endpoint allows you to GET a list of financialaccounts based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/billing/financialaccounts?...

🔒 Requires role "FinancialAccount-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search financialaccount records based on their different properties.
Id number
?Id=12345678
FinancialAccount_AccountType Nexudus.Coworking.Core.Enums.eFinancialAccountType
?FinancialAccount_AccountType=...
FinancialAccount_Business Business
?FinancialAccount_Business=...
FinancialAccount_Code string
?FinancialAccount_Code=...
FinancialAccount_Description string
?FinancialAccount_Description=...
FinancialAccount_Name string
?FinancialAccount_Name=...

Range search querystring parameters
Lets you search financialaccount records based on a range of date or numeric values.
To_FinancialAccount_CreatedOn date
?To_FinancialAccount_CreatedOn=2010-01-01T20:32
From_FinancialAccount_CreatedOn date
?From_FinancialAccount_CreatedOn=2010-01-01T20:32
To_FinancialAccount_UpdatedOn date
?To_FinancialAccount_UpdatedOn=2010-01-01T20:32
From_FinancialAccount_UpdatedOn date
?From_FinancialAccount_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/billing/financialaccounts?FinancialAccount_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Code": "Code",
        "Description": "Description",
        "AccountType": 1,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7db2e923-4bf6-4995-a0a9-54df93796be2",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}

Find FinancialAccounts by IDs

Gets one or more financialaccount records based on their Id. 
GET https://spaces.nexudus.com/api/billing/financialaccounts?FinancialAccount_Id=[:id1,:id2,...]

🔒 Requires role "FinancialAccount-List"

Querystring parameters
FinancialAccount_Id: array requried
?FinancialAccount_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/billing/financialaccounts?FinancialAccount_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Code": "Code",
        "Description": "Description",
        "AccountType": 1,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9ac8a98f-c366-4413-bc95-09f9a8a3555e",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single FinancialAccount by Id

Gets one financialaccount record by its Id. 
GET https://spaces.nexudus.com/api/billing/financialaccounts/:Id

🔒 Requires role "FinancialAccount-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/billing/financialaccounts/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "AccountType": 1,
  "BusinessId": 12345678,
  "Code": "Code",
  "Description": "Description",
  "Name": "Name",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "39288784-5bdc-47f0-b2f7-318a0c8fc548",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new FinancialAccount

Creates a new financialaccount. 
POST https://spaces.nexudus.com/api/billing/financialaccounts

🔒 Requires role "FinancialAccount-Create"

Body parameters
BusinessId: number required
Name: string required
Code: string required
Description: string optional
AccountType: Nexudus.Coworking.Core.Enums.eFinancialAccountType optional

Example request

POST https://spaces.nexudus.com/api/billing/financialaccounts
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "BusinessId": 12345678,
    "Name": "Name",
    "Code": "Code",
    "Description": "Description",
    "AccountType": 1, //(check Enumerated values section below)
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Update FinancialAccount

Updates an existing financialaccount. 
PUT https://spaces.nexudus.com/api/billing/financialaccounts

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

🔒 Requires role "FinancialAccount-Edit"

Body parameters
Id: number required
The unique Id of the financialaccount to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Code: string cleared if missing
Description: string cleared if missing
AccountType: Nexudus.Coworking.Core.Enums.eFinancialAccountType cleared if missing

Example request

PUT https://spaces.nexudus.com/api/billing/financialaccounts
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Code": "Code",
    "Description": "Description",
    "AccountType": 1, //(check Enumerated values section below)
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Delete FinancialAccount

Deletes an existing financialaccount by its Id. 
DELETE https://spaces.nexudus.com/api/billing/financialaccounts/:Id

🔒 Requires role "FinancialAccount-Delete"

URL parameters
Id: number required
The unique Id of the financialaccount to update.

Example request

DELETE https://spaces.nexudus.com/api/billing/financialaccounts/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}

Commands

Commands allow to perform actions against one or more financialaccount records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for financialaccount records. 
GET https://spaces.nexudus.com/api/billing/financialaccounts/commands

Example request

GET https://spaces.nexudus.com/api/billing/financialaccounts/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]

Run Command

Runs a command based on its Key and one or more financialaccount record IDs. 
POST https://spaces.nexudus.com/api/billing/financialaccounts/runacommand
🔒 Requires role "FinancialAccount-Edit"

Example request

POST https://spaces.nexudus.com/api/billing/financialaccounts/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}

Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}

Enumerated values

AccountType

GET /api/utils/enums?name=eFinancialAccountType

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.