Customers

Retrieve customer records for a given consent.

List customers

get

Retrieves a paginated list of customers for the specified consent.

System support

System	Status
Fortnox	✅ Supported
Bjorn Lunden	✅ Supported
Spiris	✅ Supported
Tripletex	📞 Not supported / contact us
Visma e-conomic	✅ Supported
Billy	✅ Supported
Visma Dinero	✅ Supported
Procountor	✅ Supported
Visma Netvisor	📞 Not supported / contact us
Microsoft Business Central	📞 Not supported / contact us
Exact Online	✅ Supported
QuickBooks	✅ Supported
Xero	✅ Supported
Bokio	📞 Not supported / contact us
Kleer	📞 Not supported / contact us

Authorizations

x-api-keystringRequired

Use the API key to access all API endpoints.

Path parameters

consentIdstring · uuidRequired

Identifier of the consent representing the connection to the accounting system.

Query parameters

Countinteger · int32 · min: 1 · max: 100Optional

Number of records to return per page. Range: 1-100.

CurrentPageinteger · int32 · min: 1 · max: 2147483647Optional

Page number to return. Must be 1 or greater.

Header parameters

x-correlation-idstring · uuidRequired

Unique identifier used to correlate and trace this request.

Responses

200

Returns a paginated list of customers for the specified consent.

application/json

Represents a paginated result containing metadata and a collection of items.

401

Missing or invalid authentication credentials.

application/json

403

Not authorized to access this resource.

application/json

501

This operation is not supported by the connected accounting system.

application/json

get/api/v1/consents/{consentId}/customers

GET /accounting/api/v1/consents/{consentId}/customers HTTP/1.1
Host: apione.zwapgrid.com
x-api-key: YOUR_API_KEY
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "meta": {
    "totalResources": 10,
    "totalPages": 1,
    "currentPage": 1
  },
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "supplierAssignedAccountId": {
        "id": "CUST-001",
        "schemeId": "customerId"
      },
      "type": null,
      "party": {
        "partyIdentification": [],
        "partyName": {
          "name": "Acme Corp",
          "languageId": "ENG"
        },
        "postalAddress": null,
        "partyLegalEntity": null,
        "contact": null,
        "endpointId": null
      },
      "deliveryAddresses": [],
      "description": null,
      "financialDimensions": [],
      "active": true,
      "currency": "SEK",
      "paymentMeans": [
        {
          "paymentChannelCode": "IBAN",
          "payeeFinancialAccount": "SE3550000000054910000003",
          "financialAccount": {
            "id": "SE3550000000054910000003",
            "financialInstitution": "Swedbank"
          }
        }
      ]
    }
  ]
}

Get a customer by ID

get

Retrieves a single customer by its identifier.

System support

System	Status
Fortnox	✅ Supported
Bjorn Lunden	📞 Not supported / contact us
Spiris	📞 Not supported / contact us
Tripletex	📞 Not supported / contact us
Visma e-conomic	✅ Supported
Billy	✅ Supported
Visma Dinero	✅ Supported
Procountor	📞 Not supported / contact us
Visma Netvisor	📞 Not supported / contact us
Microsoft Business Central	📞 Not supported / contact us
Exact Online	✅ Supported
QuickBooks	✅ Supported
Xero	✅ Supported
Bokio	📞 Not supported / contact us
Kleer	📞 Not supported / contact us

Authorizations

x-api-keystringRequired

Use the API key to access all API endpoints.

Path parameters

consentIdstring · uuidRequired

Identifier of the consent representing the connection to the accounting system.

customerIdstringRequired

The id of the customer you wish to retrieve.

Header parameters

x-correlation-idstring · uuidRequired

Unique identifier used to correlate and trace this request.

Responses

200

Returns the requested customer.

application/json

Represents a customer entity in the accounting system.

idstring · nullableOptional

Unique identifier for the customer.

typenull,string · enum · nullableOptional

Customer type classification (e.g. PrivatePerson, Company).

Possible values:

activeboolean · nullableOptional

Indicates whether the customer is active.

currencystring · nullableOptional

Currency code associated with the customer.

401

Missing or invalid authentication credentials.

application/json

403

Not authorized to access this resource.

application/json

404

The requested customer was not found.

application/json

501

This operation is not supported by the connected accounting system.

application/json

get/api/v1/consents/{consentId}/customers/{customerId}

GET /accounting/api/v1/consents/{consentId}/customers/{customerId} HTTP/1.1
Host: apione.zwapgrid.com
x-api-key: YOUR_API_KEY
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "supplierAssignedAccountId": {
    "id": "CUST-001",
    "schemeId": "customerId"
  },
  "type": null,
  "party": {
    "partyIdentification": [],
    "partyName": {
      "name": "Acme Corp",
      "languageId": "ENG"
    },
    "postalAddress": null,
    "partyLegalEntity": null,
    "contact": null,
    "endpointId": null
  },
  "deliveryAddresses": [],
  "description": null,
  "financialDimensions": [],
  "active": true,
  "currency": "SEK",
  "paymentMeans": [
    {
      "paymentChannelCode": "IBAN",
      "payeeFinancialAccount": "SE3550000000054910000003",
      "financialAccount": {
        "id": "SE3550000000054910000003",
        "financialInstitution": "Swedbank"
      }
    }
  ]
}