Required roles
- CoworkerInvoice-*
Learn more about Invoices in our Knowledge Base.
Properties
| Property | Type | Required | Information |
|---|---|---|---|
| CoworkerId | int | Yes | |
| CoworkerFullName | string | No | Read-only |
| CoworkerRegularPaymentContractNumber | string | No | Read-only |
| CoworkerRegularPaymentProvider | string | No | Read-only |
| CoworkerCardNumber | string | No | Read-only |
| CoworkerGoCardlessContractNumber | string | No | Read-only |
| CoworkerEnableGoCardlessPayments | string | No | Read-only |
| CoworkerBillingEmail | string | No | Read-only |
| CoworkerNotifyOnNewInvoice | string | No | Read-only |
| CoworkerNotifyOnNewPayment | string | No | Read-only |
| CoworkerNotifyOnFailedPayment | string | No | Read-only |
| CoworkerDoNotProcessInvoicesAutomatically | string | No | Read-only |
| CoworkerCompanyName | string | No | Read-only |
| CoworkerTeamNames | string | No | Read-only |
| BusinessId | int | Yes | |
| BusinessName | string | No | Read-only |
| InvoiceNumber | string | Yes | |
| PaymentReference | string | No | |
| BillToName | string | Yes | |
| BillToAddress | string | Yes | |
| BillToCity | string | Yes | |
| BillToPostCode | string | Yes | |
| BillToPhone | string | No | |
| BillToFax | string | No | |
| BillToState | string | No | |
| BillToCountryId | int | Yes | |
| BillToCountryName | string | No | Read-only |
| BillToCountryTwoDigitsCode | string | No | Read-only |
| BillToBankAccount | string | No | |
| BillToTaxIDNumber | string | No | |
| PurchaseOrder | string | No | |
| Description | string | No | |
| DiscountAmount | float | No | |
| DueDate | timestamp | No | |
| InvoiceFromDate | timestamp | No | |
| InvoiceToDate | timestamp | No | |
| TotalAmount | float | No | |
| PaidAmount | float | No | |
| CurrencyId | int | Yes | |
| CurrencyCode | string | No | Read-only |
| TaxAmount | float | No | |
| Draft | boolean | No | |
| Void | boolean | No | |
| WaitingForInvoiceNumber | boolean | No | |
| Paid | boolean | No | |
| Sent | boolean | No | |
| SentOn | timestamp | No | |
| PaidOn | timestamp | No | |
| Refunded | boolean | No | |
| XeroInvoiceTransfered | boolean | No | |
| XeroPaymentTransfered | boolean | No | |
| QuickbooksInvoiceTransfered | boolean | No | |
| QuickbooksPaymentTransfered | boolean | No | |
| MoloniInvoiceTransferred | boolean | No | |
| MoloniPaymentTransferred | boolean | No | |
| RefundedOn | timestamp | No | |
| CreditNote | boolean | No | |
| OriginalInvoiceGuid | string | No | |
| ContractGuid | string | No | |
| CustomData | string | No | |
| GoCardlessReference | string | No | |
| DoNotApplyCreditAutomatically | boolean | No | |
| ReceivedAmount | float | No | |
| CreditedAmount | float | No | |
| RefundedAmount | float | No | |
| NexKioskTransactionId | string | No | |
| AutoTransferToXeroOrQuickBooks | boolean | No | |
| Id | int | Yes | Read-only |
| UpdatedOn | timestamp | No | Read-only |
| CreatedOn | timestamp | No | Read-only |
| UniqueId | string | No | Read-only |
| SystemId | string | No |