财政日历用于报告和预算。只要结束日期在开始日期之后,财团年度可以在任何日期开始和结束,并且不超过两年。财政年度无法重叠。财政期间无法重叠,仅限于每份财政年度的24个。

全部财政年度

检索所有财政年度的清单

  • 使用LastModifiedAfter.参数如果您希望只检索在特定日期后的财政年度。
  • 使用includeremoved参数如果要检索所有财务年份,包括那些已被删除的费用。重要提示:无法返回超出配置保留期的删除数据。

范围

此API调用需要以下示波器之一:

  • BudgetItem.read.- 请参阅范围使用有关详细信息。
  • BudgetItem.write.- 请参阅范围使用有关详细信息。
  • fiscalyear.read.- 请参阅范围使用有关详细信息。
  • fiscalyear.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
获取/预算/ v4 / fiscalyear

参数

名称 类型 格式 描述
LastModifiedAfter. 约会时间 yyyy-mm-ddthh:mm:ss 如果您只希望在提供的日期后更改的财政年度,请使用此字段。提供的日期将在UTC时区解释。如果LastModifiedAfter.没有提供,服务将返回所有财政年度,无论修改日期如何。例子:2016-03-29T16:12:20
includeremoved 布尔基 询问 如果真的,该服务将返回所有财政年度,包括先前删除的财团。如果没有提供,此字段默认为错误的

标题

回复

状态代码

标题

响应标题

有效载荷

财政年度

例子

要求

获取https://us.api.concursolutions.com/budget/v4/fiscalyear?lastmodifiedAfter=2017-02-27T12:30:00授权:持票人{令牌}内容类型:应用程序/ JSON

回复

http./1.1200.缓存控制max-age = 604800内容类型应用/ JSON.日期星期三,06年7月2020年7月17:33:03 GMTEtag.“359670651”到期星期三,2012年7月13日17:33:03 GMT上一次更改星期五,09年8月20日23:54:35 GMT内容长度2187.同意相关性FFA4AE0A-F65C-4037-8BFB-8996C3FCA28C
[{“名称”“2017”“开始日期”“2017-01-01”“结束日期”“2017-12-31”“地位”“打开”“ID”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“上一次更改”“2017-03-26 20:53:19”“今年”错误的“每月担心”:[{“名称”“2017  -  8月”“fiscalperiodstatus”“打开”“ID”“A4E94128-C7B7-4561-A57E-1512E59E4896”“赛季”“每月”“开始日期”“2017-08-01”“结束日期”“2017-08-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“名称”“2017  -  1月”“fiscalperiodstatus”“关闭”“ID”“AB2810F5-F045-45B0-B2B2-8E84BC978E27”“赛季”“每月”“开始日期”“2017-01-01”“结束日期”“2017-01-30”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“额外的财政期间为简洁而删除”“额外的财政期间为简洁而删除”}],“季度季度季度奇数”:[{“名称”“2017  -  Q4”“fiscalperiodstatus”“打开”“ID”“655FFE9D-CACA-4F2F-A4A1-E04CFB68FD6E”“赛季”“季刊”“开始日期”“2017-10-01”“结束日期”“2017-12-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“额外的财政期间为简洁而删除”“额外的财政期间为简洁而删除”}],“年度菲尼思亚偶极”:[{“名称”“2017”“fiscalperiodstatus”“打开”“ID”“2FB8EA93-172A-47A6-9611-44EB75AD547B”“赛季”“每年”“开始日期”“2017-01-01”“结束日期”“2017-12-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的}],“customfiscalperiods”:[]}]

财政年度

按ID检索单一的财政年度。

范围

此API调用需要以下示波器之一:

  • BudgetItem.read.- 请参阅范围使用有关详细信息。
  • BudgetItem.write.- 请参阅范围使用有关详细信息。
  • fiscalyear.read.- 请参阅范围使用有关详细信息。
  • fiscalyear.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
获取/预算/ V4 / Fiscalyear /{ID}

参数

名称 类型 格式 描述
ID 细绳 uuid. 财政年度的关键领域。

标题

回复

状态代码

标题

响应标题

有效载荷

财政年度

例子

要求

获取https://us.api.concursolutions.com/budget/v4/fiscalyear/5e58b9b1-fed6-4d36-a5a1-a1ed325931d4授权:​​持票人{token}

回复

