Reference

Ledgerentry

The ledgerentry object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this ledgerentry
BusinessId: Id required
Code: string required
Credit: decimal required
Debit: decimal required
Description: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this ledgerentry
SystemId: string optional api-only
User defined data about this ledgerentry. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Code": "00001",
  "Credit": 1.2,
  "Debit": 1.2,
  "Description": "Descripción",
  "UniqueId": "fc1c422d-7b8a-494d-810c-16a66eef6a5c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a LedgerEntry

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

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

🔒 Requires role "LedgerEntry-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 ledgerentry records based on their different properties.
Id number
?Id=12345678
LedgerEntry_Business Business
?LedgerEntry_Business=...
LedgerEntry_Code string
?LedgerEntry_Code=...
LedgerEntry_Credit decimal
?LedgerEntry_Credit=...
LedgerEntry_Debit decimal
?LedgerEntry_Debit=...
LedgerEntry_Description string
?LedgerEntry_Description=...

Range search querystring parameters
Lets you search ledgerentry records based on a range of date or numeric values.
To_LedgerEntry_CreatedOn date
?To_LedgerEntry_CreatedOn=2010-01-01T20:32
From_LedgerEntry_CreatedOn date
?From_LedgerEntry_CreatedOn=2010-01-01T20:32
To_LedgerEntry_UpdatedOn date
?To_LedgerEntry_UpdatedOn=2010-01-01T20:32
From_LedgerEntry_UpdatedOn date
?From_LedgerEntry_UpdatedOn=2010-01-01T20:32
To_LedgerEntry_Debit number
?To_LedgerEntry_Debit=0
From_LedgerEntry_Debit number
?From_LedgerEntry_Debit=10
To_LedgerEntry_Credit number
?To_LedgerEntry_Credit=0
From_LedgerEntry_Credit number
?From_LedgerEntry_Credit=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Code": "00001",
        "Description": "Descripción",
        "Debit": 1.2,
        "Credit": 1.2,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "d2cc2182-fb77-4523-94b6-ecf9e5ec4bcc",
        "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 LedgerEntries by IDs

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

🔒 Requires role "LedgerEntry-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Code": "00001",
        "Description": "Descripción",
        "Debit": 1.2,
        "Credit": 1.2,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "90dc03c0-a9cd-4c9b-9b26-8edf672dbc63",
        "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 LedgerEntry by Id

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

🔒 Requires role "LedgerEntry-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Code": "00001",
  "Credit": 1.2,
  "Debit": 1.2,
  "Description": "Descripción",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "fbda3857-d4b0-466a-8f49-c3cefb171e0e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new LedgerEntry

Creates a new ledgerentry.
POST https://spaces.nexudus.com/api/billing/ledgerentries

🔒 Requires role "LedgerEntry-Create"

Body parameters
BusinessId: number required
Code: string required
Description: string required
Debit: decimal required
Credit: decimal required

Example request

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

{
    "BusinessId": 12345678,
    "Code": "00001",
    "Description": "Descripción",
    "Debit": 1.2,
    "Credit": 1.2,
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more ledgerentry 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 ledgerentry records.
GET https://spaces.nexudus.com/api/billing/ledgerentries/commands

Example request

GET https://spaces.nexudus.com/api/billing/ledgerentries/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 ledgerentry record IDs.
POST https://spaces.nexudus.com/api/billing/ledgerentries/runacommand
🔒 Requires role "LedgerEntry-Edit"

Example request

POST https://spaces.nexudus.com/api/billing/ledgerentries/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
}


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.