CoworkerInvoices
Get one CoworkerInvoice
Retrieve a single CoworkerInvoice record by its Id.
GET
Get one CoworkerInvoice
A CoworkerInvoice represents an invoice document issued to a customer. Invoices track amounts owed, payment status, billing details, and integration state with external accounting systems.
Invoices can be in draft or final state. A draft invoice (“Draft
true) can still be modified before being finalised. Once finalised, an invoice number is assigned and the invoice can be sent to the customer.
An invoice may also be a credit note (CreditNote` true`), which references the original invoice via OriginalInvoiceGuid“ and represents a reversal or adjustment.
Payment status is tracked via Paid, PaidAmount, and PaidOn. Partial payments are possible — compare PaidAmount against TotalAmount to determine outstanding balance. Refunds are tracked separately via Refunded, RefundedOn, and RefundedAmount.
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
integer
required
The Id of the CoworkerInvoice record to retrieve.
Code Examples
Response
200
integer
ID of the coworker linked to this record.
string
Full name of the invoiced customer.
string
The coworker regular payment contract number value for this coworker invoice.
string
The coworker regular payment provider value for this coworker invoice.
string
The coworker card number value for this coworker invoice.
string
The coworker go cardless contract number value for this coworker invoice.
boolean
Whether coworker enable go cardless payments is enabled.
string
Billing email address of the customer.
boolean
Whether coworker notify on new invoice is enabled.
boolean
Whether coworker notify on new payment is enabled.
boolean
Whether coworker notify on failed payment is enabled.
boolean
Whether coworker do not process invoices automatically is enabled.
string
Company name of the invoiced customer.
string
Team names the invoiced customer belongs to.
integer
ID of the business linked to this record.
string
Name of the location that issued the invoice.
string
Unique invoice number assigned when the invoice is finalised.
string
Reference code used to match payments to this invoice.
string
Name of the person or company being billed.
string
Billing address on the invoice.
string
Billing city on the invoice.
string
Billing post code on the invoice.
string
Billing phone number on the invoice.
string
Billing fax number on the invoice.
string
Billing state or region on the invoice.
integer
ID of the bill to country linked to this record.
string
Name of the billing country on the invoice.
string
The bill to country two digits code value for this coworker 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
Free-text description or notes for the invoice.
number
Discount amount applied to the invoice total.
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
Total invoice amount including tax.
number
Total amount paid against this invoice so far.
number
The transaction total amount value for this coworker invoice.
integer
ID of the transaction currency linked to this record.
string
The transaction currency code value for this coworker invoice.
number
The transaction exchange rate value for this coworker invoice.
integer
ID of the currency linked to this record.
string
ISO currency code (e.g. USD, EUR, GBP).
number
Total tax amount on the invoice.
boolean
Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
boolean
Whether the invoice has been voided (cancelled without a credit note).
boolean
Whether the invoice is queued for invoice number assignment.
boolean
Whether the invoice has been fully paid.
boolean
Whether the invoice has been emailed to the customer.
string
Date the invoice was emailed to the customer.
string
Date the invoice was marked as fully paid.
boolean
Whether a refund has been issued for this invoice.
boolean
Whether the invoice has been transferred to Xero.
boolean
Whether the payment has been transferred to Xero.
boolean
Whether the invoice has been transferred to QuickBooks.
boolean
Whether the payment has been transferred to QuickBooks.
boolean
Whether the invoice has been transferred to Moloni.
boolean
Whether the payment has been transferred to Moloni.
integer
Status of e-invoicing transfer via Storecove. See
eStorecoveInvoiceStatus enum values: 1 = None, 2 = TransferFailed, 3 = Processing, 4 = ProcessingFailed, 5 = Processed.boolean
Whether the invoice is automatically sent to Storecove for e-invoicing.
string
ID of the storecove unique associated with this record.
string
Date the refund was issued.
boolean
Whether this document is a credit note rather than an invoice.
string
GUID of the original invoice this credit note reverses.
string
GUID of the contract that generated this invoice.
string
Arbitrary custom data stored with the invoice.
string
GoCardless payment reference for direct debit collection.
string
The spreedly token value for this coworker invoice.
string
Date/time value for last payment attempt.
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.
number
Total amount received via direct payments.
number
Amount paid via credit notes or account credit.
number
Total amount refunded on this invoice.
string
Transaction ID from NexKiosk point-of-sale payment.
boolean
Whether the invoice is automatically transferred to Xero or QuickBooks.
integer
Unique record identifier.
string
UUID of the record.
string
Date and time the record was created (ISO 8601).
string
Date and time the record was last updated (ISO 8601).
string
Email of the user who last updated this record.
boolean
Whether the record was recently created.
string
External system identifier.
Example Response
Get one CoworkerInvoice