Cash Receipt Metadata

GET {{base_url}}/metadata/CREntry

Use this endpoint to retrieve the Cash Receipt 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

{"crControl":{"Keys":"Batch","CustomTable":false,"TableName":"crControl","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Description","FieldType":"String","Caption":"File Name","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":40},{"FieldName":"Recurring","FieldType":"Checkbox","Caption":"Recurring","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"EndDate","FieldType":"Date","Caption":"End Date","DefaultValue":"2017-12-31T00:00:00.000","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Total","FieldType":"Numeric","Caption":"Amount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"SumTotal","FieldType":"Numeric","Caption":"File Total","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"DiffTotal","FieldType":"Numeric","Caption":"Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"DefaultBank","FieldType":"Dropdown","Caption":"Default Bank","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"CodeTable":"CFGBanks","LimitToList":true},{"FieldName":"DefaultBankDescription","FieldType":"String","Caption":"Default Bank","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"BankCurrencyCode","FieldType":"String","Caption":"BankCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"Selected","FieldType":"String","Caption":"Selected","DefaultValue":"Y","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Creator","FieldType":"String","Caption":"Creator","DefaultValue":"ADMIN","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Period","FieldType":"Numeric","Caption":"Period","DefaultValue":"201305","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Company","FieldType":"Company","Caption":"Company","DefaultValue":"[CURRENTCOMPANY]","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":14},{"FieldName":"PostPeriod","FieldType":"Numeric","Caption":"PostPeriod","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"PostSeq","FieldType":"Numeric","Caption":"PostSeq","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"SubmittedBy","FieldType":"String","Caption":"SubmittedBy","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"SubmittedDate","FieldType":"Datetime","Caption":"SubmittedDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false}],"Caption":"crControl"},"crMasterKey":{"Keys":"Batch,RefNo","CustomTable":false,"TableName":"crMasterKey","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"RefNo","FieldType":"String","Caption":"RefNo","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"BankName","FieldType":"String","Caption":"BankName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"BankCode","FieldType":"String","Caption":"BankCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"TransComment","FieldType":"String","Caption":"TransComment","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"TransDate","FieldType":"String","Caption":"TransDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"StatusDesc","FieldType":"String","Caption":"StatusDesc","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false}],"Caption":"crMasterKey"},"crMaster":{"Keys":"Batch,RefNo","CustomTable":false,"TableName":"crMaster","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"RefNo","FieldType":"String","Caption":"Reference Number","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":32},{"FieldName":"TransDate","FieldType":"Date","Caption":"Transaction Date","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"TransComment","FieldType":"String","Caption":"Comment","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":40},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"BankCode","FieldType":"Dropdown","Caption":"Bank","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"CodeTable":"CFGBanks","LimitToList":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"CurrencyCode","FieldType":"String","Caption":"CurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"CurrencyExchangeOverrideMethod","FieldType":"String","Caption":"CurrencyExchangeOverrideMethod","DefaultValue":"N","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"CurrencyExchangeOverrideDate","FieldType":"Date","Caption":"CurrencyExchangeOverrideDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"CurrencyExchangeOverrideRate","FieldType":"Numeric","Caption":"CurrencyExchangeOverrideRate","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"Decimals":10},{"FieldName":"Status","FieldType":"String","Caption":"Status","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"StatusDescription","FieldType":"String","Caption":"Status","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"AuthorizedByName","FieldType":"String","Caption":"Approved By","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"AuthorizedBy","FieldType":"String","Caption":"AuthorizedBy","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"RejectReason","FieldType":"String","Caption":"Reject Reason","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":500},{"FieldName":"ModUser","FieldType":"String","Caption":"ModUser","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"ModUserEmployee","FieldType":"String","Caption":"ModUserEmployee","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"ModDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Diary","FieldType":"Dropdown","Caption":"Diary","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"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*/'A0') x) _OpenYear ON CFGDiaryAutoNum.Period = _OpenYear.Period","LimitToList":true},{"FieldName":"DiaryNo","FieldType":"Numeric","Caption":"Diary Number","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false}],"Caption":"crMaster"},"crDetail":{"Keys":"Batch,RefNo,PKey","CustomTable":false,"TableName":"crDetail","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"RefNo","FieldType":"String","Caption":"RefNo","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":32},{"FieldName":"PKey","FieldType":"String","Caption":"PKey","DefaultValue":"[GUID]","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":40},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"\u003cbr /\u003eProjectXx","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":12},{"FieldName":"WBS1Name","FieldType":"String","Caption":"\u003cbr /\u003eProjectXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ClientName","FieldType":"String","Caption":"\u003cbr /\u003eClientXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS2Level","FieldType":"String","Caption":"WBS2Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ChargeType","FieldType":"String","Caption":"ChargeType","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"BillingCurrencyCode","FieldType":"String","Caption":"BillingCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"\u003cbr /\u003ePhaseXx","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":4},{"FieldName":"WBS2Name","FieldType":"String","Caption":"\u003cbr /\u003ePhaseXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS3Level","FieldType":"String","Caption":"WBS3Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"\u003cbr /\u003eTaskXx","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":4},{"FieldName":"WBS3Name","FieldType":"String","Caption":"\u003cbr /\u003eTaskXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"FunctionalCurrencyCode","FieldType":"String","Caption":"FunctionalCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"Org","FieldType":"String","Caption":"Org","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"Invoice","FieldType":"String","Caption":"Invoice","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Account","FieldType":"Account","Caption":"\u003cbr /\u003eAccountZ","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":9},{"FieldName":"AccountName","FieldType":"String","Caption":"\u003cbr /\u003eAccountZ Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"AccountCurrencyCode","FieldType":"String","Caption":"AccountCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"GlobalAccount","FieldType":"String","Caption":"GlobalAccount","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"AccountType","FieldType":"Numeric","Caption":"AccountType","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"Amount","FieldType":"Currency","Caption":"\u003cbr /\u003eAmount","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Interest","FieldType":"String","Caption":"Interest","DefaultValue":"N","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"TaxCode","FieldType":"Dropdown","Caption":"Tax Code","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"CodeTable":"CFGBillTaxes","LimitToList":true},{"FieldName":"TaxBasis","FieldType":"Currency","Caption":"Tax Basis","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"Retainer","FieldType":"String","Caption":"Retainer","DefaultValue":"N","Hidden":false,"Required":true,"Updateable":true,"CustomField":false},{"FieldName":"CurrencyExchangeOverrideRate","FieldType":"Numeric","Caption":"Exchange\u003cbr /\u003eOverride Rate","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"Decimals":10},{"FieldName":"SourceCurrencyCode","FieldType":"String","Caption":"Source\u003cbr /\u003eCurrency Code","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"SourceBalance","FieldType":"Currency","Caption":"Source\u003cbr /\u003eBalance","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"SourceAmount","FieldType":"Currency","Caption":"Source\u003cbr /\u003eRelief","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"SourceExchangeInfo","FieldType":"XML","Caption":"Source Exchange Info","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false},{"FieldName":"LinkCompany","FieldType":"Dropdown","Caption":"Due To/From\u003cbr /\u003eCompany","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"CodeTable":"CFGMainData","LimitToList":true},{"FieldName":"PreInvoice","FieldType":"String","Caption":"PreInvoice","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false}],"Caption":"crDetail"},"formInfoCtl":{"Keys":"","CustomTable":false,"TableName":"formInfoCtl","GridID":null,"Hidden":false,"Updateable":false,"Fields":[{"FieldName":"WBS1Name","FieldType":"String","Caption":"\u003cbr /\u003eProjectXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS2Name","FieldType":"String","Caption":"\u003cbr /\u003ePhaseXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"WBS3Name","FieldType":"String","Caption":"\u003cbr /\u003eTaskXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ClientName","FieldType":"String","Caption":"\u003cbr /\u003eClientXx Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"AccountName","FieldType":"String","Caption":"\u003cbr /\u003eAccountZ Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"CurrencyCode","FieldType":"String","Caption":"Currency","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ExchgOvrType","FieldType":"String","Caption":"Exchange Override:","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"ExchgOvrData","FieldType":"String","Caption":"ExchgOvrData","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false},{"FieldName":"RefNoAutoNum","FieldType":"String","Caption":"RefNoAutoNum","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":false}],"Caption":"formInfoCtl"}}