Business partners

Finds business partners matching search criteria.

Returns basic information: register id, name, billing address, id, customer no, partner type, active/inactive.

This endpoint supports name and identifier parameters in HTTP header.

get/businesspartners

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/businesspartners
  • Auth: HTTP bearer

Query parameters

identifierTypestring

Business identifier type of the partner

customerNumberstring

Customer number

mainGroupstring

Main group

partnerGroupstring

Business Partner Group

type'CUSTOMER' | 'SUPPLIER' | 'PERSON'

Type of business partner

orderById'ASC' | 'DESC'

Order the results by invoice ID

previousIdinteger

Previous invoice ID for pagination

activeboolean

Status of business partner

versionStartDatestring date-time

Start date of the search (business partner updated date)

versionEndDatestring date-time

End date of the search (business partner updated date)

sizeinteger

Page size for the results. Maximum value: 200.

pageinteger

Page number for the results

Headers

namestring

Name of business partner matched by substring.

identifierstring

Business identifier of the partner.

Response

Invoices were successfully found.

Example response

{
  "results": [
    {
      "billingAddress": {
        "country": "SWEDEN"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.