Misc
The Misc resource is used to retrieve an existing miscellaneous record from EPASS. In EPASS, miscellaneous records can represent extra charges that are added to an invoice, such as a delivery fee or credit card upcharge. But they can also represent discounts, such as a rebate or coupon.
Categories:
Misc Table Fields
ViewRetrieve a Miscellaneous Record
GET /miscs/misc
This endpoint returns the attributes of a specific miscellaneous record.
Parameters
Name | Description |
---|---|
code |
Required. The miscellaneous code. In EPASS, this is entered in the Code field of the miscellaneous record and has a maximum of 15 characters. |
Sample: Retrieving a Miscellaneous Record
GET /miscs/misc/?code=REBATE20
{
"Result": {
"Success": true,
"Warning": false,
"HttpStatusCode": 0,
"GeneralMessage": "Returned 1 record",
"ExceptionMessage": null,
"Keys": [],
"Messages": [],
"Warnings": []
},
"Values": [
{
"Fields": {
"ID": 36456,
"StartDate": "2022-10-01T00:00:00",
"EndDate": "2024-10-31T00:00:00",
"AddBranchToGL": true,
"AddBranchToGLCostDb": true,
"AddBranchToGLCostCr": false,
"NoPriceReduction": true,
"Warranty": "From Invoice Type",
"ShowInMobileTech": false,
"Rebate": true,
"Obsolete": false,
"RequireNote": false,
"PercentageOfSellingPrice": true,
"MiscLink": "",
"GiftCardType": "",
"NotAllowPriceChange": true,
"MiscTypeCode": "REBATES",
"SigCommentCode": "",
"NotAllowFinish": false,
"EDIFormat": "",
"Points": 0.0,
"UseBranchTaxes": false,
"NotShowInInvoiceDetail": true,
"PromptCode": "",
"LinkToModel": false,
"LinkToModelTax1": false,
"LinkToModelTax2": false,
"LinkToModelTax3": false,
"ModelDiscount": true,
"SatisfiesMinDepositLine": false,
"NotAllowDescChange": false,
"UserCreated": "L",
"DateCreated": "2022-10-13T00:00:00",
"UserModified": "SALLY",
"DateModified": "2024-01-31T00:00:00",
"StartDateQuote": "2022-10-01T00:00:00",
"EndDateQuote": "2024-10-31T00:00:00",
"Qualification": "",
"ModelDiscountEach": false,
"CostIsPercentageSellingPrice": true,
"AppliesToOriginalModelPrice": true,
"CreditReasonShown": false,
"CreditReasonRequired": false,
"DoNotAttachWhenPickup": false,
"TimeInMinutes": 0,
"BuilderAllowance": false,
"LinqProductId": "",
"Code": "REBATE20",
"CommentCode": "",
"Cost": 75.0,
"Description": "Rebate 20%",
"GLCostCredit": "",
"GLCostDebit": "5130",
"GLRevenue": "4130",
"History": false,
"List": 20.0,
"Tax1": false,
"Tax2": true,
"Tax3": true
}
}
]
}
Misc not found.
Search for a Miscellaneous Record
POST /miscs/search
This endpoint searches and returns the attributes of a miscellaneous record. You can search by any of its attributes.
Note
See Searching, Paging, and Extended Info for instructions on building search queries.Sample: Searching for a Miscellaneous Record
POST /miscs/search
{
"query": {
"fieldName": "ID",
"eval": "EQUAL",
"value": 36462
}
}
POST /miscs/search
{
"paging": {
"pageSize": 5,
"pageStartId": 0
},
"query": {
"fieldName": "StartDate",
"eval": "between",
"start": "2022-10-01",
"end":"2024-10-31"
},
"subquery":[
{
"logic": "and",
"query": {
"fieldName": "Obsolete",
"eval": "equal",
"value": 'False'
},
"subquery":[
{
"logic": "or",
"query": {
"fieldName": "Obsolete",
"eval": "equal",
"value": 'true'
}
}
]
}
]
}
POST /miscs/search
{
"query": {
"fieldName": "ID",
"eval": "EQUAL",
"value": 36462
},
"extendedInfo": {
"MiscBranchTax":[],
"MiscSalesDivision": []
},
"tables": {
"Misc": ["Code","ShowInMobileTech", "StartDate"]
}
}
{
"Results": {
"Success": true,
"Warning": false,
"HttpStatusCode": 200,
"GeneralMessage": "Returned 4 records",
"ExceptionMessage": null,
"Keys": [],
"Messages": [],
"Warnings": []
},
"Paging": {
"PageSize": 5,
"LargestID": 36479,
"PagesRemaining": false
},
"Query": {
"fieldName": "StartDate",
"eval": "BETWEEN",
"value": "",
"valueList": null,
"start": "2022-10-01",
"end": "2024-10-31"
},
"SubQuery": [
{
"logic": "AND",
"Query": {
"fieldName": "Obsolete",
"eval": "EQUAL",
"value": "False",
"valueList": null,
"start": null,
"end": null
},
"subQuery": [
{
"logic": "OR",
"Query": {
"fieldName": "Obsolete",
"eval": "EQUAL",
"value": "true",
"valueList": null,
"start": null,
"end": null
},
"subQuery": []
}
]
}
],
"Misc": [
{
"Fields": {
"ID": 36452,
"StartDate": "2023-11-01T00:00:00",
"EndDate": "2023-11-28T00:00:00",
"AddBranchToGL": true,
"AddBranchToGLCostDb": false,
"AddBranchToGLCostCr": false,
"NoPriceReduction": false,
"Warranty": "From Invoice Type",
"ShowInMobileTech": true,
"Rebate": false,
"Obsolete": false,
"RequireNote": false,
"PercentageOfSellingPrice": false,
"MiscLink": "",
"GiftCardType": "",
"NotAllowPriceChange": false,
"MiscTypeCode": "",
"SigCommentCode": "",
"NotAllowFinish": false,
"EDIFormat": "",
"Points": 0.0,
"UseBranchTaxes": true,
"NotShowInInvoiceDetail": false,
"PromptCode": "",
"LinkToModel": false,
"LinkToModelTax1": false,
"LinkToModelTax2": false,
"LinkToModelTax3": false,
"ModelDiscount": false,
"SatisfiesMinDepositLine": false,
"NotAllowDescChange": false,
"UserCreated": "L",
"DateCreated": "2022-10-11T00:00:00",
"UserModified": "%~!",
"DateModified": "2023-11-29T00:00:00",
"StartDateQuote": "2023-11-01T00:00:00",
"EndDateQuote": "2023-11-28T00:00:00",
"Qualification": "",
"ModelDiscountEach": false,
"CostIsPercentageSellingPrice": false,
"AppliesToOriginalModelPrice": false,
"CreditReasonShown": false,
"CreditReasonRequired": false,
"DoNotAttachWhenPickup": false,
"TimeInMinutes": 0,
"BuilderAllowance": false,
"LinqProductId": "",
"Code": "INSTALLATION",
"CommentCode": "",
"Cost": 0.0,
"Description": "Installation",
"GLCostCredit": "",
"GLCostDebit": "",
"GLRevenue": "4160",
"History": false,
"List": 0.0,
"Tax1": false,
"Tax2": true,
"Tax3": false
}
},
{
"Paging": {
"PageSize": 100,
"PageStartId": 0
},
"Query": {
"fieldName": null,
"eval": "EQUAL",
"value": "",
"valueList": null,
"start": null,
"end": null
},
"SubQuery": [
{
"logic": "AND",
"Query": {
"fieldName": null,
"eval": "EQUAL",
"value": "",
"valueList": null,
"start": null,
"end": null
},
"subQuery": []
}
],
"Tables": {
"Misc": [
"ID",
"StartDate",
"EndDate",
"AddBranchToGL",
"AddBranchToGLCostDb",
"AddBranchToGLCostCr",
"NoPriceReduction",
"Warranty",
"ShowInMobileTech",
"Rebate",
"Obsolete",
"RequireNote",
"PercentageOfSellingPrice",
"MiscLink",
"GiftCardType",
"NotAllowPriceChange",
"MiscTypeCode",
"SigCommentCode",
"NotAllowFinish",
"EDIFormat",
"Points",
"UseBranchTaxes",
"NotShowInInvoiceDetail",
"PromptCode",
"LinkToModel",
"LinkToModelTax1",
"LinkToModelTax2",
"LinkToModelTax3",
"ModelDiscount",
"SatisfiesMinDepositLine",
"NotAllowDescChange",
"UserCreated",
"DateCreated",
"UserModified",
"DateModified",
"StartDateQuote",
"EndDateQuote",
"Qualification",
"ModelDiscountEach",
"CostIsPercentageSellingPrice",
"AppliesToOriginalModelPrice",
"CreditReasonShown",
"CreditReasonRequired",
"DoNotAttachWhenPickup",
"TimeInMinutes",
"BuilderAllowance",
"LinqProductId",
"Code",
"CommentCode",
"Cost",
"Description",
"GLCostCredit",
"GLCostDebit",
"GLRevenue",
"History",
"List",
"Tax1",
"Tax2",
"Tax3"
]
},
"ExtendedInfo": {}
}
Feedback
Was this page helpful?
Thank you! Have additional feedback? We would love to hear from you!
Sorry to hear that. Please tell us how we can improve.