Reference

Businesscharge

The businesscharge object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this businesscharge
ApprovedByBusiness: bool optional read-only
ApprovedBySender: bool optional read-only
BusinessId: Id required
CallBackUrl: string required
Description: string required
DueDate: DateTime? optional
Invoiced: bool optional read-only
InvoicedOn: DateTime? optional read-only
Recurrent: bool optional read-only
TaxAmount: decimal required
TotalAmount: decimal required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this businesscharge
SystemId: string optional api-only
User defined data about this businesscharge. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ApprovedByBusiness": false,
  "ApprovedBySender": false,
  "BusinessId": 12345678,
  "CallBackUrl": "Callback",
  "Description": "Descripción",
  "DueDate": ,
  "Invoiced": false,
  "InvoicedOn": ,
  "Recurrent": false,
  "TaxAmount": 1.2,
  "TotalAmount": 1.2,
  "UniqueId": "823e8cf9-23c1-4888-bdd4-99c6496fbfcc",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a BusinessCharge

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

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

🔒 Requires role "BusinessCharge-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 businesscharge records based on their different properties.
Id number
?Id=12345678
BusinessCharge_ApprovedByBusiness bool
?BusinessCharge_ApprovedByBusiness=...
BusinessCharge_ApprovedBySender bool
?BusinessCharge_ApprovedBySender=...
BusinessCharge_Business Business
?BusinessCharge_Business=...
BusinessCharge_CallBackUrl string
?BusinessCharge_CallBackUrl=...
BusinessCharge_Description string
?BusinessCharge_Description=...
BusinessCharge_DueDate DateTime?
?BusinessCharge_DueDate=...
BusinessCharge_Invoiced bool
?BusinessCharge_Invoiced=...
BusinessCharge_InvoicedOn DateTime?
?BusinessCharge_InvoicedOn=...
BusinessCharge_Recurrent bool
?BusinessCharge_Recurrent=...
BusinessCharge_TaxAmount decimal
?BusinessCharge_TaxAmount=...
BusinessCharge_TotalAmount decimal
?BusinessCharge_TotalAmount=...

Range search querystring parameters
Lets you search businesscharge records based on a range of date or numeric values.
To_BusinessCharge_CreatedOn date
?To_BusinessCharge_CreatedOn=2010-01-01T20:32
From_BusinessCharge_CreatedOn date
?From_BusinessCharge_CreatedOn=2010-01-01T20:32
To_BusinessCharge_UpdatedOn date
?To_BusinessCharge_UpdatedOn=2010-01-01T20:32
From_BusinessCharge_UpdatedOn date
?From_BusinessCharge_UpdatedOn=2010-01-01T20:32
To_BusinessCharge_DueDate date
?To_BusinessCharge_DueDate=2010-01-01T20:32
From_BusinessCharge_DueDate date
?From_BusinessCharge_DueDate=2010-01-01T20:32
To_BusinessCharge_TotalAmount number
?To_BusinessCharge_TotalAmount=0
From_BusinessCharge_TotalAmount number
?From_BusinessCharge_TotalAmount=10
To_BusinessCharge_TaxAmount number
?To_BusinessCharge_TaxAmount=0
From_BusinessCharge_TaxAmount number
?From_BusinessCharge_TaxAmount=10
To_BusinessCharge_InvoicedOn date
?To_BusinessCharge_InvoicedOn=2010-01-01T20:32
From_BusinessCharge_InvoicedOn date
?From_BusinessCharge_InvoicedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Description": "Descripción",
        "CallBackUrl": "Callback",
        "DueDate": ,
        "TotalAmount": 1.2,
        "TaxAmount": 1.2,
        "Invoiced": false,
        "InvoicedOn": ,
        "ApprovedByBusiness": false,
        "ApprovedBySender": false,
        "Recurrent": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6a8c78ec-2b5b-485d-ae72-d64c86b96fb8",
        "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 BusinessCharges by IDs

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

🔒 Requires role "BusinessCharge-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Description": "Descripción",
        "CallBackUrl": "Callback",
        "DueDate": ,
        "TotalAmount": 1.2,
        "TaxAmount": 1.2,
        "Invoiced": false,
        "InvoicedOn": ,
        "ApprovedByBusiness": false,
        "ApprovedBySender": false,
        "Recurrent": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "869ab36c-3381-4735-bdf3-10dd0fe30a27",
        "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 BusinessCharge by Id

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

🔒 Requires role "BusinessCharge-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ApprovedByBusiness": false,
  "ApprovedBySender": false,
  "BusinessId": 12345678,
  "CallBackUrl": "Callback",
  "Description": "Descripción",
  "DueDate": ,
  "Invoiced": false,
  "InvoicedOn": ,
  "Recurrent": false,
  "TaxAmount": 1.2,
  "TotalAmount": 1.2,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "82e35941-71a3-4ad1-bbd7-4cb37ac99e70",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new BusinessCharge

Creates a new businesscharge.
POST https://spaces.nexudus.com/api/billing/businesscharges

🔒 Requires role "BusinessCharge-Create"

Body parameters
BusinessId: number required
Description: string required
CallBackUrl: string required
DueDate: DateTime? optional
TotalAmount: decimal required
TaxAmount: decimal required

Example request

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

{
    "BusinessId": 12345678,
    "Description": "Descripción",
    "CallBackUrl": "Callback",
    "DueDate": ,
    "TotalAmount": 1.2,
    "TaxAmount": 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 businesscharge 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 businesscharge records.
GET https://spaces.nexudus.com/api/billing/businesscharges/commands

Example request

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

Example request

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