CoworkerInvoices
Get one CoworkerInvoice
Retrieve a single CoworkerInvoice record by its Id.
GET
Get one CoworkerInvoice
A CoworkerInvoice is the bill a location issues to one of its customers (member, contact or team) for plans, bookings, products, passes and other charges, including totals, payment status, credits and invoice delivery. THIS IS THE DEFAULT INVOICE ENTITY: when an operator says ‘invoice’, ‘invoices’, ‘unpaid invoices’, ‘overdue invoices’, ‘invoice 1042’, ‘send the invoice’ or ‘credit note’, they mean a CoworkerInvoice — use the coworker_invoice_* tools and do not ask which kind of invoice they meant. The separate Invoice entity (invoice_* tools) is the platform bill Nexudus issues to the operator and is almost never what an operator is asking about. Call this record an ‘invoice’ when speaking to the operator; never say ‘CoworkerInvoice’.
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-Read role.Path Parameters
Code Examples
Response
200
Read-only stored invoice-level discount amount in the invoice currency; UpdateTotals does not recalculate it because line SubTotal values already include line discounts..
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..
Read-only start of the contract billing period, calculated from the InvoicedPeriod of the contract being invoiced..
Read-only end of the contract billing period, calculated from the billing period of the contract’s associated plan..
Read-only gross invoice total: sum of every line’s SubTotal plus TaxAmount after each line is rounded, then rounded to the location’s invoice decimal precision..
Read-only database total of all CoworkerLedgerEntry Credit values linked to this invoice; negative credit entries reduce the amount..
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..
ID of the currency used to collect payment; defaults to the location’s invoice currency unless Payments.Currency specifies a transaction currency..
Fixed multiplier from invoice currency to transaction currency, copied from the location’s Payments.ExchangeRate setting when invoice totals are updated..
Read-only tax total: sum of every rounded invoice-line TaxAmount, then rounded to the location’s invoice decimal precision..
Whether this invoice has been voided or cancelled; voiding deletes all CoworkerLedgerEntry records associated with the invoice..
Read-only Storecove transfer state: None, TransferFailed, Processing, ProcessingFailed, or Processed.. See
eStorecoveInvoiceStatus enum values: 1 = None, 2 = TransferFailed, 3 = Processing, 4 = ProcessingFailed, 5 = Processed.Whether credit resulting from crediting a paid invoice must not be automatically applied to future invoices; the operator can allocate the credit manually..
Read-only database-maintained reporting amount for payments received; it is not calculated by invoice UpdateTotals..
Read-only database-maintained reporting amount for credit applied or issued; it is not calculated by invoice UpdateTotals..
Read-only database-maintained reporting amount for refunds; it is not calculated by invoice UpdateTotals..
Example Response