这是我们崭新的REST API的文档页面-并不是要找到它。此API尚未准备好供公众使用。随着我们的成长,我们正在砍伐和改变很多。因此,如果您构建使用它的东西,那么很可能在以后的更新中中断。 不要说您没有被警告!
网址: | //api.meituohu.com/v2/settings |
方法): | 得到 |
回应格式: | JSON,XML |
描述: | 此方法使您可以检索用户的所有设置。 |
反应要素
名称 | 类型 | 描述 |
---|---|---|
关联帐户列表。每个关联帐户具有以下参数 | ||
公司名 | 串 | 用户的公司名称 |
用户name | 串 | 用户名 |
显示设置参数 | ||
显示密度 | 串 | 用户的显示设置 ’的帐户。可接受的3个选项是1.舒适,2。舒适和3.紧凑 |
原色 | 采集 | 原色阴影的阵列。原色是应用程序中使用的最突出的颜色。阴影由十六进制颜色代码字符串表示。例如, [“#5FBF46”, “#AFDFA2”, “#D7EFD0”, “#FBFDF9” ] |
次要颜色 | 采集 | 次要颜色的阴影阵列。次要颜色通常用于突出显示。阴影由十六进制颜色代码字符串表示。例如, [“#F76B97”, “#C0B5FB”, “#DFDAFD”, “#EEECFE” ] |
CustomColorsEnabled | 布尔型 | 是否为用户启用了自定义着色’s account |
报价设置参数 | ||
QuoteText | 串 | 用于表示整个应用程序中的报价的名称 |
参考 | 串 | 参考栏标题 |
IncludeTotalInList | 布尔型 | 用于指示总计是否将显示在报价列表中的标志 |
DefaultEmailTemplateNumber | 数字 | 用于通过电子邮件发送报价的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
InvoiceConversionSettings | 目的 | 报价转换为发票的设置 |
InvoiceConversionSettings字段 | ||
删除 | 布尔型 | 指示报价转换为发票后是否应删除报价的标志 |
CopyReferenceAsComment | 布尔型 | 标记,用于指示是否将报价参考转换为转换后的发票中的行项目,并复制到发票的客户参考字段中 |
CopyReferenceAsPurchaseOrder | 布尔型 | 标记以指示是否将报价参考复制到发票的客户参考字段 |
变更类别 | 布尔型 | 标识报价类别转换为发票后是否要更改(重新分配)的标志 |
重新分配类别至 | 数字 | 报价转换为发票后要更改(重新分配)的类别的唯一编号 |
项目设置参数 | ||
已启用 | 布尔型 | 是否为用户启用了项目 |
工程文字 | 串 | 用于表示整个应用程序中的项目的名称 |
ProjectOnInvoiceLine | 布尔型 | 是否为用户启用了发票订单项上的项目 |
ProjectOnPurchaseLine | 布尔型 | 用户是否启用了采购订单项上的项目 |
ProjectOnBankLine | 布尔型 | 是否为用户启用了银行交易行项目项目 |
日记帐设置参数 | ||
已启用 | 布尔型 | 是否为用户启用日记 |
公司设置参数 | ||
公司名 | 串 | 用户的公司名称 |
订阅类型 | 串 | 帐户的订阅是否为‘Paid’ or ‘FreeTrial’ |
每月支付一次 | 布尔型 | 帐户的订阅付款是否每月完成 |
DaysLeftForSubscriptionToExpire | 数字 | 帐户订阅到期的剩余天数 |
网站名称 | 串 | 帐户的应用程序名称。如果是合作伙伴关联的帐户,则可以由用户自定义。对于所有其他帐户,此字段的值为‘KashFlow’ |
居家货币 | 目的 | 与本币有关的信息 |
日期格式 | 串 | 返回美国格式(MM / DD / YYYY)或英国格式(DD / MM / YYYY)。此日期格式适用于整个申请。 |
增值税已注册 | 布尔型 | 是否用户 is VAT registered |
TotangoAccountStatus | 串 | 用户’s totango帐户状态。可能的值为“免费”,“付款”,“失效”,“过期” |
TotangoCreatedDate | 串 | Totango创建日期。例如JSON格式:[JSONDATE],XML格式:[XMLDATE] |
应用 | 串 | “RSR”如果用户正在使用新的rsr应用,则其他“Classic” |
合作伙伴ID | 数字 | 合作伙伴ID |
ApiEnabled | 布尔型 | 是否为用户启用了SOAP API。 |
地址 | 目的 | 具有4条地址行和邮政编码的地址对象 |
电话 | 串 | 电话号码 |
OnboarderName | 串 | 入职者姓名 |
PartnerBrandingOptOut | 布尔型 | 排除合作伙伴品牌。 |
潜在客户 | 串 | 可能的值为是,否,不可接触 |
预扣税金设置 | 目的 | 所有与预扣税相关的设置。在下面详细描述。 |
库存设置 | 目的 | 用户的库存管理设置。“Enabled”字段指示是否为用户启用了库存管理。 |
LastPayment失败 | 布尔型 | 是否用户’的上一次付款是否失败。 |
订阅状态 | 串 | 用户的当前订阅状态。该值将是 活跃已取消|已过期 |
银行对帐设置 | 目的 | 银行对帐相关设置。在下面详细描述。 |
用户 settings parameters | ||
IsAdmin | 布尔型 | 用户是否为管理员 |
增值税文字 | 串 | 用户’定制的增值税名称 |
说明文字 | 串 | 用户’定制的描述名称 |
数量文字 | 串 | 用户’定制的数量名称 |
RateText | 串 | 用户’定制的费率名称 |
默认值 | 数字 | 用户’s default vat rate |
DisplayAllNominalCodes | 布尔型 | 允许访问所有区域的所有名义代码–这意味着您可以输入与购买和销售相同的名义代码进行银行交易。 |
总文字 | 串 | 这是总计列的标题。 |
IncludeNominalCodeWithNominalName | 布尔型 | 是否应在名义清单的名称中包括代码 |
TransactionLockDate | 日期 | 交易锁定日期。例如JSON格式:[JSONDATE],XML格式:[XMLDATE] |
TransactionLockEnabled | 布尔型 | 事务锁是否启用。如果启用,则用户赢得’如果它带有交易锁定日期范围,则不允许更改发票。 |
DefaultBankAccountId | 数字 | 用户默认银行帐户的唯一ID。 |
GoCardLessEnabled | 布尔型 | 用户的Gocardless帐户是否已配置。 Ref: //gocardless.com/ |
CardPaymentEnabled | 布尔型 | 用户是否配置了任何卡支付选项 |
ManualDiscountEnabled | 布尔型 | 指示是否启用手动折扣的标志。 |
电子邮件设置 | 目的 | 电子邮件设置信息。包含启用“密件抄送”和“密件抄送地址”字段。 |
StartPageUrl | 串 | 取决于配置的起始页。该值将是 概述|设置|报告|客户|行情|发票|供应商|收据|银行 |
主邮箱 | 串 | 用户的主要电子邮件。 |
用户Name | 串 | 用户name of the user. |
CanBuyService | 布尔型 | If one user can pay directly to 卡什流 for subscription. |
MOSS注册 | 布尔型 | 指示用户是否已注册迷你一站式服务(MOSS)的标志。 |
CanOverrideDefaultPayOnlineProcessor | 数字 | (只读)标记,指示用户在使用发票资源的Invoice.PayOnlinePaymentProcessor属性进行更新/创建时,是否可以覆盖从银行付款到卡付款的默认付款payonline处理器(发票的电子邮件PDF上的payonline链接),反之亦然。 0 =错误。 1 =正确 |
DefaultPayOnlineProcessor | 数字 | 用户的默认PayOnlineProcessor。即15 =银行付款,4 =卡付款,0 =表示将选择默认值(或者如果Settings.UserSettings。CanOverrideDefaultPayOnlineProcessor等于0) |
发票设置参数 | ||
客户参考文字 | 串 | 用户’s customized name of Customer 参考 |
发票文字 | 串 | 用户’s customized name of Invoice |
DefaultEmailTemplateNumberForInvoice | 数字 | 用于通过电子邮件发送发票的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
DefaultEmailTemplateNumberForPaymentReceipt | 数字 | 用于通过电子邮件发送发票付款收据的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
IsPackingSlipEnabled | 布尔型 | 用户的发票是否启用装箱单’s account |
InvoicePdfFileNameFormat | 串 | 发票pdf文件名的格式 |
投寄箱 设置参数 | ||
已配置 | 布尔 | 是的,如果任何保管箱设置可用 |
邮寄 设置参数 | ||
已启用 | 布尔型 | 是否为用户启用ViaPost |
IncludeContactName | 布尔型 | 使用ViaPost发送文档时地址中是否包含联系人姓名 |
打印双面 | 布尔型 | 在发送文档时,ViaPost是否应在页面两面打印 |
SendInColor | 布尔型 | 在发送文档时,ViaPost是否应以彩色而不是黑白方式打印内容 |
用户Name | 串 | 用户的ViaPost用户名 |
购买设置参数 | ||
DefaultEmailTemplateNumberForPurchase | 数字 | 用于通过电子邮件发送购买的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
DefaultEmailTemplateNumberForRemittance | 数字 | 用于通过电子邮件发送汇款的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
AdditionalFieldEnabled | 布尔型 | 是否为每次购买启用了额外的参考字段 |
AdditionalFieldName | 串 | 每次购买的额外参考字段的名称 |
AutoPayOnCreation | 布尔型 | 添加付款并将购买标记为‘Paid’在创建购买时自动 |
CheckForDuplicateSupplierReference | 布尔型 | 启用检查以验证是否已为相应的供应商输入在创建采购时提供的供应商参考。 |
ShowAttachmentsIcon | 布尔型 | 在“购买”页面上显示一个图标,指示购买中已附加了一些物品 |
客户设置参数 | ||
DefaultEmailTemplateNumberForStatement | 数字 | 用于发送电子邮件对帐单的默认电子邮件模板的唯一编号。 有关电子邮件模板的更多详细信息, 点击这里 |
自动信用控制设置参数 | ||
已启用 | 布尔型 | 指示是否为用户帐户启用自动信用控制的标志。 |
已启用ForNewCustomers | 布尔型 | 指示是否应为新创建的客户启用自动信用控制的标志。如果设置为true,则所有创建的新客户都将启用自动信用控制。 |
订阅PackageInfo参数 | ||
名称 | 串 | 用户已订阅的订阅包的名称。 |
价钱 | 数字 | 当前软件包的订阅金额。 |
多用户支持 | 布尔型 | 是的,如果订阅包支持多用户 |
发票数 | 数字 | 如果套餐不支持无限制的发票,则订阅包允许的最大发票数。 |
工资单 已启用 | 布尔型 | 是的,如果订阅包支持工资核算应用程序。 |
循环发票支持 | 布尔型 | 是的,如果订阅程序包支持重复发票的创建。 |
无限发票支持 | 布尔型 | 是的,如果订阅包支持创建无限的发票。 |
预扣税设置参数
名称 | 类型 | 描述 |
---|---|---|
已启用OnPurchases | 布尔型 | 指示是否启用预扣税的标记。 |
已启用OnSales | 布尔型 | 指示预提税的标志已启用或未在发票上。 |
名称 | 串 | 此税的名称。通常是CIS(建筑行业计划)或WHT(预扣税) |
显示扣除 | 布尔型 | 标记,指示是否在发票上显示总金额下方的注释,其中详细说明了扣除额以及应用扣除后的应付额。 |
名义代码 | 数字 | 跟踪CIS的名义代码。 |
参考设置 | 目的 | 包含与参考字段有关的信息的对象。在下面详细说明。 |
预扣税率设置 | 目的 | 包含与预提税率有关的信息的对象。在下面详细说明。 |
排除设置 | 目的 | 包含与排除相关的信息的对象。在下面详细说明。 |
报告设置 | 目的 | 包含与报告相关的设置的对象。在下面详细说明。 |
参考字段设置参数
名称 | 类型 | 描述 |
---|---|---|
已启用 | 布尔型 | 指示是否启用客户/供应商参考字段的标志。 |
栏位1名称 | 串 | 参考字段的名称1。 |
Field2Name | 串 | 参考字段名称2。 |
Field3Name | 串 | 参考字段名称3。 |
Field4Name | 串 | 参考字段名称4。 |
Field5Name | 串 | 参考字段的名称5。 |
预扣税率设置参数
名称 | 类型 | 描述 |
---|---|---|
利率基于名义 | 布尔型 | 指示费率取决于商品/服务还是客户/供应商的标志。如果真实汇率取决于商品/服务。 |
DefaultWithholdingTaxRate | 数字 | 默认CIS速率。您可以根据每个客户/供应商进行编辑 |
毛利率 | 布尔型 | 标志指示要扣除的比率是净额还是总额的百分比。如果从总金额中扣除了真实汇率。 |
ListRatesForNominals | 布尔型 | 标志指示是否列出每种商品/服务类型使用的费率。 |
预扣税排除设置参数
名称 | 类型 | 描述 |
---|---|---|
已启用 | 布尔型 | 指示是否启用排除的标志。 |
名称 | 串 | 排除项目的名称。 |
标称 | 目的 | 标称分配给此排除项。它包含诸如名义代码,显示为,名称和ID之类的信息。所有字段将在下面更详细地说明。 |
预扣税排除名义参数
名称 | 类型 | 描述 |
---|---|---|
排除编号 | 数字 | 用于排除的唯一数据库ID。 |
ID | 数字 | 标称值的唯一数据库ID。 |
码 | 数字 | 代号 |
名称 | 串 | 名义名称 |
展示为 | 串 | 标称显示为 |
预扣税报表设置参数
名称 | 类型 | 描述 |
---|---|---|
ShowNetAmount | 布尔值 | 指示是否显示净额而不是总额的标志。 |
GroupByCustomer | 布尔值 | 指示是否按客户/供应商对项目进行分组的标志。 |
ShowExclusions | 布尔值 | 指示是否添加一列以显示“物料”值的标志。 |
银行对帐设置参数
名称 | 类型 | 描述 |
---|---|---|
NewStyleReconciliationEnabled | 布尔型 | 核对银行对帐单时,显示的期初余额是所选日期的期初余额,包括所有较早的未对账项目。如果启用此选项,则较旧的未对帐项目将从该余额中排除。而不是“starting balance”,页面将显示一个“reconciled balance” |
排除旧的未对帐交易 | 布尔型 | 指示是否启用分屏银行对帐的标志。 |
GET操作
返回用户的不同设置的列表。获取用户设置列表–网址: /设置
GET用户设置列表示例响应
{
"AssociatedAccounts": [],
"AutomaticCreditControlSettings": {
"已启用": true,
"已启用ForNewCustomers": true
},
"CompanySettings": {
" 地址 ": {
"Line1": "",
"Line2": "",
"Line3": "",
"Line4": "",
"PostCode": ""
},
" ApiEnabled ": false,
"应用": "RSR",
"银行对帐设置": {
"排除旧的未对帐交易": false,
"NewStyleReconciliationEnabled": true
},
"公司名": "Empty DB",
" 日期格式 ": "DD\/MM\/YYYY",
"DaysLeftForSubscriptionToExpire": 310,
"居家货币": {
" 码 ": "GBP",
"DisplaySymbolOnRight": false,
"ExchangeRate": 0,
" 名称 ": null,
"Symbol": "£"
},
"IsDemoAccount": false,
"LastPayment失败": false,
"潜在客户 ": "No",
"MOSS注册": false,
"OnboarderName": "",
"PartnerBrandingOptOut": true,
" 合作伙伴ID ": 0,
"每月支付一次": true,
"PrimaryContact": "lore",
" 网站名称 ": "卡什流",
"库存设置": {
"已启用": false
},
"订阅状态": "Active",
"订阅类型": "免费试用",
" 电话 ": "1234567890",
"TotangoAccountStatus": "Free",
"TotangoCreatedDate": "2014-07-09 12:00:00",
"增值税已注册": true,
"预扣税金设置": {
"已启用OnPurchases": false,
"已启用OnSales": true,
"排除设置": {
"已启用": false,
" 名称 ": "Materials",
" 标称 ": []
},
" 名称 ": "CIS",
"名义代码": 2212,
"参考设置": {
"已启用": true,
"栏位1名称": "UTR No",
"Field2Name": "Company Reg. Number",
"Field3Name": "NI number",
" Field4Name ": "Verification Number",
"Field5Name": ""
},
"报告设置": {
"GroupByCustomer": false,
"ShowExclusions": false,
"ShowNetAmount": false
},
"显示扣除": false,
"预扣税率设置": {
"DefaultWithholdingTaxRate": 27.0000,
"ListRatesForNominals": false,
"利率基于名义": false,
"毛利率": false
}
}
},
"CustomerSettings": {
"DefaultEmailTemplateNumberForStatement": 3
},
"DisplaySettings": {
"CustomColorsEnabled": false,
"显示密度": "Comfortable",
"原色": ["", "", "", ""],
"次要颜色": ["", "", "", ""]
},
" 投寄箱 Settings": {
" 已配置 ": true
},
"InvoiceSettings": {
"客户参考文字": "Purchase Order",
"DefaultEmailTemplateNumberForInvoice": 2,
"DefaultEmailTemplateNumberForPaymentReceipt": 0,
"InvoicePdfFileNameFormat": "[invname]-[invnum]",
"发票文字": "Invoice",
"IsPackingSlipEnabled": true,
"PackingSlipName": "Packing Slip",
"ShowCustomerReferenceOnInvoiceList": false
},
"JournalSettings": {
" 已启用 ": false
},
"PartnerRestrictions": {
" 设定值 ": {
"ShowDisplayOptions": true
},
"Reports": {
"RestrictSelfAssessmentTaxes":false
}
},
"ProjectSettings": {
" 已启用 ": true,
"ProjectOnBankLine": true,
"ProjectOnInvoiceLine": false,
"ProjectOnPurchaseLine": false,
"工程文字": "Project"
},
"PurchaseSettings": {
"AdditionalFieldEnabled": false,
"AdditionalFieldName": "Permit No.",
"AutoPayOnCreation": false,
"CheckForDuplicateSupplierReference": false,
"DefaultEmailTemplateNumberForPurchase": 0,
"DefaultEmailTemplateNumberForRemittance": 0,
"ShowAttachmentsIcon": true
},
"QuoteSettings": {
"DefaultEmailTemplateNumber": 0,
"InvoiceConversionSettings": {
"变更类别": false,
"CopyReferenceAsComment": false,
"CopyReferenceAsPurchaseOrder": false,
" 删除 ": true,
"重新分配类别至": 0
},
"QuoteShowTotalInPdf": false,
" QuoteText ": "Quote",
" 参考 Text": "Quote Ref"
},
"订阅PackageInfo": {
" 名称 ": "经典 卡什流",
" 价钱 ": 15.0000,
"Restrictions": {
"MultiCurrencySupport": true,
"多用户支持": true,
"发票数": 0,
" 工资单 已启用 ": true,
"循环发票支持": true,
"无限发票支持": true
}
},
"用户Settings": {
"CanBuyService": true,
"CardPaymentEnabled": false,
"DefaultBankAccountId": 9,
"默认值": 20.0000,
"说明文字": "描述",
"DisplayAllNominalCodes": true,
"电子邮件设置": {
"BCCAddress": "",
"BCCEnabled": false
},
"GoCardLessEnabled": false,
"IncludeNominalCodeWithNominalName": false,
" IsAdmin ": true,
"ManualDiscountEnabled": false,
"PaymentProcessorDetails": null,
"主邮箱": "[email protected]",
"数量文字": "Qty",
" RateText ": "Rate",
"StartPageUrl": " 总览 ",
" 总文字 ": "Total",
"TransactionLockDate": "1900-01-01 12:00:00",
"TransactionLockEnabled": false,
"Turnover": 0,
"用户Name": "prashant",
" 增值税文字 ": "GST",
"CanOverrideDefaultPayOnlineProcessor": 1,
"DefaultPayOnlineProcessor": 0
},
" 邮寄 Settings": {
"已启用": false,
"IncludeContactName": false,
"打印双面": false,
"SendInColor": false,
"用户Name": ""
}
}