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

Reference

Coworkerinvoiceline

The coworkerinvoiceline object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerinvoiceline
BookingUniqueId: Guid? optional read-only
ContractDepositUniqueId: Guid? optional read-only
CoworkerChargeUniqueId: Guid? optional read-only
CoworkerContractUniqueId: Guid? optional read-only
CoworkerExtraServiceName: string optional read-only
CoworkerExtraServiceUniqueId: Guid? optional read-only
CoworkerInvoiceId: Id required
CoworkerProductName: string optional read-only
CoworkerProductUniqueId: Guid? optional read-only
CoworkerTimePassName: string optional read-only
CoworkerTimePassUniqueId: Guid? optional read-only
Description: string required
DiscountAmount: decimal? optional read-only
DiscountCode: string optional read-only
EventAttendeeProductName: string optional read-only
EventAttendeeUniqueId: Guid? optional read-only
FinancialAccountCode: string optional
FinancialAccountName: string optional
IsHidden: bool optional read-only
IsUniversalCredit: bool optional read-only
Position: int required read-only
Quantity: int required
Refunded: bool optional read-only
RefundedAmount: decimal? optional read-only
RefundedOn: DateTime? optional read-only
SaleDate: DateTime? optional read-only
SubTotal: decimal required
TariffName: string optional read-only
TaxAmount: decimal required
TaxCategoryName: string optional
TaxRate: decimal required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerinvoiceline
SystemId: string optional api-only
User defined data about this coworkerinvoiceline. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "BookingUniqueId": ,
  "ContractDepositUniqueId": ,
  "CoworkerChargeUniqueId": ,
  "CoworkerContractUniqueId": ,
  "CoworkerExtraServiceName": "Abc123456",
  "CoworkerExtraServiceUniqueId": ,
  "CoworkerInvoiceId": 12345678,
  "CoworkerProductName": "Abc123456",
  "CoworkerProductUniqueId": ,
  "CoworkerTimePassName": "Abc123456",
  "CoworkerTimePassUniqueId": ,
  "Description": "BillToName",
  "DiscountAmount": ,
  "DiscountCode": "null",
  "EventAttendeeProductName": "Abc123456",
  "EventAttendeeUniqueId": ,
  "FinancialAccountCode": "Abc123456",
  "FinancialAccountName": "Abc123456",
  "IsHidden": false,
  "IsUniversalCredit": false,
  "Position": ,
  "Quantity": ,
  "Refunded": false,
  "RefundedAmount": ,
  "RefundedOn": ,
  "SaleDate": ,
  "SubTotal": 1.2,
  "TariffName": "Abc123456",
  "TaxAmount": 1.2,
  "TaxCategoryName": "Joe",
  "TaxRate": 1.2,
  "UniqueId": "cb610a9c-2621-4298-bf44-f50344cdc1df",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a CoworkerInvoiceLine

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

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

