Partner

Partner represents the organizations or companies that you do business with.

Type

General entity

Fields

Field name

Type

Writable

Required

Description

code

string

The partner code. Must be unique.

name

string

The partner's organizational name to display on issued documents.

phone

string

The partner's telephone number.

fax

string

The partner's fax number.

website

string

The partner's website URL.

email

string

The partner's major contact email. Must be a valid email.

business_id

string

The partner's business registration number or identification.

tax_registration_no

string

The partner's tax payer id (TIN) to display on issued tax documents.

contact_name

string

The main contact name.

note

string

The internal remarks and notes.

customer

boolean

The flag to indicate if the partner is a customer and used in the income module.

billing_address

Address

The billing address for invoices and receipts.

billing_head_quarter

boolean

The flag to indicate if the billing address belongs to the partner's head office. Used for tax documents.

billing_site_number

string

(if billing_head_quarter is false)

The registered branch number if the billing address is not a head office. Used for tax documents.

ship_to_contact_name

string

Additional contact for shipments.

shipping_address

Address

Additional address for shipments.

vendor

boolean

The flag to indicate if the partner is a vendor and used in the expense module.

vendor_address

Address

The address to issue purchase documents to the partner.

Sample

{
"date_created": 1562642715459,
"date_updated": 1563178694733,
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "2",
"name": "12345566 1",
"phone": "9",
"fax": "10",
"website": "5",
"email": "2@oa.lc",
"business_id": "3",
"tax_registration_no": "4",
"contact_name": "7",
"note": "6",
"customer": true,
"billing_address": {
"line1": "tyrtutrutru",
"line2": "",
"city": "",
"province": "",
"country_code": null,
"postal_code": ""
},
"billing_head_quarter": true,
"billing_site_number": null,
"ship_to_contact_name": null,
"shipping_address": {
"line1": "tyrtutrutru",
"line2": "",
"city": "",
"province": "",
"country_code": null,
"postal_code": ""
},
"vendor": true,
"vendor_address": {
"line1": "",
"line2": "",
"city": "",
"province": "",
"country_code": null,
"postal_code": ""
},
"_id": "bda5ff47-2c05-4b98-99e3-04f3ab40c227",
"_links": {
"self": {
"href": "https://api.pymlo.com/v1/businesses/a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1/setting/partners/bda5ff47-2c05-4b98-99e3-04f3ab40c227"
}
}
}