CoworkerInvoices
Get one CoworkerInvoice
Retrieve a single CoworkerInvoice record by its Id.
GET
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
The Id of the CoworkerInvoice record to retrieve.
Code Examples
Response
200
Coworker Id.
Full name of the invoiced customer.
Coworker Regular Payment Contract Number.
Coworker Regular Payment Provider.
Coworker Card Number.
Coworker Go Cardless Contract Number.
Coworker Enable Go Cardless Payments.
Billing email address of the customer.
Coworker Notify On New Invoice.
Coworker Notify On New Payment.
Coworker Notify On Failed Payment.
Coworker Do Not Process Invoices Automatically.
Company name of the invoiced customer.
Team names the invoiced customer belongs to.
Business Id.
Name of the location that issued the invoice.
Unique invoice number assigned when the invoice is finalised.
Reference code used to match payments to this invoice.
Name of the person or company being billed.
Billing address on the invoice.
Billing city on the invoice.
Billing post code on the invoice.
Billing phone number on the invoice.
Billing fax number on the invoice.
Billing state or region on the invoice.
Bill To Country Id.
Name of the billing country on the invoice.
Bill To Country Two Digits Code.
Bank account number on the invoice for payment.
Tax identification number of the billed party.
Customer purchase order number for this invoice.
Free-text description or notes for the invoice.
Discount amount applied to the invoice total.
Date by which payment is due.
Start date of the billing period covered by this invoice.
End date of the billing period covered by this invoice.
Total invoice amount including tax.
Total amount paid against this invoice so far.
Transaction Total Amount.
Transaction Currency Id.
Transaction Currency Code.
Transaction Exchange Rate.
Currency Id.
ISO currency code (e.g. USD, EUR, GBP).
Total tax amount on the invoice.
Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
Whether the invoice has been voided (cancelled without a credit note).
Whether the invoice is queued for invoice number assignment.
Whether the invoice has been fully paid.
Whether the invoice has been emailed to the customer.
Date the invoice was emailed to the customer.
Date the invoice was marked as fully paid.
Whether a refund has been issued for this invoice.
Whether the invoice has been transferred to Xero.
Whether the payment has been transferred to Xero.
Whether the invoice has been transferred to QuickBooks.
Whether the payment has been transferred to QuickBooks.
Whether the invoice has been transferred to Moloni.
Whether the payment has been transferred to Moloni.
Status of e-invoicing transfer via Storecove. See
eStorecoveInvoiceStatus enum values: 1 = None, 2 = TransferFailed, 3 = Processing, 4 = ProcessingFailed, 5 = Processed.Whether the invoice is automatically sent to Storecove for e-invoicing.
Storecove Unique Id.
Date the refund was issued.
Whether this document is a credit note rather than an invoice.
GUID of the original invoice this credit note reverses.
GUID of the contract that generated this invoice.
Arbitrary custom data stored with the invoice.
GoCardless payment reference for direct debit collection.
Spreedly Token.
Last Payment Attempt.
Billed.
Whether to skip automatic application of available credit to this invoice.
Created On Local.
Due Date Local.
Invoice From Date Local.
Invoice To Date Local.
Paid On Local.
Refunded On Local.
Last Payment Attempt Local.
Total amount received via direct payments.
Amount paid via credit notes or account credit.
Total amount refunded on this invoice.
Transaction ID from NexKiosk point-of-sale payment.
Whether the invoice is automatically transferred to Xero or QuickBooks.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response