http./1.1200.缓存控制max-age = 604800内容类型应用/ JSON.日期星期三,06年7月2020年7月17:33:03 GMTEtag.“359670651”到期星期三,2012年7月13日17:33:03 GMT上一次更改星期五,09年8月20日23:54:35 GMT内容长度1270.同意相关性39216840-2808-4C49-8874-4C49-8874-E9862D96FDB6
{“名称”“2017”“开始日期”“2017-01-01”“结束日期”“2017-12-31”“地位”“打开”“ID”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“上一次更改”“2017-03-26 20:53:19”“今年”错误的“每月担心”:[{“名称”“2017  -  8月”“fiscalperiodstatus”“打开”“ID”“A4E94128-C7B7-4561-A57E-1512E59E4896”“赛季”“每月”“开始日期”“2017-08-01”“结束日期”“2017-08-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“名称”“2017  -  1月”“fiscalperiodstatus”“关闭”“ID”“AB2810F5-F045-45B0-B2B2-8E84BC978E27”“赛季”“每月”“开始日期”“2017-01-01”“结束日期”“2017-01-30”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“额外的财政期间为简洁而删除”“额外的财政期间为简洁而删除”}],“季度季度季度奇数”:[{“名称”“2017  -  Q4”“fiscalperiodstatus”“打开”“ID”“655FFE9D-CACA-4F2F-A4A1-E04CFB68FD6E”“赛季”“季刊”“开始日期”“2017-10-01”“结束日期”“2017-12-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的},{“额外的财政期间为简洁而删除”“额外的财政期间为简洁而删除”}],“年度菲尼思亚偶极”:[{“名称”“2017”“fiscalperiodstatus”“打开”“ID”“2FB8EA93-172A-47A6-9611-44EB75AD547B”“赛季”“每年”“开始日期”“2017-01-01”“结束日期”“2017-12-31”“浮动”无效的“fiscalyearid”“5E58B9B1-FED6-4D36-A5A1-A1ED325931D4”“现时阶段”错误的}],“customfiscalperiods”:[],“显示名称”“2017年 - 特殊”}

财政年度

创建或更新一个或多个财政年度的列表。

  • 可能为未来或过去创造的财政年期
  • 除非需要这样做,否则客户应仅在创建/更新财政年度时指定每月财政期间。该系统将自动生成季度和年度财政期间。

范围

此API调用需要以下示波器之一:

  • BudgetItem.write.- 请参阅范围使用有关详细信息。
  • fiscalyear.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
发布/预算/ V4 / BudgetCategory

参数

N / A.

标题

有效载荷

财政年度

回复

状态代码

  • 200 OK.成功呼叫,响应在身体中。
  • 400个糟糕的要求该请求被确定为服务器无效。可能在有效载荷中发送的数据上的验证失败。响应将在身体中有一个验证错误列表。有关示例400响应,请参阅下面。
  • 403禁止用户没有必要的权限来执行请求。
  • 404没有找到无法找到或不存在资源。
  • 500内部服务器错误响应机构中的错误消息。
  • 504网关超时响应机构中的错误消息。

标题

响应标题

有效载荷

财政年度要么错误响应

例子

要求

postps://us.api.concursolutions.com/budget/v4/fiscalyear授权:持票人{令牌}
[{“名称”“2017年 - 特殊”“开始日期”“2017-01-01”“结束日期”“2017-03-31”“地位”“打开”“每月担心”:[{“名称”“2017年 - 特别 -  Jan”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-01-01”“结束日期”“2017-01-31”},{“名称”“2017  - 特别 -  2月”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-02-01”“结束日期”“2017-02-28”},{“名称”“2017年 - 特别 -  Mar”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-03-01”“结束日期”“2017-03-31”}],“显示名称”“2017年 - 特殊”}]

回复

成功响应
http./1.1200.缓存控制max-age = 604800内容类型应用/ JSON.日期星期三,06年7月2020年7月17:33:03 GMTEtag.“359670651”到期星期三,2012年7月13日17:33:03 GMT上一次更改星期五,09年8月20日23:54:35 GMT内容长度1270.同意相关性5C00E59F-D00C-4019-8D3D-47130D8E37B4
[{“名称”“2017年 - 特殊”“开始日期”“2017-01-01”“结束日期”“2017-03-31”“地位”“打开”“ID”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“上一次更改”“2018-03-26 20:54:11”“今年”错误的“每月担心”:[{“名称”“2017年 - 特别 -  Jan”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-01-01”“结束日期”“2017-01-31”“ID”“1929D1D9-6C99-4635-9272-508364193F8F”“浮动”无效的“fiscalyearid”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“现时阶段”错误的},{“名称”“2017  - 特别 -  2月”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-02-01”“结束日期”“2017-02-28”“ID”“41AA7452-E52A-4FD6-9C8A-5B199DEADAF”“浮动”无效的“fiscalyearid”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“现时阶段”错误的},{“名称”“2017年 - 特别 -  Mar”“fiscalperiodstatus”“打开”“赛季”“每月”“开始日期”“2017-03-01”“结束日期”“2017-03-31”“ID”“6C7D0B13-96B9-4D76-A083-4D38C96144E2”“浮动”无效的“fiscalyearid”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“现时阶段”错误的}],“季度季度季度奇数”:[{“名称”“2017年 - 特殊 -  Q1”“fiscalperiodstatus”“打开”“ID”“5CE25DFD-8B2B-4FEA-91EB-F8F9AD0BB896”“赛季”“季刊”“开始日期”“2017-01-01”“结束日期”“2017-03-31”“浮动”无效的“fiscalyearid”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“现时阶段”错误的}],“年度菲尼思亚偶极”:[{“名称”“2017年 - 特殊”“fiscalperiodstatus”“打开”“ID”“A6Bede66-4F3D-412F-A620-2A073013CB2A”“赛季”“每年”“开始日期”“2017-01-01”“结束日期”“2017-03-31”“浮动”无效的“fiscalyearid”“2EDD7BD4-8F10-46E5-BF52-D553F6C7DF80”“现时阶段”错误的}],“customfiscalperiods”:[],“显示名称”“2017年 - 特殊”}]
失败响应
HTTP / 1.1 400 BAD请求缓存控制:无存储连接:关闭内容长度:338内容类型:应用程序/ JSON;Charset.=UTF-8日期:FRI,21 SEP 2018 15:27:05 GMT到期:THU,2018年9月20日15:27:05 GMT Pragma:No-Cache Concel-ContelelationID:CB061832-82EB-418E-A968-DE6B4CE370AE
{“地位”错误的“errormessagelist”[{“errortype”“错误”“错误代码”“budget.fiscal_year_sdate_error”“错误信息”“财政年度应该有一个开始日期”},{“errortype”“错误”“错误代码”“budget.fiscal_years_have_gap”“错误信息”“财政年期不应该在它们之间存在差距”}]}

