InPayment

InPayment represents inbound payment data created for Income Management features, such as invoices and receipts.

Type

General entity

Fields

Field name

Type

Writable

Required

Description

date

string

The payment date in YYYY-MM-DD format.

amount

number

The payment amount in the invoice or receipt currency.

pre_tax_amount

number

The proportional pre-tax amount out of the payment total. Also the base amount for the withheld tax.

description

string

The description for this payment. Will also be the description of the entries generated. Max 255 characters.

currency_rate

number

The payment currency to your bookkeeping currency rate. Will be filled with current rate if missing. For receipt payments, the rate from the master receipt is adopted.

payment_method

PaymentMethods

The payment method.

payment_account

AccountReference

The payment account to which the payment is made.

withholding_tax_excluded

boolean

The flag to indicate if tax is withheld from this payment.

withholding_tax

TaxReference

(when withholding_

tax_excluded is true)

The tax item withheld from the receipt payment with, if applicable. Required for reporting.

withholding_tax_amount

number

The tax amount withheld from the payment, if applicable. Automatically calculated if set to null.

invoice_id

string

(when editing invoice payments)

The ID of the invoice that this payment is made for, if applicable.

receipt_id

string

The ID of the receipt that this payment comes with, if applicable.

Sample

{
"date_created": 1567512092697,
"date_updated": 1567512224913,
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"date": "2019-08-01",
"amount": 120,
"pre_tax_amount": 112.15,
"currency_rate": 1.000000,
"description": "Payment for Invoice #INV00000025 (modified)",
"payment_method": "TRANSFER",
"payment_account": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "1101",
"name": "Cash on hand",
"type": "ASSET_CURRENT",
"_id": "810964a1-f5f1-49bb-a56c-b61c0d627b0f"
},
"withholding_tax_excluded": true,
"withholding_tax": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "WTH-3",
"name": "Withholding Tax ภาษีหัก ณ ที่จ่าย(3%)",
"description": null,
"latest_rate": 0.03000,
"_id": "b704e72a-5f00-4357-9c00-351decb15d4c"
},
"withholding_tax_amount": 3.36,
"invoice_id": "d94312d9-4f3d-44d7-b0e2-f73d0bd4b646",
"receipt_id": null,
"_id": "2b45816b-fad8-4379-b781-f00e556a0276",
"_links": {
"self": {
"href": "https://api.pymlo.com/v1/businesses/a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1/income/payments/2b45816b-fad8-4379-b781-f00e556a0276"
},
"invoice": {
"href": "https://api.pymlo.com/v1/businesses/a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1/income/invoices/d94312d9-4f3d-44d7-b0e2-f73d0bd4b646"
}
}
}