From dd6a9adac69b5d57752b76909dcbeb6854e256ea Mon Sep 17 00:00:00 2001 From: Iqbal Date: Tue, 14 Apr 2026 15:42:38 +0700 Subject: [PATCH] docs(TSK-15977): document Bill paymentType in OpenAPI and webhook Made-with: Cursor --- docs/webhooks/v1/bill.md | 14 ++++++++++++++ peakflo-v1.0.yaml | 7 +++++++ 2 files changed, 21 insertions(+) diff --git a/docs/webhooks/v1/bill.md b/docs/webhooks/v1/bill.md index c7e9901..5736229 100644 --- a/docs/webhooks/v1/bill.md +++ b/docs/webhooks/v1/bill.md @@ -27,6 +27,7 @@ The BILL_STATUS_CHANGED event is triggered when the status of a bill changes. Th "subTotal": 500, "totalTax": 50, "totalWHT": 20, + "paymentType": "Payment on delivery", "paymentAmount": 530, "date": "2023-11-27T12:00:00Z", "dueDate": "2023-12-15T23:59:59Z", @@ -140,6 +141,7 @@ The BILL_STATUS_CHANGED event is triggered when the status of a bill changes. Th | totalAmount | number | The total amount including tax and other charges. | | notes | string | Additional notes or description about the bill. | | totalWHT | number | The total amount of withholding tax for the bill. | +| paymentType | string | Optional. Included only when set. 3-way matching payment classification: [Possible values](#possible-bill-payment-type-values). | | items | array | An array containing details of items listed on the bill. | | receiptDate | string | The date when the bill receipt was generated. | | updatedDate | string | The date when the bill was last update. @@ -148,6 +150,18 @@ The BILL_STATUS_CHANGED event is triggered when the status of a bill changes. Th | fakturPajakData | object | An Object containing details of bill faktur pajak (Indonesian tax invoice). | +### Possible bill payment type values + +When `paymentType` is present on a bill webhook payload, it is one of: + +```json +[ + "Advance Payment", + "Payment on delivery", + "Delivered and Billed" +] +``` + ### Possible Bill Status Values ```json diff --git a/peakflo-v1.0.yaml b/peakflo-v1.0.yaml index 110b2c5..ea17edd 100644 --- a/peakflo-v1.0.yaml +++ b/peakflo-v1.0.yaml @@ -5143,6 +5143,13 @@ components: type: number description: Total withholding tax amount example: 20 + paymentType: + type: string + nullable: true + description: | + Optional 3-way-matching payment classification. Omit, send null, or send an empty string when not used. + When set, must be one of: "Advance Payment", "Payment on delivery", "Delivered and Billed". + example: "Payment on delivery" revision_count: type: number description: Revision count shown in bill responses for supported tenants.