curl --request GET \
--url https://meterengine.com/v1/invoices/draft \
--header 'Authorization: Bearer <token>'const url = 'https://meterengine.com/v1/invoices/draft';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"auto_finalize_at": "2023-11-07T05:31:56Z",
"auto_finalize_enabled": true,
"auto_finalize_running": true,
"calculated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"amount": 123,
"auto_finalize_held": true,
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"lines": [
{
"amount": 123,
"billable_metric_code": "<string>",
"dimension_values": {},
"line_type": "per_unit",
"quantity": 123,
"quantity_denominator": 123,
"quantity_numerator": 123,
"target_property": "<string>",
"tier_index": 123,
"unit_price": 123
}
],
"negative_usages": [
{
"billable_metric_code": "<string>",
"dimension_values": {},
"quantity": 123,
"target_property": "<string>"
}
],
"unpriced_usages": [
{
"billable_metric_code": "<string>",
"dimension_values": {},
"quantity": 123,
"target_property": "<string>"
}
]
}
],
"month": "<string>",
"total_amount": 123
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}청구 예정액 조회
아직 확정하지 않은 고객의 청구 예정액을 미터의 속성 값 조합별 사용량 x 그 조합의 단가로 계산해 돌려준다. 그 달이 확정된 고객은 나오지 않고 total_amount는 남은 고객의 합이다. 확정된 금액은 인보이스 목록 조회로 본다. 조회할 때마다 계산하며 저장하지 않는다. 기간은 KST 기준의 달이다. 그 달 이벤트 중 집계 마감 시각(다음 달 1일 13:00 KST) 전에 서버가 받은(received_at) 것만 집계한다. 마감 뒤에 받은 그 달 이벤트는 저장되지만 집계와 청구에 들지 않는다. 금액은 원 단위 정수다. 라인(고객 x 미터 x 조합)마다 10원 미만을 버린 뒤 합산한다. 10원이 안 되는 라인은 0원이다. 라인은 사용량이 있는 조합 가운데 같은 dimension_values의 단가가 있는 것만 나온다. 이벤트가 없는 고객은 lines가 빈 배열이다. 단가가 없는 조합은 라인과 금액에서 빠지고, 수량이 0이 아니면 그 고객의 unpriced_usages에 미터 code, target_property, 조합, 수량으로 나온다. 순서는 라인과 같다. 고객은 이름 오름차순, 라인은 미터 code 오름차순, 같은 미터 안에서는 dimension_values 오름차순이다.
curl --request GET \
--url https://meterengine.com/v1/invoices/draft \
--header 'Authorization: Bearer <token>'const url = 'https://meterengine.com/v1/invoices/draft';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"auto_finalize_at": "2023-11-07T05:31:56Z",
"auto_finalize_enabled": true,
"auto_finalize_running": true,
"calculated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"amount": 123,
"auto_finalize_held": true,
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"lines": [
{
"amount": 123,
"billable_metric_code": "<string>",
"dimension_values": {},
"line_type": "per_unit",
"quantity": 123,
"quantity_denominator": 123,
"quantity_numerator": 123,
"target_property": "<string>",
"tier_index": 123,
"unit_price": 123
}
],
"negative_usages": [
{
"billable_metric_code": "<string>",
"dimension_values": {},
"quantity": 123,
"target_property": "<string>"
}
],
"unpriced_usages": [
{
"billable_metric_code": "<string>",
"dimension_values": {},
"quantity": 123,
"target_property": "<string>"
}
]
}
],
"month": "<string>",
"total_amount": 123
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}인증
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
쿼리 매개변수
집계할 달(yyyy-MM, KST). 생략하면 이번 달이다.
응답
고객별 청구 예정액. 단가가 있는 조합의 사용량이 없는 고객은 lines가 빈 배열이다. 모든 고객이 확정됐으면 customers가 빈 배열이고 total_amount가 0이다
이 달을 다음에 자동 확정하는 시각(KST). 그 달의 확정 시각(다음 달 1일 14:00) 전이면 그 시각이다. 지났으면 요청한 환경에서 아직 다 훑지 않았거나 마지막 시도가 실패인 고객이 있을 때만 다음 정시고, 다 훑었고 실패도 없거나 첫 고객 등록 전의 달이면 null이다. 단가 없는 사용량으로 보류된 고객은 지난달 단가를 등록할 수 없어 다시 시도하지 않으므로 수동 확정으로 끝낸다. 꺼져 있으면 null
인보이스 자동 확정이 켜져 있으면 true
자동 확정이 지금 돌고 있고 요청한 환경에서 확정 시각이 지난 이 달을 아직 다 훑지 않았으면 true. 이번 실행이 이 달에 닿기 전에도 true다. 다 훑은 뒤 남은 고객은 보류나 실패라 false다. 자동 확정이 꺼져 있으면 false
Show child attributes
Show child attributes