引用s

这是我们崭新的REST API的文档页面-并不是要找到它。此API尚未准备好供公众使用。随着我们的成长,我们正在砍伐和改变很多。因此,如果您构建使用它的东西,那么很可能在以后的更新中中断。 不要说您没有被警告!

网址:

//api.meituohu.com/v2/quotes

方法):

获取,发布,放置,删除

回应格式:

JSON,XML

描述ription:

这些方法使您可以检索,创建,更新和删除引号。单个资源由报价号标识。因此,/ quotes / 123将返回带数字123的引号。类似地,对该URL的PUT将更新引号123。/ quotes的GET将返回所有引号。

参量

名称类型描述ription
数字数 given to quote
日期日期报价发布日期。例如[JSONDATE]
客户代码唯一的客户报价代码’s customer
顾客姓名引用’s customer name
客户参考引用’s reference
总金额数字总金额
净额数字报价金额,不含增值税
增值税额数字适用于报价的增值税
类别目的类别相关信息
货币目的货币 related information with default exchange rate or quote specific exchange rate specified by user.
LineItems采集订单项集合
项目编号数字报价项目号’s associated project
抑制金额布尔型标记指示是否显示总报价
上一页号码数字前报价的报价编号
下一页号码数字下一个报价的报价编号
固定链接可以共享的报价文件的永久URL。
LineItem参数
数字该字段有两个用途:
1.它唯一地标识一个订单项。
2.它代表排序顺序,即项目可以以与行号相同的顺序(升序)显示在行项列表中。
注意 :尽管行号唯一地标识了一行,但是当更改排序顺序时,行号可能会更改。另外,对于新订单项,应将其设置为0。
数量数字订单项单位
描述ription描述ription for a line item
货币汇率数字订单项的本币汇率。
增值税级别数字订单项的增值税率。对于PUT和POST请求,如果VATExempt属性为true,则不能将其指定。该字段是只读的。
首页CurrencyVATAmount数字发票行的自定义增值税金额(以本国货币表示)。对于PUT和POST请求,如果在VATExempt属性为true的情况下指定一些值,则该值将被忽略并将被视为0。
VATExempt布尔型订单项是否豁免增值税。
名义代码数字名义代码映射到名义资源的代码属性
税法适用于将新加坡元设置为本币的用户的税代码。
产品代码为这种资源的NominalCode属性中指定的Nominal / SalesType配置的产品之一的ProductCode在PUT / POST的情况下应指定,在GET的情况下将返回。该属性的值映射到产品资源的Code属性。
产品名称产品名称
数字报价货币汇率
增值税额数字报价货币的增值税金额

GET操作

根据指定的URL返回一个或所有引号的详细信息。获取报价清单–

网址: /引号

返回报价列表(按报价编号升序排列)。为了使响应紧凑,我们仅返回每个报价的摘要以及必填字段。另外,为避免使大型结果集不胜服务器或网络,我们仅返回按报价编号升序排列的前10个报价,而不返回整个报价列表。要检索更大的报价结果集,可以使用下面的分页URL。

获取报价的示例响应


{
    "Data": [{
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "BRIA01      ",
        "CustomerId": 6657,
        "顾客姓名": "Brian Hayes, 2541",
        "日期": "2012-06-21 12:00:00 +05:30",
        "总金额": 0.6500,
        "Id": 67023,
        "LineItems": null,
        "净额": 0.5400,
        "下一页号码": null,
        "数": 5,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.1100
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "BRIA01      ",
        "CustomerId": 6657,
        "顾客姓名": "Brian Hayes, 2541",
        "日期": "2013-02-07 12:00:00 +05:30",
        "总金额": 0.0000,
        "Id": 67344,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 5675,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "TestReference",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "TARA01      ",
        "CustomerId": 6974,
        "顾客姓名": "Tara Cleary, TQ12 4EH",
        "日期": "2012-12-19 12:00:00 +05:30",
        "总金额": 0.0000,
        "Id": 67290,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 65436,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "fg45",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "BRIA01      ",
        "CustomerId": 6657,
        "顾客姓名": "Brian Hayes, 2541",
        "日期": "2013-02-07 12:00:00 +05:30",
        "总金额": 0.0000,
        "Id": 67346,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 78565,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "TestReference",
        "抑制金额": false,
        "增值税额": 0.0000
    }],
    "MetaData": {
        "FirstPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=1&perpage=10&sortby=Number&order=Asc",
        "LastPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=3&perpage=10&sortby=Number&order=Asc",
        "NextPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=2&perpage=10&sortby=Number&order=Asc",
        "PreviousPageUrl": null,
        "TotalRecords": 29
    }
}

获取具有指定编号的特定报价的详细信息–

网址: / quotes / {number}

网址中的{number}应替换为要检索的引号。

指定的汇率“Currency”部分可以是默认货币汇率,也可以是该特定报价的用户指定的货币汇率。

获取报价的示例响应


