GetEntityMetadata

About GetEntityMetadata

This returns a list of fields and metadata for the specified entity type (such as vendor, customer, department, bill, and more).

It returns a list of object parameters and characteristics.

Example

Request

<API_URL_EndPoint>/GetEntityMetadata.json

data={
   "entity" : ["Bill"]
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "Bill" : {
      "attributes" : {
        "display" : [ "invoiceNumber" ]
      },
      "fields" : {
        "id" : {
          "readonly" : true,
          "required" : false,
          "type" : "IdField",
          "entity" : "Bill",
          "label" : "Id"
        },
        "isActive" : {
          "readonly" : false,
          "required" : false,
          "type" : "EnumField",
          "enum" : {
            "1" : "Active",
            "2" : "Inactive",
            "3" : "Deleted"
          },
          "label" : "Active?"
        },
        "vendorId" : {
          "readonly" : false,
          "required" : true,
          "type" : "IdField",
          "entity" : "Vendor",
          "label" : "Vendor"
        },
        "invoiceNumber" : {
          "readonly" : false,
          "required" : true,
          "type" : "TextField",
          "length" : 100,
          "label" : "Invoice #"
        },
        "approvalStatus" : {
          "readonly" : true,
          "required" : false,
          "type" : "EnumField",
          "enum" : {
            "0" : "Unassigned",
            "1" : "Assigned",
            "4" : "Approving",
            "3" : "Approved",
            "5" : "Denied"
          },
          "label" : "Approval Status"
        },
        "invoiceDate" : {
          "readonly" : false,
          "required" : true,
          "type" : "DateField",
          "label" : "Invoice Date"
        },
        "dueDate" : {
          "readonly" : false,
          "required" : true,
          "type" : "DateField",
          "label" : "Due Date"
        },
        "glPostingDate" : {
          "readonly" : false,
          "required" : false,
          "type" : "DateField",
          "label" : "GL Posting Date"
        },
        "amount" : {
          "readonly" : true,
          "required" : false,
          "type" : "MoneyField",
          "label" : "Amount"
        },
        "localAmount" : {
          "readonly" : true,
          "required" : false,
          "type" : "MoneyField",
          "label" : "Amount"
        },
        "exchangeRate" : {
          "readonly" : false,
          "required" : false,
          "type" : "NumberField",
          "label" : "Exchange Rate"
        },
        "scheduledAmount" : {
          "readonly" : true,
          "required" : true,
          "type" : "MoneyField",
          "label" : "Scheduled Amount"
        },
        "paidAmount" : {
          "readonly" : true,
          "required" : false,
          "type" : "MoneyField",
          "label" : "Paid Amount"
        },
        "dueAmount" : {
          "readonly" : true,
          "required" : false,
          "type" : "MoneyField",
          "label" : "Amount Due"
        },
        "paymentStatus" : {
          "readonly" : true,
          "required" : false,
          "type" : "EnumField",
          "enum" : {
            "1" : "Open",
            "4" : "Scheduled",
            "0" : "PaidInFull",
            "2" : "PartialPayment"
          },
          "label" : "Status"
        },
        "description" : {
          "readonly" : false,
          "required" : false,
          "type" : "TextField",
          "length" : 4000,
          "label" : "Description"
        },
        "poNumber" : {
          "readonly" : false,
          "required" : false,
          "type" : "TextField",
          "length" : 250,
          "label" : "P.O. Number"
        },
        "createdTime" : {
          "readonly" : true,
          "required" : false,
          "type" : "DateTimeField",
          "label" : "Created"
        },
        "updatedTime" : {
          "readonly" : true,
          "required" : false,
          "type" : "DateTimeField",
          "label" : "Updated"
        },
        "payFromBankAccountId" : {
          "readonly" : false,
          "required" : false,
          "type" : "IdField",
          "entity" : "BankAccount",
          "label" : "Preferred Bank Acct."
        },
        "payFromChartOfAccountId" : {
          "readonly" : false,
          "required" : false,
          "type" : "IdField",
          "entity" : "ChartOfAccount",
          "label" : "Pay From Chart Of Account"
        },
        "paymentTermId" : {
          "readonly" : false,
          "required" : false,
          "type" : "IdField",
          "entity" : "PaymentTerm",
          "label" : "Payment Terms"
        },
        "hasAutoPay" : {
          "readonly" : false,
          "required" : false,
          "type" : "BooleanField",
          "label" : "Auto Pay Setup"
        },
        "eBillCreated" : {
          "readonly" : false,
          "required" : false,
          "type" : "BooleanField",
          "label" : "Created from an eBill"
        }
      },
      "nestedEntities" : {
        "BillLineItem" : {
          "attributes" : {
            "display" : [ null ]
          },
          "fields" : {
            "id" : {
              "readonly" : true,
              "required" : false,
              "type" : "IdField",
              "entity" : "BillLineItem",
              "label" : "Id"
            },
            "billId" : {
              "readonly" : true,
              "required" : true,
              "type" : "IdField",
              "entity" : "Bill",
              "label" : "Invoice #"
            },
            "amount" : {
              "readonly" : false,
              "required" : false,
              "type" : "MoneyField",
              "label" : "Amount"
            },
            "chartOfAccountId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "ChartOfAccount",
              "label" : "Account"
            },
            "departmentId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Department",
              "label" : "Department"
            },
            "locationId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Location",
              "label" : "Location"
            },
            "jobId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Job",
              "label" : "Job"
            },
            "customerId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Customer",
              "label" : "Customer"
            },
            "jobBillable" : {
              "readonly" : false,
              "required" : false,
              "type" : "BooleanField",
              "label" : "Billable?"
            },
            "description" : {
              "readonly" : false,
              "required" : false,
              "type" : "TextField",
              "length" : 4000,
              "label" : "Description"
            },
            "createdTime" : {
              "readonly" : true,
              "required" : false,
              "type" : "DateTimeField",
              "label" : "Created"
            },
            "updatedTime" : {
              "readonly" : true,
              "required" : false,
              "type" : "DateTimeField",
              "label" : "Updated"
            },
            "lineType" : {
              "readonly" : true,
              "required" : false,
              "type" : "EnumField",
              "enum" : {
                "1" : "expense",
                "2" : "item"
              },
              "label" : "Line Item Type"
            },
            "itemId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Item",
              "label" : "Item"
            },
            "quantity" : {
              "readonly" : false,
              "required" : false,
              "type" : "NumberField",
              "label" : "Qty"
            },
            "unitPrice" : {
              "readonly" : false,
              "required" : false,
              "type" : "HighPrecisionValueField",
              "label" : "Unit Cost"
            },
            "employeeId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "Employee",
              "label" : "Employee"
            },
            "actgClassId" : {
              "readonly" : false,
              "required" : false,
              "type" : "IdField",
              "entity" : "ActgClass",
              "label" : "Class"
            }
          }
        }
      }
    }
  }
}

Parameters