Partner API

Managing partners (customers, suppliers) — retrieval, creation and modification

Endpoints

GET Get single record
GET Get list
POST Save / create
POST Delete

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/partner/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/partner/get

Retrieve a single partner by identifier, company name or tax number, with full details (address, contacts).

Query parameters

Parameter	Type	Description
`id`	int	Unique identifier of the partner
`company_name`	string	Company name (LIKE search)
`taxcode`	string	Search by tax number
`identify`	string	Unique identifier code
`full`	int	1 = include full data (transactions, statistics)

Example request

GET /api/partner/get?id=42
X-API-KEY: {your_api_key}

GET /api/partner/list

Retrieve a paginated list of partners with filtering options.

Query parameters

Parameter	Type	Description
`list_offset`	int	Pagination offset (default: 0)
`list_count`	int	Number of records per page
`list_condition[company_name]`	string	Filter by company name (LIKE)
`list_condition[taxcode]`	string	Filter by tax number
`list_condition[bank_account]`	string	Filter by bank account number
`list_condition[company_email]`	string	Filter by e-mail address (LIKE)
`list_condition[partner_user_telephone]`	string	Filter by phone number

Example request

GET /api/partner/list?list_offset=0&list_condition[company_name]=Kft
X-API-KEY: {your_api_key}

POST /api/partner/save

Create or update a partner. For a new partner, use data[id] = 0.

POST fields — data object

Field	Type	Description
`id`	int	0 = new partner, >0 = update
`company_name`	string	Company name / partner name
`type_id`	int	Partner type identifier (customer, supplier, etc.)
`legal_entity_type_id`	int	Legal entity type
`paymod_id`	int	Default payment method identifier
`taxcode`	string	Domestic tax number
`taxcode_international`	string	Community tax number (EU VAT)
`taxcode_group`	string	Group tax number
`bank_account`	string	Bank account number
`iban`	string	IBAN bank account number
`swift`	string	SWIFT/BIC code
`registration_number`	string	Company registration number
`company_email`	string	Company e-mail address
`identify`	string	Unique identifier code — if empty, the system generates it automatically
`enolve_id`	string	External system identifier
`pay_limit`	float	Credit limit amount (default: 0)
`language_id`	int	Language identifier
`currency_out_id`	int	Currency for outgoing (issued) documents
`currency_in_id`	int	Currency for incoming documents
`tax_id`	int	Default outgoing VAT template identifier
`tax_in_id`	int	Default incoming VAT template identifier
`ledger_number_in_id`	int	Incoming ledger number identifier
`ledger_number_out_id`	int	Outgoing ledger number identifier
`commission_percent`	float	Commission percentage (default: 0)
`relationship_id`	int	Relationship type identifier
`satisfaction_id`	int	Satisfaction level identifier
`source_id`	int	Source identifier (lead origin)
`loss_reason`	string	Reason for loss
`paymod_forbidden`	object	Forbidden payment methods — key-value object (e.g. `{"1": true, "3": true}`), keys are stored as a comma-separated list
`sms_enable`	int	SMS sending enabled (0 = no, 1 = yes). Default: 0. If not provided, the existing value is left unchanged
`email_enable`	int	E-mail sending enabled (0 = no, 1 = yes). Default: 1. If not provided, the existing value is left unchanged
`address`	array	Array of address(es) (see below)
`user`	array	Array of contact(s) (see below)

Address fields — data[address][]

Field	Type	Description
`partner_address_id`	int	0 = new address, >0 = update existing address
`country_id`	int	Country identifier
`zip`	string	Postal code
`city`	string	City
`address`	string	Street, house number
`partner_address_type_id`	int	Address type identifier (billing, shipping, etc.)
`partner_address_status_id`	int	Address status identifier
`address_user_name`	string	Recipient name
`address_number`	string	House number (max 50 characters)
`address_building`	string	Building (max 50 characters)
`address_stairwell`	string	Stairwell (max 50 characters)
`address_floor`	string	Floor (max 50 characters)
`address_door`	string	Door (max 50 characters)
`district`	string	District
`address_comment`	string	Comment for the address
`remove`	int	1 = mark address for deletion

Contact fields — data[user][]

Field	Type	Description
`partner_user_id`	int	0 = new contact, >0 = update existing
`name`	string	Contact name
`email`	string	E-mail address
`telephone`	string	Phone number
`partner_user_status_id`	int	Status identifier
`invocation`	string	Salutation / title
`fax`	string	Fax number
`remove`	int	1 = mark contact for deletion

Example request

POST /api/partner/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_name": "Minta Kft.",
    "type_id": 1,
    "legal_entity_type_id": 1,
    "paymod_id": 1,
    "taxcode": "12345678-2-41",
    "taxcode_international": "HU12345678",
    "bank_account": "12345678-12345678-12345678",
    "iban": "HU42117730161111101800000000",
    "registration_number": "01-09-123456",
    "company_email": "info@minta.hu",
    "pay_limit": 500000,
    "currency_out_id": 1,
    "address": [
      {
        "partner_address_id": 0,
        "country_id": 1,
        "zip": "1234",
        "city": "Budapest",
        "address": "Fő utca 1.",
        "partner_address_type_id": 1,
        "partner_address_status_id": 1
      }
    ],
    "user": [
      {
        "partner_user_id": 0,
        "name": "Minta János",
        "email": "janos@minta.hu",
        "telephone": "+36301234567",
        "partner_user_status_id": 1,
        "invocation": "Tisztelt Uram",
        "fax": ""
      }
    ]
  }
}

POST /api/partner/delete

Delete a partner (soft delete). Only a partner with no active documents can be deleted.

POST fields — data object

Field	Type	Required	Description
`id`	int		Identifier of the partner to delete

Example request

POST /api/partner/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 42 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!