🔒 Requires role "CoworkerInvoiceLine-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=Position
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 coworkerinvoiceline records based on their different properties.
Id number
?Id=12345678
CoworkerInvoiceLine_BookingUniqueId Guid?
?CoworkerInvoiceLine_BookingUniqueId=...
CoworkerInvoiceLine_ContractDepositUniqueId Guid?
?CoworkerInvoiceLine_ContractDepositUniqueId=...
CoworkerInvoiceLine_CoworkerChargeUniqueId Guid?
?CoworkerInvoiceLine_CoworkerChargeUniqueId=...
CoworkerInvoiceLine_CoworkerContractUniqueId Guid?
?CoworkerInvoiceLine_CoworkerContractUniqueId=...
CoworkerInvoiceLine_CoworkerExtraServiceName string
?CoworkerInvoiceLine_CoworkerExtraServiceName=...
CoworkerInvoiceLine_CoworkerExtraServiceUniqueId Guid?
?CoworkerInvoiceLine_CoworkerExtraServiceUniqueId=...
CoworkerInvoiceLine_CoworkerInvoice CoworkerInvoice
?CoworkerInvoiceLine_CoworkerInvoice=...
CoworkerInvoiceLine_CoworkerProductName string
?CoworkerInvoiceLine_CoworkerProductName=...
CoworkerInvoiceLine_CoworkerProductUniqueId Guid?
?CoworkerInvoiceLine_CoworkerProductUniqueId=...
CoworkerInvoiceLine_CoworkerTimePassName string
?CoworkerInvoiceLine_CoworkerTimePassName=...
CoworkerInvoiceLine_CoworkerTimePassUniqueId Guid?
?CoworkerInvoiceLine_CoworkerTimePassUniqueId=...
CoworkerInvoiceLine_Description string
?CoworkerInvoiceLine_Description=...
CoworkerInvoiceLine_DiscountAmount decimal?
?CoworkerInvoiceLine_DiscountAmount=...
CoworkerInvoiceLine_DiscountCode string
?CoworkerInvoiceLine_DiscountCode=...
CoworkerInvoiceLine_EventAttendeeProductName string
?CoworkerInvoiceLine_EventAttendeeProductName=...
CoworkerInvoiceLine_EventAttendeeUniqueId Guid?
?CoworkerInvoiceLine_EventAttendeeUniqueId=...
CoworkerInvoiceLine_FinancialAccountCode string
?CoworkerInvoiceLine_FinancialAccountCode=...
CoworkerInvoiceLine_FinancialAccountName string
?CoworkerInvoiceLine_FinancialAccountName=...
CoworkerInvoiceLine_IsHidden bool
?CoworkerInvoiceLine_IsHidden=...
CoworkerInvoiceLine_IsUniversalCredit bool
?CoworkerInvoiceLine_IsUniversalCredit=...
CoworkerInvoiceLine_Position int
?CoworkerInvoiceLine_Position=...
CoworkerInvoiceLine_Quantity int
?CoworkerInvoiceLine_Quantity=...
CoworkerInvoiceLine_Refunded bool
?CoworkerInvoiceLine_Refunded=...
CoworkerInvoiceLine_RefundedAmount decimal?
?CoworkerInvoiceLine_RefundedAmount=...
CoworkerInvoiceLine_RefundedOn DateTime?
?CoworkerInvoiceLine_RefundedOn=...
CoworkerInvoiceLine_SaleDate DateTime?
?CoworkerInvoiceLine_SaleDate=...
CoworkerInvoiceLine_SubTotal decimal
?CoworkerInvoiceLine_SubTotal=...
CoworkerInvoiceLine_TariffName string
?CoworkerInvoiceLine_TariffName=...
CoworkerInvoiceLine_TaxAmount decimal
?CoworkerInvoiceLine_TaxAmount=...
CoworkerInvoiceLine_TaxCategoryName string
?CoworkerInvoiceLine_TaxCategoryName=...
CoworkerInvoiceLine_TaxRate decimal
?CoworkerInvoiceLine_TaxRate=...