{
    "类别": {
        "IconColor": null,
        "IconId": 0,
        "名称": null,
        "数": 0,
        "IconType": null
    },
    "货币": {
        "Code": "INR",
        "ExchangeRate": 50.0000,
        "DisplaySymbolOnRight": false,
        "名称": "Indian Rupees",
        "Symbol": "Rs"
    },
    "客户代码": "13",
    "CustomerId": 7343,
    "顾客姓名": "Jack Turner",
    "日期": "2012-03-01 12:00:00",
    "总金额": 120.0000,
    "Id": 67295,
    "LineItems": [{
        "名义代码": 1,
        "描述ription": "Adding a 3rd Line Item",
        "数": 1,
        "产品代码": "510",
        "产品名称": "Mobile",
        "数量": 10.0000,
        "货币汇率": 10.0000,
        "首页CurrencyVATAmount": 20.0000,
        "VATExempt": false,
        "增值税级别": 20.0000,
        "税法": "",
        "率":500,
        "增值税额" : 1000
    }],
    "净额": 100.0000,
    "下一页号码": 11248,
    "数": 11,
    "上一页号码": 11247,
    "项目编号": 0,
    "客户参考": "dgrsfgsrf",
    "抑制金额": false,
    "增值税额": 20.0000,
    "固定链接": "/v2/documents/quote/c4093bc7-b70c-435d-ac70-d9cd2f478a54"
}

获取分页报价清单–

网址: / quotes?page = {page}&perpage={perpage}&sortby={sortby}&order={order}&customercode = {customercode}

请求参数

名称描述ription
是要检索的页码,默认值为1。
每页要返回的记录数,默认值为10。
排序方式用于对结果进行排序的列,默认值为‘Number’。以下是按值排序的列表:
数,
分类名称,
参考,
顾客姓名,
日期,
净额
订购排序方向,默认值为‘Asc’提升。结果也可以排序‘Desc’ – descending 订购.
客户代码检索特定客户的报价。如果您不希望通过客户代码过滤报价清单,则无需指定。
如果从网址中排除了上述所有参数,则将返回按引号编号升序排列的前10个引号。

逐页检索报价的示例响应


{
    "Data": [{
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "13",
        "CustomerId": 7343,
        "顾客姓名": "Jack Turner",
        "日期": "2012-03-01 12:00:00",
        "ExchangeRate": 0,
        "总金额": 120.0000,
        "Id": 67295,
        "LineItems": null,
        "净额": 100.0000,
        "下一页号码": null,
        "数": 11,
        "PreviouseNumber": null,
        "项目编号": 0,
        "客户参考": "dgrsfgsrf",
        "抑制金额": false,
        "增值税额": 20.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "13",
        "CustomerId": 7343,
        "顾客姓名": "Jack Turner",
        "日期": "2012-10-09 12:00:00",
        "ExchangeRate": 0,
        "总金额": 240.0000,
        "Id": 67311,
        "LineItems": null,
        "净额": 200.0000,
        "下一页号码": null,
        "数": 67,
        "PreviouseNumber": null,
        "项目编号": 0,
        "客户参考": "dgrsfgsrf",
        "抑制金额": false,
        "增值税额": 40.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-08-17 12:00:00",
        "ExchangeRate": 0,
        "总金额": 264.4600,
        "Id": 67045,
        "LineItems": null,
        "净额": 212.8800,
        "下一页号码": null,
        "数": 138,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "This is a 引用",
        "抑制金额": false,
        "增值税额": 51.5800
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "DJNF01",
        "CustomerId": 6673,
        "顾客姓名": "djnfc",
        "日期": "2012-03-22 12:00:00",
        "ExchangeRate": 0,
        "总金额": 120.0000,
        "Id": 67055,
        "LineItems": null,
        "净额": 100.0000,
        "下一页号码": null,
        "数": 145,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "This is a 引用",
        "抑制金额": false,
        "增值税额": 20.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-09-04 12:00:00",
        "ExchangeRate": 0,
        "总金额": 0.0000,
        "Id": 67060,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 148,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-09-05 12:00:00",
        "ExchangeRate": 0,
        "总金额": 0.0000,
        "Id": 67061,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 149,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-09-05 12:00:00",
        "ExchangeRate": 0,
        "总金额": 0.0000,
        "Id": 67062,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 150,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-09-05 12:00:00",
        "ExchangeRate": 0,
        "总金额": 0.0000,
        "Id": 67063,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 151,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "THUN01",
        "CustomerId": 7538,
        "顾客姓名": "Thunderbird",
        "日期": "2012-09-05 12:00:00",
        "ExchangeRate": 0,
        "总金额": 0.0000,
        "Id": 67064,
        "LineItems": null,
        "净额": 0.0000,
        "下一页号码": null,
        "数": 152,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "This is a 引用",
        "抑制金额": false,
        "增值税额": 0.0000
    }, {
        "类别": {
            "IconColor": null,
            "IconId": 0,
            "名称": " - ",
            "数": 0,
            "IconType": null
        },
        "货币": null,
        "客户代码": "04",
        "CustomerId": 7329,
        "顾客姓名": "Jack Sparrow",
        "日期": "2012-09-05 12:00:00",
        "ExchangeRate": 0,
        "总金额": 2.4000,
        "Id": 67065,
        "LineItems": null,
        "净额": 2.0000,
        "下一页号码": null,
        "数": 153,
        "上一页号码": null,
        "项目编号": 0,
        "客户参考": "",
        "抑制金额": false,
        "增值税额": 0.4000
    }],
    "MetaData": {
        "FirstPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=1&perpage=10&sortby=Number&order=Asc",
        "LastPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=15&perpage=10&sortby=Number&order=Asc",
        "NextPageUrl": "http://securedwebapp.com/cpt_rest_api/quotes?page=2&perpage=10&sortby=Number&order=Asc",
        "PreviousPageUrl": null,
        "TotalRecords": 148
    }
}

