CoworkerInvoices
Update CoworkerInvoice
Update an existing CoworkerInvoice record.
PUT
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
eStorecoveInvoiceStatus — StorecoveInvoiceStatus values
| Value | Name |
|---|---|
| 1 | None |
| 2 | TransferFailed |
| 3 | Processing |
| 4 | ProcessingFailed |
| 5 | Processed |
Request Body
Required Fields
The Id of the CoworkerInvoice record to update.
Coworker Id.
Business Id.
Unique invoice number assigned when the invoice is finalised.
Name of the person or company being billed.
Billing address on the invoice.
Billing city on the invoice.
Billing post code on the invoice.
Bill To Country Id.
Currency Id.
Optional Fields
Reference code used to match payments to this invoice.
Billing phone number on the invoice.
Billing fax number on the invoice.
Billing state or region on the invoice.
Bank account number on the invoice for payment.
Tax identification number of the billed party.
Customer purchase order number for this invoice.
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.
Transaction Total Amount.
Transaction Currency Id.
Transaction Exchange Rate.
Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
Date the invoice was marked as fully paid.
Status of e-invoicing transfer via Storecove. See
eStorecoveInvoiceStatus enum above.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.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the coworkerinvoice was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response