Range search querystring parameters
Lets you search coworkerinvoiceline records based on a range of date or numeric values.
To_CoworkerInvoiceLine_CreatedOn date
?To_CoworkerInvoiceLine_CreatedOn=2010-01-01T20:32
From_CoworkerInvoiceLine_CreatedOn date
?From_CoworkerInvoiceLine_CreatedOn=2010-01-01T20:32
To_CoworkerInvoiceLine_UpdatedOn date
?To_CoworkerInvoiceLine_UpdatedOn=2010-01-01T20:32
From_CoworkerInvoiceLine_UpdatedOn date
?From_CoworkerInvoiceLine_UpdatedOn=2010-01-01T20:32
To_CoworkerInvoiceLine_Quantity number
?To_CoworkerInvoiceLine_Quantity=0
From_CoworkerInvoiceLine_Quantity number
?From_CoworkerInvoiceLine_Quantity=10
To_CoworkerInvoiceLine_SubTotal number
?To_CoworkerInvoiceLine_SubTotal=0
From_CoworkerInvoiceLine_SubTotal number
?From_CoworkerInvoiceLine_SubTotal=10
To_CoworkerInvoiceLine_TaxAmount number
?To_CoworkerInvoiceLine_TaxAmount=0
From_CoworkerInvoiceLine_TaxAmount number
?From_CoworkerInvoiceLine_TaxAmount=10
To_CoworkerInvoiceLine_TaxRate number
?To_CoworkerInvoiceLine_TaxRate=0
From_CoworkerInvoiceLine_TaxRate number
?From_CoworkerInvoiceLine_TaxRate=10
To_CoworkerInvoiceLine_RefundedAmount number
?To_CoworkerInvoiceLine_RefundedAmount=0
From_CoworkerInvoiceLine_RefundedAmount number
?From_CoworkerInvoiceLine_RefundedAmount=10
To_CoworkerInvoiceLine_RefundedOn date
?To_CoworkerInvoiceLine_RefundedOn=2010-01-01T20:32
From_CoworkerInvoiceLine_RefundedOn date
?From_CoworkerInvoiceLine_RefundedOn=2010-01-01T20:32
To_CoworkerInvoiceLine_SaleDate date
?To_CoworkerInvoiceLine_SaleDate=2010-01-01T20:32
From_CoworkerInvoiceLine_SaleDate date
?From_CoworkerInvoiceLine_SaleDate=2010-01-01T20:32
To_CoworkerInvoiceLine_DiscountAmount number
?To_CoworkerInvoiceLine_DiscountAmount=0
From_CoworkerInvoiceLine_DiscountAmount number
?From_CoworkerInvoiceLine_DiscountAmount=10
To_CoworkerInvoiceLine_Position number
?To_CoworkerInvoiceLine_Position=0
From_CoworkerInvoiceLine_Position number
?From_CoworkerInvoiceLine_Position=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerInvoice": ,
        "Description": "BillToName",
        "TaxCategoryName": "Joe",
        "Quantity": ,
        "SubTotal": 1.2,
        "TaxAmount": 1.2,
        "TaxRate": 1.2,
        "CoworkerContractUniqueId": ,
        "ContractDepositUniqueId": ,
        "BookingUniqueId": ,
        "CoworkerExtraServiceUniqueId": ,
        "CoworkerTimePassUniqueId": ,
        "CoworkerChargeUniqueId": ,
        "CoworkerProductUniqueId": ,
        "EventAttendeeUniqueId": ,
        "RefundedAmount": ,
        "Refunded": false,
        "RefundedOn": ,
        "SaleDate": ,
        "DiscountCode": "null",
        "DiscountAmount": ,
        "CoworkerExtraServiceName": "Abc123456",
        "CoworkerTimePassName": "Abc123456",
        "CoworkerProductName": "Abc123456",
        "EventAttendeeProductName": "Abc123456",
        "TariffName": "Abc123456",
        "FinancialAccountCode": "Abc123456",
        "FinancialAccountName": "Abc123456",
        "Position": ,
        "IsHidden": false,
        "IsUniversalCredit": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "5ded35f4-6ffc-4ee9-b231-9b8e1a7fe991",
        "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 CoworkerInvoiceLines by IDs

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

🔒 Requires role "CoworkerInvoiceLine-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerInvoice": ,
        "Description": "BillToName",
        "TaxCategoryName": "Joe",
        "Quantity": ,
        "SubTotal": 1.2,
        "TaxAmount": 1.2,
        "TaxRate": 1.2,
        "CoworkerContractUniqueId": ,
        "ContractDepositUniqueId": ,
        "BookingUniqueId": ,
        "CoworkerExtraServiceUniqueId": ,
        "CoworkerTimePassUniqueId": ,
        "CoworkerChargeUniqueId": ,
        "CoworkerProductUniqueId": ,
        "EventAttendeeUniqueId": ,
        "RefundedAmount": ,
        "Refunded": false,
        "RefundedOn": ,
        "SaleDate": ,
        "DiscountCode": "null",
        "DiscountAmount": ,
        "CoworkerExtraServiceName": "Abc123456",
        "CoworkerTimePassName": "Abc123456",
        "CoworkerProductName": "Abc123456",
        "EventAttendeeProductName": "Abc123456",
        "TariffName": "Abc123456",
        "FinancialAccountCode": "Abc123456",
        "FinancialAccountName": "Abc123456",
        "Position": ,
        "IsHidden": false,
        "IsUniversalCredit": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9960db70-9f33-4b6f-a4e0-1a1db9e1d1b8",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Position",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single CoworkerInvoiceLine by Id

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