开机自检操作


可以使用其标题详细信息创建报价。仅报价号为必填字段,其余可保留为空白。行号应设置为0。
使用以下URL用给定的报价数据创建新的报价记录–

网址: /引号

报价请求POST的示例请求


{
    "类别": {
            "数": 0,
            "IconType": "flag",
            "IconId": 0,
            "名称": " - ",
            "IconColor": "green"
    },
    "货币": {
        "Code": "GBP",
        "ExchangeRate": 50.0000,
        "DisplaySymbolOnRight": false,
        "名称": "British Pounds",
        "Symbol": "£"
    },
    "客户代码": "BRIA01",
    "CustomerId": 6657,
    "顾客姓名": "Brian Hayes",
    "日期": "2012-06-21 12:00:00 +05:30",
    "总金额": 0.2200,
    "Id": 67343,
    "LineItems": [{
        "名义代码": 1,
        "描述ription": "هذا هو نص اختبار",
        "数": 0,
        "产品代码": "",
        "数量": 3.0000,
        "货币汇率": 12,
        "首页CurrencyVATAmount": 5,
        "VATExempt": true,
        "增值税级别": 0,
        "税法": "",
        "率":600,
        "增值税额" : 250
    }],
    "净额": 0.1800,
    "下一页号码": 5675,
    "数": 9087,
    "上一页号码": 111111169,
    "项目编号": 1,
    "客户参考": "test",
    "抑制金额": false,
    "增值税额": 0.0400
}

PUT操作

使用以下URL更新指定报价编号的报价详细信息–

网址: / quotes / {number}

网址中的{number}应替换为要更新的引号。要更新报价详细信息,您需要提供整个报价对象(类似于GET报价响应),并且仅更新必需的元素。报价单号是必填字段,如果在url和请求正文中传递的编号不同,则报价单号将在以后进行更新(前提是它是唯一的)。

要创建新的订单项,应指定数字0。
如果现有订单项未在PUT请求主体中传递,则将从数据库中删除那些订单项。
为了更改订单项的顺序,只需按照所需的顺序放置订单项即可。这也将相应地更新行号。

请求报价的示例请求


{
    "类别": {
        "数": 0,
            "IconType": "flag",
            "IconId": 0,
            "名称": " - ",
            "IconColor": "green"
    },
    "货币": {
        "Code": "",
        "ExchangeRate": 50.0000,
        "名称": "Indian Rupees",
        "Symbol": "Rs",
        "DisplaySymbolOnRight": false
    },
    "货币Name": null,
    "客户代码": "13",
    "CustomerDiscount": 0.0000,
    "顾客姓名": "Jack Turner",
    "日期": "2012-10-09 12:00:00 +05:30",
    "DefaultChargeType": 9998,
    "Ec": 0,
    "总金额": 120.0000,
    "LineItems": [{
        "ApplyTax1": false,
        "ApplyTax2": false,
        "ApplyTax3": false,
        "ApplyTax4": false,
        "ApplyTax5": false,
        "名义代码": 1,
        "描述ription": "Adding a 4rd Line Item",
        "产品代码": "",
        "数量": 10.0000,
        "货币汇率": 10.0000,
        "Tax1Amount": 0,
        "Tax2Amount": 0,
        "Tax3Amount": 0,
        "Tax4Amount": 0,
        "Tax5Amount": 0,
        "首页CurrencyVATAmount": 20.0000,
        "VATExempt": false,
        "增值税级别": 20.0000,
        "税法": "",
        "率":500,
        "增值税额":1000

    }],
    "净额": 100.0000,
    "下一页号码": 10,
    "数": 9,
    "OutSideEc": 0,
    "上一页号码": 6,
    "项目编号": 0,
    "客户参考": "dgrsfgsrf",
    "抑制金额": 0,
    "增值税额": 20.0000,
    "VATNumber": "123"
}

删除操作

删除带有URL中提供的数字的报价–

网址: / quotes / {number}

了解KashFlow如何与您的业务和书籍一起使用