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

Reference

Coworkerinvoicehistory

The coworkerinvoicehistory object

Attributes
Id: long required, autogenerated, unique
The unique identifier for this coworkerinvoicehistory
CoworkerInvoiceId: Id required
Description: string required
IsProblem: bool optional
Name: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerinvoicehistory
SystemId: string optional api-only
User defined data about this coworkerinvoicehistory. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "CoworkerInvoiceId": 12345678,
  "Description": "00001",
  "IsProblem": false,
  "Name": "00001",
  "UniqueId": "cc8c0d3b-1a43-46ec-8273-9453142e98f6",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a CoworkerInvoiceHistory

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

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

🔒 Requires role "CoworkerInvoiceHistory-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=CreatedOn
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 coworkerinvoicehistory records based on their different properties.
Id number
?Id=12345678
CoworkerInvoiceHistory_CoworkerInvoice CoworkerInvoice
?CoworkerInvoiceHistory_CoworkerInvoice=...
CoworkerInvoiceHistory_Description string
?CoworkerInvoiceHistory_Description=...
CoworkerInvoiceHistory_IsProblem bool
?CoworkerInvoiceHistory_IsProblem=...
CoworkerInvoiceHistory_Name string
?CoworkerInvoiceHistory_Name=...
CoworkerInvoiceHistory_CoworkerInvoice_Coworker_Id string
?CoworkerInvoiceHistory_CoworkerInvoice_Coworker_Id=...
CoworkerInvoiceHistory_CoworkerInvoice_Business_Id string
?CoworkerInvoiceHistory_CoworkerInvoice_Business_Id=...
CoworkerInvoiceHistory_CoworkerInvoice_Business_Currency_Code string
?CoworkerInvoiceHistory_CoworkerInvoice_Business_Currency_Code=...
CoworkerInvoiceHistory_CoworkerInvoice_Coworker_FullName string
?CoworkerInvoiceHistory_CoworkerInvoice_Coworker_FullName=...
CoworkerInvoiceHistory_CoworkerInvoice_TotalAmount string
?CoworkerInvoiceHistory_CoworkerInvoice_TotalAmount=...
CoworkerInvoiceHistory_CoworkerInvoice_InvoiceNumber string
?CoworkerInvoiceHistory_CoworkerInvoice_InvoiceNumber=...
CoworkerInvoiceHistory_CoworkerInvoice_BillToName string
?CoworkerInvoiceHistory_CoworkerInvoice_BillToName=...
CoworkerInvoiceHistory_CoworkerInvoice_Paid string
?CoworkerInvoiceHistory_CoworkerInvoice_Paid=...
CoworkerInvoiceHistory_CoworkerInvoice_PaidOn string
?CoworkerInvoiceHistory_CoworkerInvoice_PaidOn=...
CoworkerInvoiceHistory_CoworkerInvoice_Refunded string
?CoworkerInvoiceHistory_CoworkerInvoice_Refunded=...
CoworkerInvoiceHistory_CoworkerInvoice_RefundedOn string
?CoworkerInvoiceHistory_CoworkerInvoice_RefundedOn=...
CoworkerInvoiceHistory_CoworkerInvoice_DueDate string
?CoworkerInvoiceHistory_CoworkerInvoice_DueDate=...
CoworkerInvoiceHistory_CoworkerInvoice_Draft string
?CoworkerInvoiceHistory_CoworkerInvoice_Draft=...

Range search querystring parameters
Lets you search coworkerinvoicehistory records based on a range of date or numeric values.
To_CoworkerInvoiceHistory_CreatedOn date
?To_CoworkerInvoiceHistory_CreatedOn=2010-01-01T20:32
From_CoworkerInvoiceHistory_CreatedOn date
?From_CoworkerInvoiceHistory_CreatedOn=2010-01-01T20:32
To_CoworkerInvoiceHistory_UpdatedOn date
?To_CoworkerInvoiceHistory_UpdatedOn=2010-01-01T20:32
From_CoworkerInvoiceHistory_UpdatedOn date
?From_CoworkerInvoiceHistory_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerInvoice": ,
        "Name": "00001",
        "Description": "00001",
        "IsProblem": false,
        "CoworkerInvoiceHistoryCoworkerInvoiceCoworker_Id": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBusiness_Id": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBusiness_Currency_Code": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceCoworker_FullName": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceTotalAmount": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceInvoiceNumber": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBillToName": "...",
        "CoworkerInvoiceHistoryCoworkerInvoicePaid": "...",
        "CoworkerInvoiceHistoryCoworkerInvoicePaidOn": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceRefunded": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceRefundedOn": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceDueDate": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceDraft": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9637191d-8691-4ff9-96b8-a142d0c4cf35",
        "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 CoworkerInvoiceHistories by IDs

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

🔒 Requires role "CoworkerInvoiceHistory-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerInvoice": ,
        "Name": "00001",
        "Description": "00001",
        "IsProblem": false,
        "CoworkerInvoiceHistoryCoworkerInvoiceCoworker_Id": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBusiness_Id": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBusiness_Currency_Code": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceCoworker_FullName": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceTotalAmount": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceInvoiceNumber": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceBillToName": "...",
        "CoworkerInvoiceHistoryCoworkerInvoicePaid": "...",
        "CoworkerInvoiceHistoryCoworkerInvoicePaidOn": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceRefunded": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceRefundedOn": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceDueDate": "...",
        "CoworkerInvoiceHistoryCoworkerInvoiceDraft": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "266e8323-85ec-44e9-b19d-31a33e4e3103",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "CreatedOn",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single CoworkerInvoiceHistory by Id

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

🔒 Requires role "CoworkerInvoiceHistory-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CoworkerInvoiceId": 12345678,
  "Description": "00001",
  "IsProblem": false,
  "Name": "00001",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "b44ab996-d301-4868-a796-117a2f00d616",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new CoworkerInvoiceHistory

Creates a new coworkerinvoicehistory. 
POST https://spaces.nexudus.com/api/billing/coworkerinvoicehistories

🔒 Requires role "CoworkerInvoiceHistory-Create"

Body parameters
CoworkerInvoiceId: number required
Name: string required
Description: string required
IsProblem: bool optional

Example request

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


{
    "CoworkerInvoiceId": 12345678,
    "Name": "00001",
    "Description": "00001",
    "IsProblem": false,
}

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 CoworkerInvoiceHistory

Updates an existing coworkerinvoicehistory. 
PUT https://spaces.nexudus.com/api/billing/coworkerinvoicehistories

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

🔒 Requires role "CoworkerInvoiceHistory-Edit"

Body parameters
Id: number required
The unique Id of the coworkerinvoicehistory to update.
CoworkerInvoiceId: number cleared if missing
Name: string cleared if missing
Description: string cleared if missing
IsProblem: bool cleared if missing

Example request

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


{
    "Id": 12345678,
    "CoworkerInvoiceId": 12345678,
    "Name": "00001",
    "Description": "00001",
    "IsProblem": false,
}

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

Commands

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

Example request

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

Example request

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