Receipt

Receipt represents the receipt data issued to your customers from the system.

Type

General entity

Fields

Field name

Type

Writable

Required

Description

date

string

The issue date in YYYY-MM-DD format.

receipt_no

string

The unique receipt number.

status

ReceiptStatus

The status.

ref_no

string

The related document number for reference.

memo

string

The additional memo for the recipient.

currency_code

string

The currency of this receipt depicted by code.

currency_rate

number

The currency rate upon the payment. Leave it null to adopt the system rate.

inclusive_tax

boolean

The flag to indicate if the taxes are inclusive in this receipt.

tax_invoice

boolean

The flag to indicate if this receipt is a tax invoice for filing.

customer

PartnerReference

(only if you need to send the receipt)

The customer, or recipient, of this receipt.

address_line1

string

The first line of billing address.

address_line2

string

The second of billing address.

payment_account

AccountReference

The payment account to which the payment is made.

payment_method

PaymentMethods

The payment method.

withholding_tax_excluded

boolean

The flag to indicate if tax is withheld for this receipt.

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

(when withholding_

tax_excluded is true)

The tax amount withheld, if applicable.

discount

number

The discount amount in percentage. Eg. 10 for 10% off.

sub_total

number

The sub total in the receipt currency.

tax_total

number

The total tax amount in the receipt currency.

total

number

The total amount, with tax and discount considered, in the receipt currency.

total_in_booking_currency

number

The converted total amount in the bookkeeping currency.

lines

ReceiptLine []

The line items of this receipt.

The total amount fields are derived from the line items and related payment data, thus not directly writable.

Sample

{
"date_created": 1548657135934,
"date_updated": null,
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"date": "2019-10-28",
"memo": null,
"currency_code": "MKD",
"inclusive_tax": false,
"sub_total": 2776.00000,
"tax_total": 160.72,
"total": 2936.72,
"discount": null,
"currency_rate": 0.621987,
"total_in_booking_currency": 1826.60,
"receipt_no": "RCT557627",
"ref_no": null,
"customer": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "L-HSP-001-12",
"name": "Best Partner Co. Ltd.",
"email": null,
"contact_name": null,
"note": null,
"_id": "b9fd79a4-cace-4b87-be6b-454b385ff829"
},
"address_line1": "",
"address_line2": "",
"tax_invoice": false,
"payment_account": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "3002",
"name": "Owner's Investment/Drawing",
"type": "EQUITY",
"_id": "02f22daa-b52a-428f-9f25-e9dadfda88b0"
},
"payment_method": "TRANSFER",
"withholding_tax_excluded": false,
"withholding_tax": null,
"withholding_tax_amount": null,
"status": "PAID",
"lines": [
{
"date_created": 1548657135934,
"date_updated": null,
"product": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": null,
"name": "Latte",
"description": "",
"uom": null,
"_id": "bfc0c2e1-d06e-45cd-9217-6736d980b045"
},
"quantity": 8.00000,
"description": null,
"tax": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "VAT-0",
"name": "Value added tax (0%)",
"description": null,
"latest_rate": 0.00000,
"_id": "61c59f84-4405-48a3-abc4-f0693bb33dd7"
},
"unit_price": 60.00000,
"line_amount": 480.00000,
"tax_amount": 0.00000,
"total_amount": 480.00000,
"account": null,
"_id": "821928e2-3a6b-4e82-9e16-a44a6147162d"
},
{
"date_created": 1548657135934,
"date_updated": null,
"product": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": null,
"name": "Orange Pastry",
"description": "isleacctasany",
"uom": null,
"_id": "5bcee6d3-14b2-4968-8494-d04e6df0c94c"
},
"quantity": 1.00000,
"description": null,
"tax": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "VAT-7",
"name": "Value Added Tax (7%)",
"description": null,
"latest_rate": 0.07000,
"_id": "989bcfad-b710-493e-aca6-22f9554ca07e"
},
"unit_price": 796.00000,
"line_amount": 796.00000,
"tax_amount": 55.72000,
"total_amount": 851.72000,
"account": null,
"_id": "1adada33-1af7-46ef-a82e-df95ff30554d"
},
{
"date_created": 1548657135934,
"date_updated": null,
"product": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": null,
"name": "Delivery",
"description": null,
"uom": null,
"_id": "fd9c1609-7c86-42a5-b416-39a79b403f19"
},
"quantity": 5.00000,
"description": null,
"tax": {
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "VAT-7",
"name": "Value Added Tax (7%)",
"description": null,
"latest_rate": 0.07000,
"_id": "989bcfad-b710-493e-aca6-22f9554ca07e"
},
"unit_price": 300.00000,
"line_amount": 1500.00000,
"tax_amount": 105.00000,
"total_amount": 1605.00000,
"account": null,
"_id": "33ca052e-b372-420f-8eae-4ced85aa3c58"
}
],
"_id": "abcf54f7-10b5-4bde-bbf8-ed2587967cb5",
"_links": {
"self": {
"href": "https://api.pymlo.com/v1/businesses/a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1/income/receipts/abcf54f7-10b5-4bde-bbf8-ed2587967cb5"
}
}
}