Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Account

Created a new account (contact)

post/api/account

Request body

isContactSyncboolean
isEmailSyncboolean
isFilesSyncboolean
cultureNamestring

Defines the "Culture" for the account. Must be in RFC 4646 format. This will affect date/time formats and language displayed to the customer. If null, defaults will be set.

notesstring
isDeletedboolean
utbmsIsEnabledboolean
ledesClientIdstring
websitestring
isAllowClientToViewAllOutstandingInvoicesboolean required

Client portal setting. Sets if all outstanding invoices should be visible to the contact in the portal.

isAllowClientToViewAllPaidInvoicesboolean required

Client portal setting. Sets if all paid invoices should be visible to the contact in the portal.

isAllowClientToViewAllPaymentsboolean required

Client portal setting. Sets if all previous payments should be visible in the portal.

isAllowClientToViewAccountBalancesboolean required

Client portal setting. Sets if account balances (trust and operating) shoudl be visible in the portal.

isSendInvoicePaymentRemindersboolean required
isSendQuoteApprovalRemindersboolean required
isDisableEcheckboolean required
invoicesDuenumber double

Total unpaid on invoices. Different than Balance as some of the balance may not be applied towards invoices. Total unpaid on invoices. Different than Balance as some of the balance may not be applied towards invoices.

isContainsOnlyPendingInvoicesboolean
operatingUnappliedCreditnumber double

OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds

is1099Eligibleboolean
taxIdstring
defaultChartOfAccountGuidstring uuid

Used to set the reference in POST and PUT

defaultChartOfAccountNamestring
operatingPaidnumber double

Total amount paid on Operating Bank Account Payments. Total amount paid on Operating Bank Account Payments.

ccPaidnumber double

Total amount paid on Credit Card Bank Account Payments. Total amount paid on Credit Card Bank Account Payments.

surchargesEnabledboolean
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

nameAndNumberstring
guidstring uuid
idinteger

Example request

{
  "customFieldValues": [
    {
      "guid": "00000000-0000-0000-0000-000000000000",
      "valueContactGuid": "00000000-0000-0000-0000-000000000000",
      "valueContact": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "customField": {
        "createdBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "lastModifiedBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "usersFollowing": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "primaryContact": {
    "customFieldValues": [
      {
        "guid": "00000000-0000-0000-0000-000000000000",
        "valueContactGuid": "00000000-0000-0000-0000-000000000000",
        "valueContact": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "customField": {
          "createdBy": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "lastModifiedBy": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "guid": "00000000-0000-0000-0000-000000000000"
        }
      }
    ],
    "photoGuid": "00000000-0000-0000-0000-000000000000",
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "contacts": [
    {
      "customFieldValues": [
        {
          "guid": "00000000-0000-0000-0000-000000000000",
          "valueContactGuid": "00000000-0000-0000-0000-000000000000",
          "valueContact": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "customField": {
            "createdBy": {
              "guid": "00000000-0000-0000-0000-000000000000"
            },
            "lastModifiedBy": {
              "guid": "00000000-0000-0000-0000-000000000000"
            },
            "guid": "00000000-0000-0000-0000-000000000000"
          }
        }
      ],
      "photoGuid": "00000000-0000-0000-0000-000000000000",
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "defaultChartOfAccountGuid": "00000000-0000-0000-0000-000000000000",
  "assignedTo": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "assignedToGuids": [
    "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"
}

Response

OK

isContactSyncboolean
isEmailSyncboolean
isFilesSyncboolean
cultureNamestring

Defines the "Culture" for the account. Must be in RFC 4646 format. This will affect date/time formats and language displayed to the customer. If null, defaults will be set.

notesstring
isDeletedboolean
utbmsIsEnabledboolean
ledesClientIdstring
websitestring
isAllowClientToViewAllOutstandingInvoicesboolean required

Client portal setting. Sets if all outstanding invoices should be visible to the contact in the portal.

isAllowClientToViewAllPaidInvoicesboolean required

Client portal setting. Sets if all paid invoices should be visible to the contact in the portal.

isAllowClientToViewAllPaymentsboolean required

Client portal setting. Sets if all previous payments should be visible in the portal.

isAllowClientToViewAccountBalancesboolean required

Client portal setting. Sets if account balances (trust and operating) shoudl be visible in the portal.

isSendInvoicePaymentRemindersboolean required
isSendQuoteApprovalRemindersboolean required
isDisableEcheckboolean required
invoicesDuenumber double

Total unpaid on invoices. Different than Balance as some of the balance may not be applied towards invoices. Total unpaid on invoices. Different than Balance as some of the balance may not be applied towards invoices.

isContainsOnlyPendingInvoicesboolean
operatingUnappliedCreditnumber double

OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds

is1099Eligibleboolean
taxIdstring
defaultChartOfAccountGuidstring uuid

Used to set the reference in POST and PUT

defaultChartOfAccountNamestring
operatingPaidnumber double

Total amount paid on Operating Bank Account Payments. Total amount paid on Operating Bank Account Payments.

ccPaidnumber double

Total amount paid on Credit Card Bank Account Payments. Total amount paid on Credit Card Bank Account Payments.

surchargesEnabledboolean
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

nameAndNumberstring
guidstring uuid
idinteger

Example response

{
  "customFieldValues": [
    {
      "guid": "00000000-0000-0000-0000-000000000000",
      "valueContactGuid": "00000000-0000-0000-0000-000000000000",
      "valueContact": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "customField": {
        "createdBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "lastModifiedBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "usersFollowing": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "primaryContact": {
    "customFieldValues": [
      {
        "guid": "00000000-0000-0000-0000-000000000000",
        "valueContactGuid": "00000000-0000-0000-0000-000000000000",
        "valueContact": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "customField": {
          "createdBy": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "lastModifiedBy": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "guid": "00000000-0000-0000-0000-000000000000"
        }
      }
    ],
    "photoGuid": "00000000-0000-0000-0000-000000000000",
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "contacts": [
    {
      "customFieldValues": [
        {
          "guid": "00000000-0000-0000-0000-000000000000",
          "valueContactGuid": "00000000-0000-0000-0000-000000000000",
          "valueContact": {
            "guid": "00000000-0000-0000-0000-000000000000"
          },
          "customField": {
            "createdBy": {
              "guid": "00000000-0000-0000-0000-000000000000"
            },
            "lastModifiedBy": {
              "guid": "00000000-0000-0000-0000-000000000000"
            },
            "guid": "00000000-0000-0000-0000-000000000000"
          }
        }
      ],
      "photoGuid": "00000000-0000-0000-0000-000000000000",
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "defaultChartOfAccountGuid": "00000000-0000-0000-0000-000000000000",
  "assignedTo": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "assignedToGuids": [
    "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"
}