The coworkerinvoice object
| Attributes |
|
Id: int required, autogenerated, unique
The unique identifier for this coworkerinvoice |
| BillToAddress: string required |
| BillToBankAccount: string optional |
| BillToCity: string required |
| BillToCountryId: Id required |
| BillToFax: string optional |
| BillToName: string required |
| BillToPhone: string optional |
| BillToPostCode: string required |
| BillToTaxIDNumber: string optional |
| BusinessId: Id required |
| ContractGuid: Guid? optional read-only |
| CoworkerId: Id required |
| CreditedAmount: decimal? optional read-only |
| CreditNote: bool optional read-only |
| CurrencyId: Id required |
| CustomData: string optional |
| Description: string optional read-only |
| DiscountAmount: decimal required read-only |
| Draft: bool optional |
| DueDate: DateTime? optional |
| InvoiceFromDate: DateTime? optional |
| InvoiceNumber: string required |
| InvoiceToDate: DateTime? optional |
| MoloniInvoiceTransferred: bool optional read-only |
| MoloniPaymentTransferred: bool optional read-only |
| OriginalInvoiceGuid: Guid? optional read-only |
| Paid: bool optional read-only |
| PaidAmount: decimal? optional read-only |
| PaidOn: DateTime? optional |
| PaymentReference: string optional |
| PurchaseOrder: string optional |
| ReceivedAmount: decimal? optional read-only |
| Refunded: bool optional read-only |
| RefundedAmount: decimal? optional read-only |
| RefundedOn: DateTime? optional read-only |
| Sent: bool optional read-only |
| SentOn: DateTime? optional read-only |
| TaxAmount: decimal required read-only |
| TotalAmount: decimal required read-only |
| UniqueSquareIdentifier: Guid? optional read-only |
| XeroInvoiceTransfered: bool optional read-only |
| XeroPaymentTransfered: bool optional read-only |
|
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerinvoice |
|
SystemId: string optional api-only
User defined data about this coworkerinvoice. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BillToAddress": "BillToAddress",
"BillToBankAccount": "123456",
"BillToCity": "BillToCity",
"BillToCountryId": 12345678,
"BillToFax": "BillToFax",
"BillToName": "BillToName",
"BillToPhone": "BillToPhone",
"BillToPostCode": "BillToPostCode",
"BillToTaxIDNumber": "123456",
"BusinessId": 12345678,
"ContractGuid": ,
"CoworkerId": 12345678,
"CreditedAmount": ,
"CreditNote": false,
"CurrencyId": 12345678,
"CustomData": "null",
"Description": "[DataType(DataType.MultilineText)]",
"DiscountAmount": 1.2,
"Draft": false,
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceNumber": "00001",
"InvoiceToDate": ,
"MoloniInvoiceTransferred": false,
"MoloniPaymentTransferred": false,
"OriginalInvoiceGuid": ,
"Paid": false,
"PaidAmount": ,
"PaidOn": ,
"PaymentReference": "00001",
"PurchaseOrder": "PurchaseOrder",
"ReceivedAmount": ,
"Refunded": false,
"RefundedAmount": ,
"RefundedOn": ,
"Sent": false,
"SentOn": ,
"TaxAmount": 1.2,
"TotalAmount": 1.2,
"UniqueSquareIdentifier": ,
"XeroInvoiceTransfered": false,
"XeroPaymentTransfered": false,
"UniqueId": "8ad00a2c-a87a-4c1f-89da-40864fb12adc",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a CoworkerInvoice
This endpoint allows you to GET a list of coworkerinvoices based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/billing/coworkerinvoices?...
🔒 Requires role "CoworkerInvoice-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=InvoiceNumber
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 coworkerinvoice records based on their different properties. |
|
Id number
?Id=12345678 |
|
CoworkerInvoice_BillToAddress string
?CoworkerInvoice_BillToAddress=... |
|
CoworkerInvoice_BillToBankAccount string
?CoworkerInvoice_BillToBankAccount=... |
|
CoworkerInvoice_BillToCity string
?CoworkerInvoice_BillToCity=... |
|
CoworkerInvoice_BillToCountry Country
?CoworkerInvoice_BillToCountry=... |
|
CoworkerInvoice_BillToFax string
?CoworkerInvoice_BillToFax=... |
|
CoworkerInvoice_BillToName string
?CoworkerInvoice_BillToName=... |
|
CoworkerInvoice_BillToPhone string
?CoworkerInvoice_BillToPhone=... |
|
CoworkerInvoice_BillToPostCode string
?CoworkerInvoice_BillToPostCode=... |
|
CoworkerInvoice_BillToTaxIDNumber string
?CoworkerInvoice_BillToTaxIDNumber=... |
|
CoworkerInvoice_Business Business
?CoworkerInvoice_Business=... |
|
CoworkerInvoice_ContractGuid Guid?
?CoworkerInvoice_ContractGuid=... |
|
CoworkerInvoice_Coworker Coworker
?CoworkerInvoice_Coworker=... |
|
CoworkerInvoice_CreditedAmount decimal?
?CoworkerInvoice_CreditedAmount=... |
|
CoworkerInvoice_CreditNote bool
?CoworkerInvoice_CreditNote=... |
|
CoworkerInvoice_Currency Currency
?CoworkerInvoice_Currency=... |
|
CoworkerInvoice_CustomData string
?CoworkerInvoice_CustomData=... |
|
CoworkerInvoice_Description string
?CoworkerInvoice_Description=... |
|
CoworkerInvoice_DiscountAmount decimal
?CoworkerInvoice_DiscountAmount=... |
|
CoworkerInvoice_Draft bool
?CoworkerInvoice_Draft=... |
|
CoworkerInvoice_DueDate DateTime?
?CoworkerInvoice_DueDate=... |
|
CoworkerInvoice_InvoiceFromDate DateTime?
?CoworkerInvoice_InvoiceFromDate=... |
|
CoworkerInvoice_InvoiceNumber string
?CoworkerInvoice_InvoiceNumber=... |
|
CoworkerInvoice_InvoiceToDate DateTime?
?CoworkerInvoice_InvoiceToDate=... |
|
CoworkerInvoice_MoloniInvoiceTransferred bool
?CoworkerInvoice_MoloniInvoiceTransferred=... |
|
CoworkerInvoice_MoloniPaymentTransferred bool
?CoworkerInvoice_MoloniPaymentTransferred=... |
|
CoworkerInvoice_OriginalInvoiceGuid Guid?
?CoworkerInvoice_OriginalInvoiceGuid=... |
|
CoworkerInvoice_Paid bool
?CoworkerInvoice_Paid=... |
|
CoworkerInvoice_PaidAmount decimal?
?CoworkerInvoice_PaidAmount=... |
|
CoworkerInvoice_PaidOn DateTime?
?CoworkerInvoice_PaidOn=... |
|
CoworkerInvoice_PaymentReference string
?CoworkerInvoice_PaymentReference=... |
|
CoworkerInvoice_PurchaseOrder string
?CoworkerInvoice_PurchaseOrder=... |
|
CoworkerInvoice_ReceivedAmount decimal?
?CoworkerInvoice_ReceivedAmount=... |
|
CoworkerInvoice_Refunded bool
?CoworkerInvoice_Refunded=... |
|
CoworkerInvoice_RefundedAmount decimal?
?CoworkerInvoice_RefundedAmount=... |
|
CoworkerInvoice_RefundedOn DateTime?
?CoworkerInvoice_RefundedOn=... |
|
CoworkerInvoice_Sent bool
?CoworkerInvoice_Sent=... |
|
CoworkerInvoice_SentOn DateTime?
?CoworkerInvoice_SentOn=... |
|
CoworkerInvoice_TaxAmount decimal
?CoworkerInvoice_TaxAmount=... |
|
CoworkerInvoice_TotalAmount decimal
?CoworkerInvoice_TotalAmount=... |
|
CoworkerInvoice_UniqueSquareIdentifier Guid?
?CoworkerInvoice_UniqueSquareIdentifier=... |
|
CoworkerInvoice_XeroInvoiceTransfered bool
?CoworkerInvoice_XeroInvoiceTransfered=... |
|
CoworkerInvoice_XeroPaymentTransfered bool
?CoworkerInvoice_XeroPaymentTransfered=... |
|
CoworkerInvoice_CoworkerFullName string
?CoworkerInvoice_CoworkerFullName=... |
|
CoworkerInvoice_CoworkerRegularPaymentContractNumber string
?CoworkerInvoice_CoworkerRegularPaymentContractNumber=... |
|
CoworkerInvoice_CoworkerRegularPaymentProvider string
?CoworkerInvoice_CoworkerRegularPaymentProvider=... |
|
CoworkerInvoice_CoworkerCardNumber string
?CoworkerInvoice_CoworkerCardNumber=... |
|
CoworkerInvoice_CoworkerGoCardlessContractNumber string
?CoworkerInvoice_CoworkerGoCardlessContractNumber=... |
|
CoworkerInvoice_CoworkerEnableGoCardlessPayments string
?CoworkerInvoice_CoworkerEnableGoCardlessPayments=... |
|
CoworkerInvoice_CoworkerBillingEmail string
?CoworkerInvoice_CoworkerBillingEmail=... |
|
CoworkerInvoice_CoworkerNotifyOnNewInvoice string
?CoworkerInvoice_CoworkerNotifyOnNewInvoice=... |
|
CoworkerInvoice_CoworkerNotifyOnNewPayment string
?CoworkerInvoice_CoworkerNotifyOnNewPayment=... |
|
CoworkerInvoice_CoworkerNotifyOnFailedPayment string
?CoworkerInvoice_CoworkerNotifyOnFailedPayment=... |
|
CoworkerInvoice_CoworkerDoNotProcessInvoicesAutomatically string
?CoworkerInvoice_CoworkerDoNotProcessInvoicesAutomatically=... |
|
CoworkerInvoice_BusinessName string
?CoworkerInvoice_BusinessName=... |
|
CoworkerInvoice_BillToCountryName string
?CoworkerInvoice_BillToCountryName=... |
|
CoworkerInvoice_BillToCountryTwoDigitsCode string
?CoworkerInvoice_BillToCountryTwoDigitsCode=... |
|
CoworkerInvoice_TransactionCurrencyCode string
?CoworkerInvoice_TransactionCurrencyCode=... |
|
CoworkerInvoice_CurrencyCode string
?CoworkerInvoice_CurrencyCode=... |
|
Range search querystring parameters
Lets you search coworkerinvoice records based on a range of date or numeric values. |
|
To_CoworkerInvoice_CreatedOn date
?To_CoworkerInvoice_CreatedOn=2010-01-01T20:32 |
|
From_CoworkerInvoice_CreatedOn date
?From_CoworkerInvoice_CreatedOn=2010-01-01T20:32 |
|
To_CoworkerInvoice_UpdatedOn date
?To_CoworkerInvoice_UpdatedOn=2010-01-01T20:32 |
|
From_CoworkerInvoice_UpdatedOn date
?From_CoworkerInvoice_UpdatedOn=2010-01-01T20:32 |
|
To_CoworkerInvoice_DiscountAmount number
?To_CoworkerInvoice_DiscountAmount=0 |
|
From_CoworkerInvoice_DiscountAmount number
?From_CoworkerInvoice_DiscountAmount=10 |
|
To_CoworkerInvoice_DueDate date
?To_CoworkerInvoice_DueDate=2010-01-01T20:32 |
|
From_CoworkerInvoice_DueDate date
?From_CoworkerInvoice_DueDate=2010-01-01T20:32 |
|
To_CoworkerInvoice_InvoiceFromDate date
?To_CoworkerInvoice_InvoiceFromDate=2010-01-01T20:32 |
|
From_CoworkerInvoice_InvoiceFromDate date
?From_CoworkerInvoice_InvoiceFromDate=2010-01-01T20:32 |
|
To_CoworkerInvoice_InvoiceToDate date
?To_CoworkerInvoice_InvoiceToDate=2010-01-01T20:32 |
|
From_CoworkerInvoice_InvoiceToDate date
?From_CoworkerInvoice_InvoiceToDate=2010-01-01T20:32 |
|
To_CoworkerInvoice_TotalAmount number
?To_CoworkerInvoice_TotalAmount=0 |
|
From_CoworkerInvoice_TotalAmount number
?From_CoworkerInvoice_TotalAmount=10 |
|
To_CoworkerInvoice_PaidAmount number
?To_CoworkerInvoice_PaidAmount=0 |
|
From_CoworkerInvoice_PaidAmount number
?From_CoworkerInvoice_PaidAmount=10 |
|
To_CoworkerInvoice_TaxAmount number
?To_CoworkerInvoice_TaxAmount=0 |
|
From_CoworkerInvoice_TaxAmount number
?From_CoworkerInvoice_TaxAmount=10 |
|
To_CoworkerInvoice_SentOn date
?To_CoworkerInvoice_SentOn=2010-01-01T20:32 |
|
From_CoworkerInvoice_SentOn date
?From_CoworkerInvoice_SentOn=2010-01-01T20:32 |
|
To_CoworkerInvoice_PaidOn date
?To_CoworkerInvoice_PaidOn=2010-01-01T20:32 |
|
From_CoworkerInvoice_PaidOn date
?From_CoworkerInvoice_PaidOn=2010-01-01T20:32 |
|
To_CoworkerInvoice_RefundedOn date
?To_CoworkerInvoice_RefundedOn=2010-01-01T20:32 |
|
From_CoworkerInvoice_RefundedOn date
?From_CoworkerInvoice_RefundedOn=2010-01-01T20:32 |
|
To_CoworkerInvoice_ReceivedAmount number
?To_CoworkerInvoice_ReceivedAmount=0 |
|
From_CoworkerInvoice_ReceivedAmount number
?From_CoworkerInvoice_ReceivedAmount=10 |
|
To_CoworkerInvoice_CreditedAmount number
?To_CoworkerInvoice_CreditedAmount=0 |
|
From_CoworkerInvoice_CreditedAmount number
?From_CoworkerInvoice_CreditedAmount=10 |
|
To_CoworkerInvoice_RefundedAmount number
?To_CoworkerInvoice_RefundedAmount=0 |
|
From_CoworkerInvoice_RefundedAmount number
?From_CoworkerInvoice_RefundedAmount=10 |
Example request
GET https://spaces.nexudus.com/api/billing/coworkerinvoices?CoworkerInvoice_InvoiceNumber=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"InvoiceNumber": "00001",
"PaymentReference": "00001",
"BillToName": "BillToName",
"BillToAddress": "BillToAddress",
"BillToCity": "BillToCity",
"BillToPostCode": "BillToPostCode",
"BillToPhone": "BillToPhone",
"BillToFax": "BillToFax",
"BillToCountry": ,
"BillToBankAccount": "123456",
"BillToTaxIDNumber": "123456",
"PurchaseOrder": "PurchaseOrder",
"Description": "[DataType(DataType.MultilineText)]",
"DiscountAmount": 1.2,
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceToDate": ,
"TotalAmount": 1.2,
"PaidAmount": ,
"Currency": ,
"TaxAmount": 1.2,
"Draft": false,
"Paid": false,
"Sent": false,
"SentOn": ,
"PaidOn": ,
"Refunded": false,
"XeroInvoiceTransfered": false,
"XeroPaymentTransfered": false,
"MoloniInvoiceTransferred": false,
"MoloniPaymentTransferred": false,
"RefundedOn": ,
"CreditNote": false,
"OriginalInvoiceGuid": ,
"ContractGuid": ,
"CustomData": "null",
"ReceivedAmount": ,
"CreditedAmount": ,
"RefundedAmount": ,
"UniqueSquareIdentifier": ,
"CoworkerInvoiceCoworkerFullName": "...",
"CoworkerInvoiceCoworkerRegularPaymentContractNumber": "...",
"CoworkerInvoiceCoworkerRegularPaymentProvider": "...",
"CoworkerInvoiceCoworkerCardNumber": "...",
"CoworkerInvoiceCoworkerGoCardlessContractNumber": "...",
"CoworkerInvoiceCoworkerEnableGoCardlessPayments": "...",
"CoworkerInvoiceCoworkerBillingEmail": "...",
"CoworkerInvoiceCoworkerNotifyOnNewInvoice": "...",
"CoworkerInvoiceCoworkerNotifyOnNewPayment": "...",
"CoworkerInvoiceCoworkerNotifyOnFailedPayment": "...",
"CoworkerInvoiceCoworkerDoNotProcessInvoicesAutomatically": "...",
"CoworkerInvoiceBusinessName": "...",
"CoworkerInvoiceBillToCountryName": "...",
"CoworkerInvoiceBillToCountryTwoDigitsCode": "...",
"CoworkerInvoiceTransactionCurrencyCode": "...",
"CoworkerInvoiceCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "72a72919-8082-4953-be4b-067451b04a05",
"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 CoworkerInvoices by IDs
Gets one or more coworkerinvoice records based on their Id.GET https://spaces.nexudus.com/api/billing/coworkerinvoices?CoworkerInvoice_Id=[:id1,:id2,...]
🔒 Requires role "CoworkerInvoice-List"
| Querystring parameters |
|
CoworkerInvoice_Id: array requried
?CoworkerInvoice_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/billing/coworkerinvoices?CoworkerInvoice_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"InvoiceNumber": "00001",
"PaymentReference": "00001",
"BillToName": "BillToName",
"BillToAddress": "BillToAddress",
"BillToCity": "BillToCity",
"BillToPostCode": "BillToPostCode",
"BillToPhone": "BillToPhone",
"BillToFax": "BillToFax",
"BillToCountry": ,
"BillToBankAccount": "123456",
"BillToTaxIDNumber": "123456",
"PurchaseOrder": "PurchaseOrder",
"Description": "[DataType(DataType.MultilineText)]",
"DiscountAmount": 1.2,
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceToDate": ,
"TotalAmount": 1.2,
"PaidAmount": ,
"Currency": ,
"TaxAmount": 1.2,
"Draft": false,
"Paid": false,
"Sent": false,
"SentOn": ,
"PaidOn": ,
"Refunded": false,
"XeroInvoiceTransfered": false,
"XeroPaymentTransfered": false,
"MoloniInvoiceTransferred": false,
"MoloniPaymentTransferred": false,
"RefundedOn": ,
"CreditNote": false,
"OriginalInvoiceGuid": ,
"ContractGuid": ,
"CustomData": "null",
"ReceivedAmount": ,
"CreditedAmount": ,
"RefundedAmount": ,
"UniqueSquareIdentifier": ,
"CoworkerInvoiceCoworkerFullName": "...",
"CoworkerInvoiceCoworkerRegularPaymentContractNumber": "...",
"CoworkerInvoiceCoworkerRegularPaymentProvider": "...",
"CoworkerInvoiceCoworkerCardNumber": "...",
"CoworkerInvoiceCoworkerGoCardlessContractNumber": "...",
"CoworkerInvoiceCoworkerEnableGoCardlessPayments": "...",
"CoworkerInvoiceCoworkerBillingEmail": "...",
"CoworkerInvoiceCoworkerNotifyOnNewInvoice": "...",
"CoworkerInvoiceCoworkerNotifyOnNewPayment": "...",
"CoworkerInvoiceCoworkerNotifyOnFailedPayment": "...",
"CoworkerInvoiceCoworkerDoNotProcessInvoicesAutomatically": "...",
"CoworkerInvoiceBusinessName": "...",
"CoworkerInvoiceBillToCountryName": "...",
"CoworkerInvoiceBillToCountryTwoDigitsCode": "...",
"CoworkerInvoiceTransactionCurrencyCode": "...",
"CoworkerInvoiceCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "bf00f2de-18d1-46e1-80dd-45c10839b425",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "InvoiceNumber",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single CoworkerInvoice by Id
Gets one coworkerinvoice record by its Id.GET https://spaces.nexudus.com/api/billing/coworkerinvoices/:Id
🔒 Requires role "CoworkerInvoice-Read"
| URL parameters |
| Id: number requried |
Example request
GET https://spaces.nexudus.com/api/billing/coworkerinvoices/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BillToAddress": "BillToAddress",
"BillToBankAccount": "123456",
"BillToCity": "BillToCity",
"BillToCountryId": 12345678,
"BillToFax": "BillToFax",
"BillToName": "BillToName",
"BillToPhone": "BillToPhone",
"BillToPostCode": "BillToPostCode",
"BillToTaxIDNumber": "123456",
"BusinessId": 12345678,
"ContractGuid": ,
"CoworkerId": 12345678,
"CreditedAmount": ,
"CreditNote": false,
"CurrencyId": 12345678,
"CustomData": "null",
"Description": "[DataType(DataType.MultilineText)]",
"DiscountAmount": 1.2,
"Draft": false,
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceNumber": "00001",
"InvoiceToDate": ,
"MoloniInvoiceTransferred": false,
"MoloniPaymentTransferred": false,
"OriginalInvoiceGuid": ,
"Paid": false,
"PaidAmount": ,
"PaidOn": ,
"PaymentReference": "00001",
"PurchaseOrder": "PurchaseOrder",
"ReceivedAmount": ,
"Refunded": false,
"RefundedAmount": ,
"RefundedOn": ,
"Sent": false,
"SentOn": ,
"TaxAmount": 1.2,
"TotalAmount": 1.2,
"UniqueSquareIdentifier": ,
"XeroInvoiceTransfered": false,
"XeroPaymentTransfered": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "f49f99ce-4765-4477-8bed-31b61739c2b5",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new CoworkerInvoice
Creates a new coworkerinvoice.POST https://spaces.nexudus.com/api/billing/coworkerinvoices
🔒 Requires role "CoworkerInvoice-Create"
| Body parameters |
| CoworkerId: number required |
| BusinessId: number required |
| InvoiceNumber: string required |
| PaymentReference: string optional |
| BillToName: string required |
| BillToAddress: string required |
| BillToCity: string required |
| BillToPostCode: string required |
| BillToPhone: string optional |
| BillToFax: string optional |
| BillToCountryId: number required |
| BillToBankAccount: string optional |
| BillToTaxIDNumber: string optional |
| PurchaseOrder: string optional |
| DueDate: DateTime? optional |
| InvoiceFromDate: DateTime? optional |
| InvoiceToDate: DateTime? optional |
| CurrencyId: number required |
| Draft: bool optional |
| PaidOn: DateTime? optional |
| CustomData: string optional |
Example request
POST https://spaces.nexudus.com/api/billing/coworkerinvoices Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"CoworkerId": 12345678,
"BusinessId": 12345678,
"InvoiceNumber": "00001",
"PaymentReference": "00001",
"BillToName": "BillToName",
"BillToAddress": "BillToAddress",
"BillToCity": "BillToCity",
"BillToPostCode": "BillToPostCode",
"BillToPhone": "BillToPhone",
"BillToFax": "BillToFax",
"BillToCountryId": 12345678,
"BillToBankAccount": "123456",
"BillToTaxIDNumber": "123456",
"PurchaseOrder": "PurchaseOrder",
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceToDate": ,
"CurrencyId": 12345678,
"Draft": false,
"PaidOn": ,
"CustomData": "null",
}
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 CoworkerInvoice
Updates an existing coworkerinvoice.PUT https://spaces.nexudus.com/api/billing/coworkerinvoices
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
🔒 Requires role "CoworkerInvoice-Edit"
| Body parameters |
|
Id: number required
The unique Id of the coworkerinvoice to update. |
| CoworkerId: number cleared if missing |
| BusinessId: number cleared if missing |
| InvoiceNumber: string cleared if missing |
| PaymentReference: string cleared if missing |
| BillToName: string cleared if missing |
| BillToAddress: string cleared if missing |
| BillToCity: string cleared if missing |
| BillToPostCode: string cleared if missing |
| BillToPhone: string cleared if missing |
| BillToFax: string cleared if missing |
| BillToCountryId: number cleared if missing |
| BillToBankAccount: string cleared if missing |
| BillToTaxIDNumber: string cleared if missing |
| PurchaseOrder: string cleared if missing |
| DueDate: DateTime? cleared if missing |
| InvoiceFromDate: DateTime? cleared if missing |
| InvoiceToDate: DateTime? cleared if missing |
| CurrencyId: number cleared if missing |
| Draft: bool cleared if missing |
| PaidOn: DateTime? cleared if missing |
| CustomData: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/billing/coworkerinvoices Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"CoworkerId": 12345678,
"BusinessId": 12345678,
"InvoiceNumber": "00001",
"PaymentReference": "00001",
"BillToName": "BillToName",
"BillToAddress": "BillToAddress",
"BillToCity": "BillToCity",
"BillToPostCode": "BillToPostCode",
"BillToPhone": "BillToPhone",
"BillToFax": "BillToFax",
"BillToCountryId": 12345678,
"BillToBankAccount": "123456",
"BillToTaxIDNumber": "123456",
"PurchaseOrder": "PurchaseOrder",
"DueDate": ,
"InvoiceFromDate": ,
"InvoiceToDate": ,
"CurrencyId": 12345678,
"Draft": false,
"PaidOn": ,
"CustomData": "null",
}
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 coworkerinvoice 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 coworkerinvoice records.GET https://spaces.nexudus.com/api/billing/coworkerinvoices/commands
Example request
GET https://spaces.nexudus.com/api/billing/coworkerinvoices/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 coworkerinvoice record IDs.POST https://spaces.nexudus.com/api/billing/coworkerinvoices/runacommand🔒 Requires role "CoworkerInvoice-Edit"
Example request
POST https://spaces.nexudus.com/api/billing/coworkerinvoices/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
}
Comments
Please sign in to leave a comment.