GET ExpenseItems/GetExpenseItemDefinition?id={id}

This endpoint helps to build the add/edit expense form.


Parameters

NameDescriptionAdditional information
id
Expense Id, set to 0 if it's for a new expense item

Define this parameter in the request URI.

Response body formats

A ExpenseItemDefinitionResponse

application/json, text/json

Sample:
{
  "Item": {
    "ExpenseItem": {
      "Id": 0,
      "ReferenceNumber": "Ref234234",
      "ExpenseSubCategoryId": 2123,
      "ExpenseSubCategoryDescription": null,
      "ParentId": 10,
      "SplitItems": null,
      "ClaimId": 1223,
      "ClaimReasonId": 1,
      "ClaimReasonInfo": "Claim Reason",
      "CurrencyId": 1,
      "CurrencySymbol": "£",
      "CountryId": 1,
      "ItemType": 1,
      "Date": "2014-12-25T00:00:00",
      "PrimaryItem": true,
      "Returned": true,
      "DisputeNotes": "Dispute Note",
      "TempAllow": false,
      "Corrected": false,
      "ItemCheckerId": null,
      "ItemCheckerTeamId": null,
      "FloatId": 1,
      "AdvanceDescription": null,
      "TransactionId": 0,
      "Quantity": 1.0,
      "Net": 100.0,
      "VAT": 10.0,
      "Total": 100.0,
      "AmountPayable": 100.0,
      "VATNumber": "VAT34245",
      "AccountCode": "Acc1637",
      "BaseCurrency": 1,
      "BaseCurrencyGlobal": 1,
      "ForeignVAT": 10.0,
      "ExchangeRate": 1.0,
      "ExchangeRateGlobal": 2.0,
      "ConvertedTotal": 10.0,
      "GrandTotal": 50.0,
      "GlobalTotal": 100.0,
      "GrandTotalGlobal": 20.0,
      "GrandTotalConverted": 0.0,
      "GrandTotalNet": 10.0,
      "GrandTotalVAT": 10.0,
      "GrandTotalAmountPayable": 20.0,
      "GrandTotalOther": 1,
      "GrandTotalRemoteWorkers": 2,
      "GrandTotalPersonalGuests": 5,
      "UserSaysHasReceipts": true,
      "NormalReceipt": true,
      "ReceiptAttached": true,
      "CarId": 1,
      "VehicleDescription": null,
      "MileageId": 1,
      "JourneySteps": null,
      "DistanceUom": 0,
      "HomeToOfficeDeductionMethod": 1,
      "NumPassengers": 2,
      "Miles": 50.0,
      "MileageBusiness": 1.0,
      "MileagePersonal": 10.0,
      "FuelLitresPersonal": 2,
      "FuelLitresBusiness": 1,
      "Attendees": "staff",
      "NumStaff": 10,
      "NumDirectors": 3,
      "NumPersonalGuests": 3,
      "NumRemoteWorkers": 5,
      "NumOthers": 1,
      "EventInHomeCity": false,
      "Tip": 10.0,
      "NumRooms": 1,
      "NumNights": 1,
      "HotelId": 1,
      "HotelName": "California",
      "Reason": "Expense Reason",
      "Notes": "Notes",
      "CompanyId": 1,
      "CompanyName": "Dummy Company",
      "FromId": 1,
      "FromDescription": null,
      "ToId": 1,
      "ToDescription": null,
      "AllowanceId": 1,
      "AllowanceStartDate": "2014-12-25T00:00:00",
      "AllowanceEndDate": "2014-12-25T00:00:00",
      "AllowanceDeduction": 1.0,
      "CostCentreBreakdowns": null,
      "Flags": null,
      "BlockedFlags": null,
      "UserDefined": null,
      "AddedAsMobileExpense": true,
      "ESRAssignmentId": 1,
      "ESRAssignmentDescription": null,
      "ValidationProgress": 10,
      "ValidationResults": null,
      "Edited": false,
      "Paid": false,
      "OriginalExpenseId": 10,
      "BankAccountId": 1,
      "OperatorValidationProgress": 0,
      "ExpenseActionOutcome": 0,
      "MobileMetricDeviceId": null,
      "WalletReceiptId": 0
    },
    "OrganisationSettings": {
      "DisplayAs": "Company",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddNewOrganisation": true
    },
    "ReasonSettings": {
      "DisplayAs": "Other",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddNewReason": true
    },
    "CountrySettings": {
      "DisplayAs": "Country",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddFromField": true
    },
    "CurrencySettings": {
      "DisplayAs": "Currency",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddNewCurrency": true
    },
    "OtherDetailsSettings": {
      "DisplayAs": "Other",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddNewOtherDetails": true
    },
    "DepartmentSettings": {
      "DisplayAs": "Department",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddFromField": true
    },
    "CostcodeSettings": {
      "DisplayAs": "Costcode",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddFromField": true
    },
    "ProjectcodeSettings": {
      "DisplayAs": "Other",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddFromField": true
    },
    "CostCenterBreakdowns": [
      {
        "DepartmentId": 55,
        "DepartmentDescription": null,
        "CostCodeId": 5345,
        "CostCodeDescription": null,
        "ProjectCodeId": null,
        "ProjectCodeDescription": null,
        "Percentage": 100
      }
    ],
    "CostCenterEmployeeDefaultBreakdownWithLabelData": null,
    "ToSettings": {
      "DisplayAs": "Other",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddToField": true
    },
    "FromSettings": {
      "DisplayAs": "From",
      "DisplayForCash": true,
      "DisplayForCreditCard": true,
      "DisplayForPurchaseCard": true,
      "DisplayOnIndividualItem": true,
      "MandatoryForCash": true,
      "MandatoryForCreditCard": true,
      "MandatoryForPurchaseCard": true,
      "CanAddFromField": true
    },
    "PrimaryCurrencyId": 5353,
    "CurrencyList": [
      {
        "CurrencyId": 24423,
        "CurrencyName": "Sterling",
        "GlobalCurrencyId": 0,
        "AlphaCode": null,
        "Archived": true
      }
    ],
    "PrimaryCountryId": 34345,
    "CountryList": [
      {
        "CountryId": 24423,
        "CountryName": "UK",
        "GlobalCountryId": 534,
        "VatRates": null,
        "Archived": true
      }
    ],
    "ClaimReasons": [
      {
        "Id": 45,
        "Label": "Reason Label",
        "Description": "Description",
        "AccountCodeVat": "No VAT Code",
        "AccountCodeNoVat": "No VAT Code",
        "Archived": false
      }
    ],
    "ExchangeRateReadOnly": false,
    "EmployeeBankAccounts": null,
    "PostCodeAnywhereCountries": [
      {
        "GlobalCountryid": 2323,
        "Country": "United Kingdom",
        "CountryCode": "345345",
        "Alpha3CountryCode": "GBR",
        "Numeric3CountryCode": 346,
        "PostcodeRegex": "?%%$£",
        "PostcodeAnywhereEnabled": true
      }
    ],
    "DefaultGlobalCountryId": 133,
    "EmployeeGlobalPrimaryCountryId": 0,
    "CanEditCostCode": true,
    "CanEditProjectCode": true,
    "CanEditDepartment": true,
    "UserDefinedFields": null,
    "ResponseInformation": null
  },
  "ResponseInformation": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body