인보이스 목록 조회
curl --request GET \
--url https://meterengine.com/v1/invoices \
--header 'Authorization: Bearer <token>'const url = 'https://meterengine.com/v1/invoices';
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));{
"invoices": [
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"cutoff_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"lines": [
{
"amount": 123,
"billable_metric_code": "<string>",
"billable_metric_name": "<string>",
"dimension_values": {},
"line_type": "per_unit",
"quantity": 123,
"quantity_denominator": 123,
"quantity_numerator": 123,
"target_property": "<string>",
"tier_index": 123,
"unit_price": 123
}
],
"month": "<string>",
"supply_amount": 123,
"tax_amount": 123,
"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": "공백일 수 없습니다"
}
]
}{
"code": "validation_error",
"message": "서버 내부 오류입니다",
"errors": [
{
"field": "event_type",
"message": "공백일 수 없습니다"
}
]
}인보이스
인보이스 목록 조회
확정된 인보이스를 (고객, 달)마다 한 줄씩 돌려준다. 확정 전의 금액은 청구 예정액 조회로 본다. customer_id와 month를 함께 주면 둘 다 만족하는 인보이스만 나온다. month를 생략하면 모든 달이다. 달 내림차순이고, 같은 달은 고객 이름 오름차순, 이름이 같으면 고객 id 순이다. supply_amount, tax_amount, total_amount는 확정할 때 저장한 공급가액, 세액, 합계(공급가액 + 세액)이고 원 단위 정수다. lines는 확정할 때 저장한 조합별 수량, 단가, 금액이고 미터 code 오름차순, 같은 미터 안에서는 dimension_values 오름차순이다. 조회할 때 다시 계산하지 않아 뒤에 단가를 고쳐도 바뀌지 않는다. 라인 금액의 합이 supply_amount다. cutoff_at은 확정이 읽은 이벤트의 받은 시각 상한이다. 그 달에 발생했고 이 시각 전에 받은 이벤트만 금액에 들었다. cutoff_at과 finalized_at은 KST(+09:00)로 나온다. customer_name은 확정할 때 저장한 고객 이름이라 뒤에 이름을 고쳐도 바뀌지 않는다. 페이지를 나누지 않는다.
GET
/
v1
/
invoices
인보이스 목록 조회
curl --request GET \
--url https://meterengine.com/v1/invoices \
--header 'Authorization: Bearer <token>'const url = 'https://meterengine.com/v1/invoices';
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));{
"invoices": [
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"cutoff_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"lines": [
{
"amount": 123,
"billable_metric_code": "<string>",
"billable_metric_name": "<string>",
"dimension_values": {},
"line_type": "per_unit",
"quantity": 123,
"quantity_denominator": 123,
"quantity_numerator": 123,
"target_property": "<string>",
"tier_index": 123,
"unit_price": 123
}
],
"month": "<string>",
"supply_amount": 123,
"tax_amount": 123,
"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": "공백일 수 없습니다"
}
]
}{
"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). 생략하면 모든 달이다.
응답
인보이스 목록. 조건에 맞는 것이 없으면 invoices가 빈 배열이다
Show child attributes
Show child attributes