Invoice Metadata

GET {{base_url}}/metadata/INEntry

Use this endpoint to retrieve the Invoice metadata.

The metadata describes the fields in each table of the database for the record and describes whether or not the table is a custom table and whether or not it has a grid ID. Each field describes whether or not the field is required, the data type, the default value, whether or not it is updateable, and other useful minimums, limits, and maximum details.

For more information, see Metadata Reference.

HEADERS

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

{"inControl":{"Keys":"Batch","TableName":"inControl","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Recurring","FieldType":"Checkbox","Caption":"Recurring","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"EndDate","FieldType":"Date","Caption":"End Date","DefaultValue":"2007-12-31T00:00:00.000","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"DefaultTaxCode","FieldType":"String","Caption":"Default Tax Code","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Total","FieldType":"Numeric","Caption":"Amount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"SumTotal","FieldType":"Numeric","Caption":"File Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffTotal","FieldType":"Numeric","Caption":"Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"RetTotal","FieldType":"Numeric","Caption":"Retainage Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"SumRetTotal","FieldType":"Numeric","Caption":"Retainage Control Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffRetTotal","FieldType":"Numeric","Caption":"Retainage Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Selected","FieldType":"String","Caption":"Selected","DefaultValue":"Y","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Creator","FieldType":"String","Caption":"Creator","DefaultValue":"ADMIN","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Period","FieldType":"Numeric","Caption":"Period","DefaultValue":"200712","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Company","FieldType":"Company","Caption":"Company","DefaultValue":"[CURRENTCOMPANY]","Hidden":false,"Required":true,"Updateable":true,"MaxLength":14}],"Caption":"inControl"},"inMasterKey":{"Keys":"Batch,Invoice,WBS1,WBS2,WBS3","TableName":"inMasterKey","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Invoice","FieldType":"Uppercase","Caption":"Invoice","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":7},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"WBS1","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":10},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"WBS2","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"WBS3","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"TransComment","FieldType":"String","Caption":"TransComment","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StatusDesc","FieldType":"String","Caption":"StatusDesc","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true}],"Caption":"inMasterKey"},"inMaster":{"Keys":"Batch,Invoice,WBS1,WBS2,WBS3","TableName":"inMaster","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Invoice","FieldType":"Uppercase","Caption":"Invoice","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":7},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"\u003cbr /\u003eProject","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":10},{"FieldName":"WBS1Name","FieldType":"String","Caption":"WBS1Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ClientName","FieldType":"String","Caption":"ClientName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2Level","FieldType":"String","Caption":"WBS2Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ChargeType","FieldType":"String","Caption":"ChargeType","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"\u003cbr /\u003ePhase","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS2Name","FieldType":"String","Caption":"WBS2Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3Level","FieldType":"String","Caption":"WBS3Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"\u003cbr /\u003eTask","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS3Name","FieldType":"String","Caption":"\u003cbr /\u003eTask Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Org","FieldType":"String","Caption":"Org","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"TransDate","FieldType":"Date","Caption":"Date","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"DueDate","FieldType":"Date","Caption":"Due Date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"TransComment","FieldType":"String","Caption":"Comment","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":40},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"CurrencyCode","FieldType":"String","Caption":"CurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"CurrencyExchangeOverrideMethod","FieldType":"String","Caption":"CurrencyExchangeOverrideMethod","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CurrencyExchangeOverrideDate","FieldType":"Date","Caption":"CurrencyExchangeOverrideDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CurrencyExchangeOverrideRate","FieldType":"Numeric","Caption":"CurrencyExchangeOverrideRate","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":10},{"FieldName":"Status","FieldType":"String","Caption":"Status","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StatusDescription","FieldType":"String","Caption":"Status","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedByName","FieldType":"String","Caption":"Approved By","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedBy","FieldType":"String","Caption":"AuthorizedBy","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"RejectReason","FieldType":"String","Caption":"Reject Reason","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":500},{"FieldName":"ModUser","FieldType":"String","Caption":"ModUser","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"ModUserEmployee","FieldType":"String","Caption":"ModUserEmployee","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"ModDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Diary","FieldType":"Dropdown","Caption":"Diary","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CodeTable":"CFGDiaryAutoNum LEFT JOIN CFGDiary ON CFGDiaryAutoNum.Code = CFGDiary.Code LEFT JOIN CFGDatesStatus ON CFGDiaryAutoNum.Period = CFGDatesStatus.Period and CFGDiaryAutoNum.Company = CFGDatesStatus.Company LEFT JOIN (SELECT '0/'+CONVERT(varchar,Years) AS Pd, Years * 100 AS Period FROM (SELECT Distinct Period/100 AS Years FROM CFGDatesStatus WHERE Closed = 'N' and CFGDatesStatus.Company = /*N*/'PR') x) _OpenYear ON CFGDiaryAutoNum.Period = _OpenYear.Period","LimitToList":true},{"FieldName":"DiaryNo","FieldType":"Numeric","Caption":"Diary Number","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false}],"Caption":"inMaster"},"inDetail":{"Keys":"Batch,Invoice,WBS1,WBS2,WBS3,PKey","TableName":"inDetail","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Invoice","FieldType":"Uppercase","Caption":"Invoice","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":7},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"WBS1","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":10},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"WBS2","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":3},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"WBS3","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":3},{"FieldName":"PKey","FieldType":"String","Caption":"PKey","DefaultValue":"[GUID]","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"InvoiceSection","FieldType":"Dropdown","Caption":"Invoice\u003cbr /\u003eSection","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CodeTable":"(Select 'F' As Code, FeeLabel As Description, FeeAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.FeeAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'L' As Code, LabLabel As Description, LabAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.LabAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'C' As Code, ConLabel As Description, ConAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.ConAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'E' As Code, ExpLabel As Description, ExpAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.ExpAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'U' As Code, UnitLabel As Description, UnitAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.UnitAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'A' As Code, AddOnLabel As Description, AddOnAccount As Account, CA.Name As AccountName, CA.AccountCurrencyCode \r\nFrom CFGBillMain Left Join CA On CFGBillMain.AddOnAccount = CA.Account Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'T' As Code, TaxLabel As Description, '' As Account, '' As AccountName, '' As AccountCurrencyCode \r\nFrom CFGBillMain Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company \r\nUnion All \r\nSelect 'I' As Code, InterestLabel As Description, '' As Account, '' As AccountName, '' As AccountCurrencyCode \r\nFrom CFGBillMain Inner Join CFGMain on CFGBillMain.Company = CFGMain.Company Where CFGBillMain.Company = CFGBillMain.Company ) A\r\n","LimitToList":true},{"FieldName":"TaxCode","FieldType":"String","Caption":"\u003cbr /\u003eTax Code","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Account","FieldType":"Account","Caption":"\u003cbr /\u003eAccount","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":6},{"FieldName":"AccountName","FieldType":"String","Caption":"\u003cbr /\u003eAccount Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AccountCurrencyCode","FieldType":"String","Caption":"AccountCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"GlobalAccount","FieldType":"String","Caption":"GlobalAccount","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AccountType","FieldType":"Numeric","Caption":"AccountType","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Amount","FieldType":"Currency","Caption":"\u003cbr /\u003eAmount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"RetAmount","FieldType":"Currency","Caption":"\u003cbr /\u003eRetainage Amount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"TaxBasis","FieldType":"Currency","Caption":"\u003cbr /\u003eTax Basis","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Retainer","FieldType":"Checkbox","Caption":"\u003cbr /\u003eRetainer","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"LinkWBS1","FieldType":"WBS1","Caption":"Link\u003cbr /\u003eProject","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":10},{"FieldName":"LinkWBS2","FieldType":"WBS2","Caption":"Link\u003cbr /\u003ePhase","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"LinkWBS3","FieldType":"WBS3","Caption":"Link\u003cbr /\u003eTask","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"CreditMemoRefNo","FieldType":"String","Caption":"Credit Memo\u003cbr /\u003eNumber","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ClientName","FieldType":"String","Caption":"\u003cbr /\u003eClient Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false}],"Caption":"inDetail"}}