Skip to content

docs(TSK-15977): Bill paymentType in OpenAPI and webhook #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iqrahadian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(TSK-15977): Bill paymentType in OpenAPI and webhook #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/webhooks/v1/bill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down
7 changes: 7 additions & 0 deletions peakflo-v1.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down