Skip to main content
GET
/
accounting
/
suppliers
/
{contactId}
cURL
curl --request GET \
  --url https://api.maesn.dev/accounting/suppliers/{contactId} \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'
{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
    "addresses": [
      {
        "addressLine1": "Lucky street 1",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "companyName": "maesn",
    "contactType": "CONTACT_PERSON",
    "contactPersons": [
      {
        "emailAddresses": [
          {
            "email": "[email protected]",
            "type": "BUSINESS"
          }
        ],
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "number": "+49 7163307056",
            "type": "MOBILE"
          }
        ],
        "salutation": "Mr"
      }
    ],
    "documentId": "Z1248601M",
    "emailAddresses": [
      {
        "email": "[email protected]",
        "type": "BUSINESS"
      }
    ],
    "number": "1042",
    "phoneNumbers": [
      {
        "number": "+49 7163307056",
        "type": "MOBILE"
      }
    ],
    "projectId": "3",
    "updatedDate": "2018-01-01T13:00:00.000Z",
    "vatId": "DE123456789"
  }
}

​
Field support per integration

Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
updatedDate
string
If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Please note that only companies (accounts in Exact) can be retrieved and not contact persons (contacts in Exact) at the moment.’,
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
projectId
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
Ensure that the query parameter _companyId_ is correctly filled with the account ID associated with the contact. This value can be retrieved by using the GET Companies endpoint in the Authentication section. Use the returned id as the value for _companyId_.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
Support rawData: true
Supported Response Fields:
​
id
string
​
addresses
Address[]
​
companyName
string
​
contactPersons
ContactPerson[]
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
Support rawData: true
Supported Response Fields:
​
id
string
​
addresses
Address[]
​
companyName
string
​
contactType
enum
Available options: COMPANY
​
emailAddresses
EmailAddress[]
​
updatedDate
string
​
vatId
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
This endpoint is available only for the following countries: Accounting Plus: 🇨🇦, 🇬🇧, 🇮🇪
Accounting Standard: 🇬🇧, 🇮🇪
Accounting Start: 🇨🇦, 🇬🇧, 🇮🇪
When handling a new connection in your integration, it is advisable to first determine which subscription your customer is using to ensure compatibility. To do this, you can use the GET Companies call to retrieve all businesses available for the user. The user will then select one of these businesses. It is also a good practice to verify that the active property of the selected business is set to true before proceeding with the integration setup.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: UNDEFINED
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Companies endpoint available under the Authentication section. Please use the id field as the companyId and the environmentId field as the environmentName.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
documentId type=
​
addresses
Address[]
​
number
string
​
vatId
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
Support rawData: true
Supported Response Fields:
​
id
string
​
addresses
Address[]
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
​
vatId
string
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: COMPANY
​
companyName
string
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
number
string
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
updatedDate
string
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: CONTACT_PERSON, COMPANY
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
emailAddresses
EmailAddress[]
​
phoneNumbers
PhoneNumber[]
​
projectId
string
Xero allows up to six contact persons per company.
Support rawData: true
Supported Response Fields:
​
id
string
​
contactType
enum
Available options: UNDEFINED
​
companyName
string
​
contactPersons
ContactPerson[]
​
addresses
Address[]
​
phoneNumbers
PhoneNumber[]
​
updatedDate
string

Headers

​
X-API-KEY
string
required

API key

​
X-ACCOUNT-KEY
string
required

Account key

Path Parameters

​
contactId
string
required

Query Parameters

​
companyId
string
​
environmentName
string
​
rawData
boolean

Response

200 - application/json
​
meta
object
​
data
object