Divisions

Base URL: https://customer-api.debitura.com
Authentication: API key in the XApiKey header

List divisions for the authenticated creditor.

GET/divisions

Returns a paginated list of divisions for the authenticated creditor.

By default, archived divisions are excluded. Set includeArchived=true to include them.

Query parameters

pageinteger
pageSizeinteger
includeArchivedboolean

Returns

200 List of divisions

pageobjectRequired
Stable v1 pagination metadata shared by public list responses.
divisionsarray of objectsnullable

GET/divisions

curl https://customer-api.debitura.com/divisions \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

{
  "page": {
    "totalResults": 42,
    "pageSize": 25,
    "currentPage": 1,
    "responseCount": 42,
    "totalPages": 1
  },
  "divisions": [
    {
      "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "companyName": "Muster GmbH",
      "registrationNumber": "DE123456789",
      "address": "Friedrichstraße 68",
      "zipCode": "10115",
      "state": "string",
      "city": "Berlin",
      "country": {
        "id": 3,
        "name": "Muster GmbH",
        "alpha2": "string"
      },
      "officeEmail": "finance@example.com",
      "officePhone": "+49 30 1234567",
      "isArchived": true,
      "createdUtc": "2026-10-01T14:05:00Z",
      "updatedUtc": "2026-10-01T14:05:00Z"
    }
  ]
}

Create a new division.

POST/divisions

Creates a new division for the authenticated creditor.

Divisions allow creditors to organize cases under different business units, branches, or departments.

Required Fields:

companyName - Name of the division
city - City where the division is located
countryCode - ISO 3166-1 alpha-2 country code (e.g. 'US', 'DE', 'DK')

Optional Fields:

registrationNumber - Company registration number (CVR, VAT, etc.)
address, zipCode, state - Full address details
officeEmail, officePhone - Contact information

Headers

Idempotency-Keystring
Optional non-empty, non-whitespace idempotency key (max 255 characters) for safely retrying this request. If a previous request used the same key with an identical body, the original terminal response is replayed verbatim. Reusing the key with a different body returns 422 with businessErrors[0].type: "IdempotencyConflict". Field-level 400 validation errors are not stored, so you may fix the request and retry with the same key.
Max 255 characters

Request body

companyNamestringRequired
Max 200 characters
registrationNumberstringnullable
Max 50 characters
addressstringnullable
zipCodestringnullable
Max 50 characters
statestringnullable
citystringRequired
countryCodestringRequired
2–2 characters
officeEmailstringnullable
Max 250 characters · Email address
officePhonestringnullable
Max 50 characters

Returns

201 Division created successfully

iduuid
companyNamestringnullable
registrationNumberstringnullable
addressstringnullable
zipCodestringnullable
statestringnullable
citystringnullable
countryobject
officeEmailstringnullable
officePhonestringnullable
isArchivedboolean
createdUtcdatetime
updatedUtcdatetimenullable

Errors

`400`	Invalid request
`422`	Business rule violation

See Error handling.

POST/divisions

curl -X POST https://customer-api.debitura.com/divisions \
  -H "XApiKey: $DEBITURA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Muster GmbH",
    "city": "Berlin",
    "countryCode": "DE"
  }'

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "registrationNumber": "DE123456789",
  "address": "Friedrichstraße 68",
  "zipCode": "10115",
  "state": "string",
  "city": "Berlin",
  "country": {
    "id": 3,
    "name": "Muster GmbH",
    "alpha2": "string"
  },
  "officeEmail": "finance@example.com",
  "officePhone": "+49 30 1234567",
  "isArchived": true,
  "createdUtc": "2026-10-01T14:05:00Z",
  "updatedUtc": "2026-10-01T14:05:00Z"
}

Get a single division by ID.

GET/divisions/{id}

Returns details of a specific division. The division must belong to the authenticated creditor.

Path parameters

iduuidRequired

Returns

200 Division found

iduuid
companyNamestringnullable
registrationNumberstringnullable
addressstringnullable
zipCodestringnullable
statestringnullable
citystringnullable
countryobject
officeEmailstringnullable
officePhonestringnullable
isArchivedboolean
createdUtcdatetime
updatedUtcdatetimenullable

Errors

404 Division not found

See Error handling.

GET/divisions/{id}

curl https://customer-api.debitura.com/divisions/3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31 \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "registrationNumber": "DE123456789",
  "address": "Friedrichstraße 68",
  "zipCode": "10115",
  "state": "string",
  "city": "Berlin",
  "country": {
    "id": 3,
    "name": "Muster GmbH",
    "alpha2": "string"
  },
  "officeEmail": "finance@example.com",
  "officePhone": "+49 30 1234567",
  "isArchived": true,
  "createdUtc": "2026-10-01T14:05:00Z",
  "updatedUtc": "2026-10-01T14:05:00Z"
}

Update a division.

PUT/divisions/{id}

