Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Account

OData end point to get a list of all accounts (contacts) accessible by the user

get/api/account

Response

OK

websitestring
namestring

Account (company) name

currencyCodestring

This defines the currency for this account. Must be in ISO 4217 format. Invoices created for this account will use this currency. If null, defaults will be set.

numberinteger

Account number, must be unique.

assignedToGuidsstring[] required

Used to set the reference in POST and PUTFor compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects.

tagNamesstring[]

For compatibility reasons, this will return an array of tag names instead of a list of tag objects.

createdDatestring date-time
lastModifiedDatestring date-time
paidnumber double

Total amount paid. Total amount paid.

trustBalancenumber double

Trust account balance. Trust account balance.

operatingBalancenumber double

Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue

billablenumber double

Total billable time entries, expenses and flat rates. Total billable time entries, expenses and flat rates.

status'Active' | 'Archived'
saleDocumentTemplateGuidstring uuid

Used to set the reference in POST and PUT

saleDocumentTemplateNamestring
contactInvoiceRecipientsGuidsstring[]

Used to set the reference in POST and PUT

is1099Eligibleboolean
taxIdstring
surchargesEnabledboolean
nameAndNumberstring
guidstring uuid
utbmsIsEnabledboolean
idinteger

Example response

[
  {
    "contacts": [
      {
        "customFieldValues": [
          {
            "customFieldGuid": "00000000-0000-0000-0000-000000000000",
            "valueContact": {
              "guid": "00000000-0000-0000-0000-000000000000"
            }
          }
        ],
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "assignedTo": [
      {
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "assignedToGuids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "primaryContact": {
      "customFieldValues": [
        {
          "customFieldGuid": "00000000-0000-0000-0000-000000000000",
          "valueContact": {
            "guid": "00000000-0000-0000-0000-000000000000"
          }
        }
      ],
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "saleDocumentTemplateGuid": "00000000-0000-0000-0000-000000000000",
    "contactInvoiceRecipients": [
      {
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "contactInvoiceRecipientsGuids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "guid": "00000000-0000-0000-0000-000000000000"
  }
]