Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Expense

Created a new expense (contact)

post/api/expense

Request body

accountGuidstring uuid required

Used to set the reference in POST and PUT

projectGuidstring uuid required

Used to set the reference in POST and PUT

lastModifiedDatestring date-time
accountingAccountGuidstring uuid

Used to set the reference in POST and PUTWhen creating an expense, this is used to reference the expense category. When creating an expense, this is used to reference the expense category.

userGuidstring uuid

Used to set the reference in POST and PUTWhen creating or updating a time entry, this is used to associate a user with this time entry. When creating or updating a time entry, this is used to associate a user with this time entry.

isDeletedboolean
isBillableboolean required

Set this to true to indicate this expense is billable to the client and should be added to an invoice.

isBilledboolean required

Set this to true to indicate this expenses has already been billed to the client.

hardCostPaymentMethod'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry'
hardCostPaymentCheckNumberinteger
hardCostPaymentBankAccountGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentCheckPayeeGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentCheckIsPrintedboolean
hardCostPaymentCheckIsToPrintboolean
hardCostPaymentChartOfAccountGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentChartOfAccountNamestring
hardCostPaymentNotesstring
hardCostPaymentGuidstring uuid

Used to set the reference in POST and PUT

utbmsCodeIdinteger

When creating or updating a time entry, this is used to attach the UtbmsCode

primaryReceiptGuidstring uuid

Used to set the reference in POST and PUT

isMatchedToBankTransactionboolean
notesstring

Internal notes, Not visible on the invoice.

descriptionstring

Description, visible on the invoice.

datestring date-time required

The date of this expense. It will be added to the invoice and indicated on the reports.

amountnumber double required

The amount, in the account's (contact) currency.

qtynumber double required
totalAmountnumber double
createdDatestring date-time
status'Billable' | 'Billed' | 'Paid' | 'NotBillable'

This is a read only property, will be set on GET requests This is a read only property, will be set on GET requests

costType'SoftCost' | 'HardCost'

Hard costs are expenses incurred on behalf of a client that require a direct payment by the firm to a vendor. For example if a firm writes a check for a court filing fee, it is considered a hard cost. Soft costs are expenses that are charged to the client but a direct payment is not made to a vendor.

guidstring uuid
namestring

Example request

{
  "accountGuid": "00000000-0000-0000-0000-000000000000",
  "projectGuid": "00000000-0000-0000-0000-000000000000",
  "accountingAccountGuid": "00000000-0000-0000-0000-000000000000",
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "userGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentBankAccountGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentBankAccount": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "hardCostPaymentCheckPayeeGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentChartOfAccountGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentGuid": "00000000-0000-0000-0000-000000000000",
  "primaryReceiptGuid": "00000000-0000-0000-0000-000000000000",
  "account": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "accountingAccount": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "project": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "accountGuid": "00000000-0000-0000-0000-000000000000"
  },
  "user": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "primaryReceipt": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "saleDocumentItem": {
    "saleDocument": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "guid": "00000000-0000-0000-0000-000000000000"
}

Response

OK

accountGuidstring uuid required

Used to set the reference in POST and PUT

projectGuidstring uuid required

Used to set the reference in POST and PUT

lastModifiedDatestring date-time
accountingAccountGuidstring uuid

Used to set the reference in POST and PUTWhen creating an expense, this is used to reference the expense category. When creating an expense, this is used to reference the expense category.

userGuidstring uuid

Used to set the reference in POST and PUTWhen creating or updating a time entry, this is used to associate a user with this time entry. When creating or updating a time entry, this is used to associate a user with this time entry.

isDeletedboolean
isBillableboolean required

Set this to true to indicate this expense is billable to the client and should be added to an invoice.

isBilledboolean required

Set this to true to indicate this expenses has already been billed to the client.

hardCostPaymentMethod'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry'
hardCostPaymentCheckNumberinteger
hardCostPaymentBankAccountGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentCheckPayeeGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentCheckIsPrintedboolean
hardCostPaymentCheckIsToPrintboolean
hardCostPaymentChartOfAccountGuidstring uuid

Used to set the reference in POST and PUT

hardCostPaymentChartOfAccountNamestring
hardCostPaymentNotesstring
hardCostPaymentGuidstring uuid

Used to set the reference in POST and PUT

utbmsCodeIdinteger

When creating or updating a time entry, this is used to attach the UtbmsCode

primaryReceiptGuidstring uuid

Used to set the reference in POST and PUT

isMatchedToBankTransactionboolean
notesstring

Internal notes, Not visible on the invoice.

descriptionstring

Description, visible on the invoice.

datestring date-time required

The date of this expense. It will be added to the invoice and indicated on the reports.

amountnumber double required

The amount, in the account's (contact) currency.

qtynumber double required
totalAmountnumber double
createdDatestring date-time
status'Billable' | 'Billed' | 'Paid' | 'NotBillable'

This is a read only property, will be set on GET requests This is a read only property, will be set on GET requests

costType'SoftCost' | 'HardCost'

Hard costs are expenses incurred on behalf of a client that require a direct payment by the firm to a vendor. For example if a firm writes a check for a court filing fee, it is considered a hard cost. Soft costs are expenses that are charged to the client but a direct payment is not made to a vendor.

guidstring uuid
namestring

Example response

{
  "accountGuid": "00000000-0000-0000-0000-000000000000",
  "projectGuid": "00000000-0000-0000-0000-000000000000",
  "accountingAccountGuid": "00000000-0000-0000-0000-000000000000",
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "userGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentBankAccountGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentBankAccount": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "hardCostPaymentCheckPayeeGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentChartOfAccountGuid": "00000000-0000-0000-0000-000000000000",
  "hardCostPaymentGuid": "00000000-0000-0000-0000-000000000000",
  "primaryReceiptGuid": "00000000-0000-0000-0000-000000000000",
  "account": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "accountingAccount": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "project": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "accountGuid": "00000000-0000-0000-0000-000000000000"
  },
  "user": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "primaryReceipt": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "saleDocumentItem": {
    "saleDocument": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "guid": "00000000-0000-0000-0000-000000000000"
}