🔒 Requires role "CoworkerInvoiceLine-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BookingUniqueId": ,
  "ContractDepositUniqueId": ,
  "CoworkerChargeUniqueId": ,
  "CoworkerContractUniqueId": ,
  "CoworkerExtraServiceName": "Abc123456",
  "CoworkerExtraServiceUniqueId": ,
  "CoworkerInvoiceId": 12345678,
  "CoworkerProductName": "Abc123456",
  "CoworkerProductUniqueId": ,
  "CoworkerTimePassName": "Abc123456",
  "CoworkerTimePassUniqueId": ,
  "Description": "BillToName",
  "DiscountAmount": ,
  "DiscountCode": "null",
  "EventAttendeeProductName": "Abc123456",
  "EventAttendeeUniqueId": ,
  "FinancialAccountCode": "Abc123456",
  "FinancialAccountName": "Abc123456",
  "IsHidden": false,
  "IsUniversalCredit": false,
  "Position": ,
  "Quantity": ,
  "Refunded": false,
  "RefundedAmount": ,
  "RefundedOn": ,
  "SaleDate": ,
  "SubTotal": 1.2,
  "TariffName": "Abc123456",
  "TaxAmount": 1.2,
  "TaxCategoryName": "Joe",
  "TaxRate": 1.2,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "7c1a016b-6129-4611-a357-96860f82c4ee",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new CoworkerInvoiceLine

Creates a new coworkerinvoiceline. 
POST https://spaces.nexudus.com/api/billing/coworkerinvoicelines

🔒 Requires role "CoworkerInvoiceLine-Create"

Body parameters
CoworkerInvoiceId: number required
Description: string required
TaxCategoryName: string optional
Quantity: int required
SubTotal: decimal required
TaxAmount: decimal required
TaxRate: decimal required
FinancialAccountCode: string optional
FinancialAccountName: string optional

Example request

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


{
    "CoworkerInvoiceId": 12345678,
    "Description": "BillToName",
    "TaxCategoryName": "Joe",
    "Quantity": ,
    "SubTotal": 1.2,
    "TaxAmount": 1.2,
    "TaxRate": 1.2,
    "FinancialAccountCode": "Abc123456",
    "FinancialAccountName": "Abc123456",
}

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 CoworkerInvoiceLine

Updates an existing coworkerinvoiceline. 
PUT https://spaces.nexudus.com/api/billing/coworkerinvoicelines

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

🔒 Requires role "CoworkerInvoiceLine-Edit"

Body parameters
Id: number required
The unique Id of the coworkerinvoiceline to update.
CoworkerInvoiceId: number cleared if missing
Description: string cleared if missing
TaxCategoryName: string cleared if missing
Quantity: int cleared if missing
SubTotal: decimal cleared if missing
TaxAmount: decimal cleared if missing
TaxRate: decimal cleared if missing
FinancialAccountCode: string cleared if missing
FinancialAccountName: string cleared if missing

Example request

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


{
    "Id": 12345678,
    "CoworkerInvoiceId": 12345678,
    "Description": "BillToName",
    "TaxCategoryName": "Joe",
    "Quantity": ,
    "SubTotal": 1.2,
    "TaxAmount": 1.2,
    "TaxRate": 1.2,
    "FinancialAccountCode": "Abc123456",
    "FinancialAccountName": "Abc123456",
}

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 coworkerinvoiceline 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 coworkerinvoiceline records. 
GET https://spaces.nexudus.com/api/billing/coworkerinvoicelines/commands

Example request

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

Example request

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