Update CoworkerInvoice

PUT

api

billing

coworkerinvoices

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "InvoiceNumber": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToPostCode": "<string>",
  "BillToCountryId": 123,
  "CurrencyId": 123,
  "StorecoveInvoiceStatus": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices"

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "InvoiceNumber": "<string>",
    "BillToName": "<string>",
    "BillToAddress": "<string>",
    "BillToCity": "<string>",
    "BillToPostCode": "<string>",
    "BillToCountryId": 123,
    "CurrencyId": 123,
    "StorecoveInvoiceStatus": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CoworkerId: 123,
    BusinessId: 123,
    InvoiceNumber: '<string>',
    BillToName: '<string>',
    BillToAddress: '<string>',
    BillToCity: '<string>',
    BillToPostCode: '<string>',
    BillToCountryId: 123,
    CurrencyId: 123,
    StorecoveInvoiceStatus: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing CoworkerInvoice record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerInvoice-Edit role.

Enums

eStorecoveInvoiceStatus — StorecoveInvoiceStatus values

Value	Name
1	None
2	TransferFailed
3	Processing
4	ProcessingFailed
5	Processed

Request Body

Required Fields

integer

required

The Id of the CoworkerInvoice record to update.

integer

required

ID of the coworker linked to this record.

integer

required

ID of the business linked to this record.

string

required

Unique invoice number assigned when the invoice is finalised.

string

required

Name of the person or company being billed.

string

required

Billing address on the invoice.

string

required

Billing city on the invoice.

string

required

Billing post code on the invoice.

integer

required

ID of the bill to country linked to this record.

integer

required

ID of the currency linked to this record.

integer

required

Status of e-invoicing transfer via Storecove.

Optional Fields

string

Reference code used to match payments to this invoice.

string

Billing phone number on the invoice.

string

Billing fax number on the invoice.

string

Billing state or region on the invoice.

string

Bank account number on the invoice for payment.

string

Tax identification number of the billed party.

string

Customer purchase order number for this invoice.

string

Date by which payment is due.

string

Start date of the billing period covered by this invoice.

string

End date of the billing period covered by this invoice.

number

The transaction total amount value for this coworker invoice.

integer

ID of the transaction currency linked to this record.

number

The transaction exchange rate value for this coworker invoice.

boolean

Whether the invoice is still a draft. Draft invoices can be modified before finalisation.

string

Date the invoice was marked as fully paid.

boolean

Whether billed is enabled.

boolean

Whether to skip automatic application of available credit to this invoice.

string

Date/time value for created on local.

string

Date/time value for due date local.

string

Date/time value for invoice from date local.

string

Date/time value for invoice to date local.

string

Date/time value for paid on local.

string

Date/time value for refunded on local.

string

Date/time value for last payment attempt local.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/coworkerinvoices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "InvoiceNumber": "",
    "BillToName": "",
    "BillToAddress": "",
    "BillToCity": "",
    "BillToPostCode": "",
    "BillToCountryId": 0,
    "CurrencyId": 0,
    "StorecoveInvoiceStatus": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoices',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      InvoiceNumber: '',
      BillToName: '',
      BillToAddress: '',
      BillToCity: '',
      BillToPostCode: '',
      BillToCountryId: 0,
      CurrencyId: 0,
      StorecoveInvoiceStatus: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'InvoiceNumber': '',
        'BillToName': '',
        'BillToAddress': '',
        'BillToCity': '',
        'BillToPostCode': '',
        'BillToCountryId': 0,
        'CurrencyId': 0,
        'StorecoveInvoiceStatus': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the coworkerinvoice was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerInvoice was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "InvoiceNumber: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "InvoiceNumber"
    }
  ],
  "WasSuccessful": false
}

Search CoworkerLedgerEntriesSearch and list CoworkerLedgerEntry records with filtering, sorting, and pagination.

Update CoworkerInvoice

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "InvoiceNumber": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToPostCode": "<string>",
  "BillToCountryId": 123,
  "CurrencyId": 123,
  "StorecoveInvoiceStatus": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices"

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "InvoiceNumber": "<string>",
    "BillToName": "<string>",
    "BillToAddress": "<string>",
    "BillToCity": "<string>",
    "BillToPostCode": "<string>",
    "BillToCountryId": 123,
    "CurrencyId": 123,
    "StorecoveInvoiceStatus": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CoworkerId: 123,
    BusinessId: 123,
    InvoiceNumber: '<string>',
    BillToName: '<string>',
    BillToAddress: '<string>',
    BillToCity: '<string>',
    BillToPostCode: '<string>',
    BillToCountryId: 123,
    CurrencyId: 123,
    StorecoveInvoiceStatus: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400