Atlas API发票 listInvoices

--envelope

envelope

false

指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。

--fromDate

字符串

false

检索 startDate 大于或等于 fromDate 的发票。如果省略，发票返回将回溯到最早开始日期。

-h，--help

false

listInvoices 帮助

--includeCount

false

标志，用于指示响应是否返回响应中的列项总数 (totalCount)。

--itemsPerPage

int

false

响应每页返回的列项数。

--orderBy

字符串

false

用于对返回的发票进行排序的字段。与 sortBy 参数结合使用可控制结果的顺序。

--orgId

字符串

true

唯一的 24-十六进制数字字符串，用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。

-o, --output

字符串

false

首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志

--pageNum

int

false

显示响应返回的当前总对象集的页面编号。

--pretty

false

指示响应正文是否应采用 prettyprint 格式的标记。

--sortBy

字符串

false

用于对返回的发票进行排序的字段。与 orderBy 参数结合使用可控制结果的顺序。

--statusNames

字符串数组

false

要检索的发票的状态。省略返回所有状态的发票。

--toDate

字符串

false

检索 endDates 小于或等于 toDate 的发票。 如果省略，发票返回将进一步到最晚结束日期。

--version

字符串

false

进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。

--viewLinkedInvoices

false

指示是否在 linkedInvoices 字段中返回链接发票的标志。