Atlas API 청구서 목록Invoices

envelope

거짓

애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

문자열

거짓

startDates가 fromDate보다 크거나 같은 청구서를 조회합니다. 생략하면 청구서 반환이 가장 이른 startDate로 돌아갑니다.

거짓

listInvoices 도움말

거짓

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

int

거짓

페이지당 응답이 반환하는 항목 수입니다.

문자열

거짓

반환된 인보이스를 주문하는 데 사용되는 필드입니다. sortBy 매개변수와 함께 사용하여 결과의 순서를 제어할 수 있습니다.

문자열

true

프로젝트가 포함된 조직 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 조직을 조회 하려면 [/orgs](# 태그를 지정하다 /Organizations/operation/listOrganizations) 엔드포인트를 사용하세요.

문자열

거짓

기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다.

문자열

거짓

API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다.

int

거짓

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

거짓

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

문자열

거짓

반환된 인보이스를 정렬하는 데 사용되는 필드입니다. orderBy 매개변수와 함께 사용하면 결과의 순서를 제어할 수 있습니다.

문자열 배열

거짓

조회할 청구서의 상태입니다. 생략하면 모든 상태의 청구서를 반환합니다.

문자열

거짓

endDates가 toDate보다 작거나 같은 인보이스를 검색합니다. 생략하면 반환되는 인보이스는 최신 endDate까지 확장됩니다.

문자열

거짓

API 호출 시 사용할 API 버전 [옵션: "2023-01-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-01-01".

거짓

LinkedInvoices 필드에 연결된 청구서를 반환할지 여부를 나타내는 플래그입니다.