Replaces all fields of a division. All required fields must be provided.

Required Fields:

companyName - Name of the division
city - City where the division is located
countryCode - ISO 3166-1 alpha-2 country code (e.g. 'US', 'DE', 'DK')

Path parameters

iduuidRequired

Request body

companyNamestringRequired
Max 200 characters
registrationNumberstringnullable
Max 50 characters
addressstringnullable
zipCodestringnullable
Max 50 characters
statestringnullable
citystringRequired
countryCodestringRequired
2–2 characters
officeEmailstringnullable
Max 250 characters · Email address
officePhonestringnullable
Max 50 characters

Returns

200 Division updated successfully

iduuid
companyNamestringnullable
registrationNumberstringnullable
addressstringnullable
zipCodestringnullable
statestringnullable
citystringnullable
countryobject
officeEmailstringnullable
officePhonestringnullable
isArchivedboolean
createdUtcdatetime
updatedUtcdatetimenullable

Errors

`400`	Invalid request
`404`	Division not found

See Error handling.

PUT/divisions/{id}

curl -X PUT https://customer-api.debitura.com/divisions/3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31 \
  -H "XApiKey: $DEBITURA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Muster GmbH",
    "city": "Berlin",
    "countryCode": "DE"
  }'

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "registrationNumber": "DE123456789",
  "address": "Friedrichstraße 68",
  "zipCode": "10115",
  "state": "string",
  "city": "Berlin",
  "country": {
    "id": 3,
    "name": "Muster GmbH",
    "alpha2": "string"
  },
  "officeEmail": "finance@example.com",
  "officePhone": "+49 30 1234567",
  "isArchived": true,
  "createdUtc": "2026-10-01T14:05:00Z",
  "updatedUtc": "2026-10-01T14:05:00Z"
}

Delete a division.

DELETE/divisions/{id}

Deletes a division.

Important: A division cannot be deleted if it is referenced by active cases. If you need to deactivate a division that has cases, use the archive endpoint instead.

Path parameters

iduuidRequired

Returns

204 Division deleted successfully — no response body.

Errors

`404`	Division not found
`422`	Division cannot be deleted because it has active cases

See Error handling.

DELETE/divisions/{id}

curl -X DELETE https://customer-api.debitura.com/divisions/3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31 \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

204 Division deleted successfully. No response body.

Archive a division.

POST/divisions/{id}/archive

Archives a division, making it inactive. Archived divisions are excluded from list results by default.

Important: This action is irreversible. Archived divisions can still be referenced by existing cases.

Path parameters

iduuidRequired

Returns

200 Division archived successfully

iduuid
companyNamestringnullable
registrationNumberstringnullable
addressstringnullable
zipCodestringnullable
statestringnullable
citystringnullable
countryobject
officeEmailstringnullable
officePhonestringnullable
isArchivedboolean
createdUtcdatetime
updatedUtcdatetimenullable

Errors

`404`	Division not found
`422`	Division is already archived

See Error handling.

POST/divisions/{id}/archive

curl -X POST https://customer-api.debitura.com/divisions/3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31/archive \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "registrationNumber": "DE123456789",
  "address": "Friedrichstraße 68",
  "zipCode": "10115",
  "state": "string",
  "city": "Berlin",
  "country": {
    "id": 3,
    "name": "Muster GmbH",
    "alpha2": "string"
  },
  "officeEmail": "finance@example.com",
  "officePhone": "+49 30 1234567",
  "isArchived": true,
  "createdUtc": "2026-10-01T14:05:00Z",
  "updatedUtc": "2026-10-01T14:05:00Z"
}

Archive a division.

POST/divisions/{id}:archive

Archives a division, making it inactive. Archived divisions are excluded from list results by default.

Important: This action is irreversible. Archived divisions can still be referenced by existing cases.

Path parameters

iduuidRequired

Returns

200 Division archived successfully

iduuid
companyNamestringnullable
registrationNumberstringnullable
addressstringnullable
zipCodestringnullable
statestringnullable
citystringnullable
countryobject
officeEmailstringnullable
officePhonestringnullable
isArchivedboolean
createdUtcdatetime
updatedUtcdatetimenullable

Errors

`404`	Division not found
`422`	Division is already archived

See Error handling.

POST/divisions/{id}:archive

curl -X POST https://customer-api.debitura.com/divisions/3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31:archive \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "registrationNumber": "DE123456789",
  "address": "Friedrichstraße 68",
  "zipCode": "10115",
  "state": "string",
  "city": "Berlin",
  "country": {
    "id": 3,
    "name": "Muster GmbH",
    "alpha2": "string"
  },
  "officeEmail": "finance@example.com",
  "officePhone": "+49 30 1234567",
  "isArchived": true,
  "createdUtc": "2026-10-01T14:05:00Z",
  "updatedUtc": "2026-10-01T14:05:00Z"
}