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 customer billed by this invoice..

integer

required

ID of the location that owns and issues this invoice..

string

required

Unique invoice number, assigned when the invoice is issued..

string

required

Name of the person or organisation billed, captured on the invoice..

string

required

Billing street address captured on the invoice..

string

required

Billing city captured on the invoice..

string

required

Billing postal or ZIP code captured on the invoice..

integer

required

ID of the country in the billing address..

integer

required

ID of the currency used to state invoice amounts..

integer

required

Read-only Storecove transfer state: None, TransferFailed, Processing, ProcessingFailed, or Processed..

Optional Fields

string

Payment reference used for reconciliation; normally follows the invoice number..

string

Optional billing phone number captured on the invoice..

string

Optional billing fax number captured on the invoice..

string

Optional billing state, province, or region captured on the invoice..

string

Optional bank-account details printed for payment instructions..

string

Optional tax identification number of the billed party..

string

Optional customer purchase-order reference..

string

Optional payment due date in the location’s timezone. When an invoice is created, the system calculates it using the customer’s due day or InvoiceDueDatePeriod first, then a due-date term configured for a plan on the invoice’s contract lines, the contract-period-start setting, and finally the location default; customer and plan periods are capped at 365 days. If several plan due-date terms apply, it uses the earliest next due date..

number

Stored total to collect in the payment transaction currency, set to TotalAmount multiplied by Payments.ExchangeRate and rounded to two decimals; the outstanding balance proportionally subtracts net ledger credits..

integer

ID of the currency used to collect payment; defaults to the location’s invoice currency unless Payments.Currency specifies a transaction currency..

number

Fixed multiplier from invoice currency to transaction currency, copied from the location’s Payments.ExchangeRate setting when invoice totals are updated..

boolean

Whether this invoice remains a draft rather than a final issued invoice..

string

Date and time recorded as paid; it updates payment ledger dates..

boolean

Internal billing-processing flag..

boolean

Whether credit resulting from crediting a paid invoice must not be automatically applied to future invoices; the operator can allocate the credit manually..

string

Location-timezone mirror of the system CreatedOn timestamp..

string

Location-timezone mirror of DueDate; use DueDate instead..

string

Location-timezone mirror of InvoiceFromDate; use InvoiceFromDate instead..

string

Location-timezone mirror of InvoiceToDate; use InvoiceToDate instead..

string

Location-timezone mirror of PaidOn; use PaidOn instead..

string

Location-timezone mirror of RefundedOn; use RefundedOn instead..

string

Location-timezone mirror of LastPaymentAttempt..

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
}

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