删除财政年度

删除财政年度。可能无法删除正在使用的财政年度。

范围

此API调用需要以下示波器之一:

  • BudgetItem.write.- 请参阅范围使用有关详细信息。
  • fiscalyear.write.- 请参阅范围使用有关详细信息。

要求

Uri.

模板
删除/预算/ v4 / fiscalyear / {id}

参数

名称 类型 格式 描述
ID 细绳 uuid. 财政年度的关键领域。

标题

回复

状态代码

标题

响应标题

例子

要求

删除https://us.api.concursolutions.com/budget/v4/fiscalyear/a11cfc7c-967f-415f-9b30-23f8ce2dbf69授权:持票人{令牌}

回复

http./1.1200.缓存控制max-age = 604800内容类型应用/ JSON.日期星期三,06年7月2020年7月17:33:03 GMTEtag.“359670651”到期星期三,2012年7月13日17:33:03 GMT上一次更改星期五,09年8月20日23:54:35 GMT内容长度1270.同意相关性EB7CF20A-3481-45A5-808C-98B8EF7FE805

架构

财政年度

名称 类型 格式 描述
今年 布尔基 - 只读真的如果这是当前的财政年度,基于当前日期和时间,错误的否则。
开始日期 日期 yyyy-mm-dd 必需的本财政年度的开始日期。开始日期和结束日期之间的距离可能不超过两年。
结束日期 日期 yyyy-mm-dd 必需的本财政年度的结束日期。开始日期和结束日期之间的距离可能不超过两年。
名称 约会时间 - 必需的本财政年度的名称。这一实体必须是唯一的。
地位 细绳 - 必需的本财政年度的地位。支持的值:打开关闭删除了
ID 细绳 - 预算服务此对象的密钥。
上一次更改 约会时间 - 只读上次更改此对象时的UTC日期和时间。
每日担保人 大批 Fiscalperiod. 必需的本财政年度的月度财政期间列表。财政期间必须完全填补父财政年度,没有重叠。
季度季度季度 大批 Fiscalperiod. 只读本财政年度季度财政期间列表。如果未指定此参数,则根据提供的月度财政期间自动生成季度财政期间。
年度菲尼思百年 大批 Fiscalperiod. 只读本财政年度年度财政期间清单。如果未指定此参数,则会创建一段时间,填写会计年度。
customfiscalperiods. 大批 Fiscalperiod. 只读本财政年度的定制财政期间列表。自定义财政期间仅为API,不会在用户预算仪表板上显示。
OpenandclosedFiscalperiods. 大批 Fiscalperiod. 只读本财政年度所有财政期间的清单,按状态排序。
Fiscalperiods. 大批 Fiscalperiod. 只读本财政年度的所有财政期间。
显示名称 细绳 - 只读会计年度的显示名称。对于日期范围预算项,我们使用此字段显示。

Fiscalperiod.

名称 类型 格式 描述
现时阶段 布尔基 - 只读真的如果这是基于当前日期和时间的当前财政期间,错误的否则。
开始日期 日期 yyyy-mm-dd 必需的本财政期间的开始日期。必须在家庭财政年度内。
结束日期 日期 yyyy-mm-dd 必需的本财政年度的结束日期。必须在家庭财政年度内。
名称 细绳 - 必需的本财政期间的名称。这一实体必须是唯一的。
Fiscalperiodstatus. 细绳 - 必需的本财政期间的状况。支持的值:打开关闭删除了
课程 细绳 - 必需的财政期间的类型。支持的值:每月季刊每年风俗
Fiscalyearid 细绳 - 本财政期间父母财政年度的关键。
ID 细绳 - 预算服务此对象的密钥。
浮丹 日期 - 只读如果当前日期在本财政期间开始日期之后,则此字段显示当前日期。

错误响应

名称 类型 格式 描述
地位 布尔基 - 错误的如果出现错误。
artormessagelist. 大批 错误信息 检测到所有错误的列表。

错误信息

名称 类型 格式 描述
纠刊 细绳 - 警告或错误。
错误代码 细绳 - 此错误的文本代码。
错误信息 细绳 - 普通语言错误消息。

响应标题