> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inyett.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Debts for a Company (Inquiry copies will be generated if inquiries are made about a sole proprietorship) Requires debtsandcreditsbasic

> Returns only the aggregated debt picture for a company (payment remarks, notifications, historical and current claims). Requires the debtsandcreditsbasic scope. Inquiring about a sole proprietorship generates an inquiry copy to the subject, per Swedish credit information law.



## OpenAPI

````yaml https://api-test.inyett.com/swagger/v3/swagger.json post /3/{profileCountry}/debts/companies
openapi: 3.0.4
info:
  title: Inyett Automation
  description: |-
    <p>Inyett Automation is a payment control and company screening API for
                        Swedish and Norwegian businesses. It lets integrators automatically check a company's
                        status and risk before doing business with it, monitor companies over time for changes,
                        and screen outgoing payment batches for anomalies, sanctions and compliance issues before
                        the money leaves the paying customer. It is used by ERP, payment and procurement systems
                        that need this control built into their own workflows rather than as a manual step.</p><h3>How to connect</h3>
                        <p>Read more about our API and how to connect on <a href='https://docs.inyett.com/home' target='_blank'>docs.inyett.com</a></p> 
  contact:
    email: support@inyett.com
  version: '3.0'
servers: []
security:
  - X-Api-Key: []
  - Bearer: []
tags:
  - name: Inyett Company Control
    description: >-
      Risk assessment endpoints such as main rating, fraud, debt and payment
      remark checks, used to screen a company before paying it.
  - name: Inyett Company Data
    description: >-
      Company master data: addresses, accounts, owners, directors, financial
      statements and other registry information for a company.
  - name: Inyett Company Debts & Credits
    description: >-
      Aggregated debt and credit information for a company, including historical
      claims and payment remarks.
  - name: Inyett Company Find
    description: Free-text and organisation-number search for companies.
  - name: Inyett Company Insights
    description: >-
      The company relation graph: companies related to a given company, grouped
      by relation category (tag).
  - name: Inyett Company Monitor
    description: >-
      Continuous monitoring of company portfolios: create portfolios, add or
      remove companies to watch, and read back detected changes over time.
  - name: Inyett Payment Control
    description: >-
      Batch screening of outgoing payments: submit a payment batch for analysis
      and read back any warnings before the money leaves the customer.
paths:
  /3/{profileCountry}/debts/companies:
    post:
      tags:
        - Inyett Company Debts & Credits
      summary: >-
        Debts for a Company (Inquiry copies will be generated if inquiries are
        made about a sole proprietorship) Requires debtsandcreditsbasic
      description: >-
        Returns only the aggregated debt picture for a company (payment remarks,
        notifications, historical and current claims). Requires the
        debtsandcreditsbasic scope. Inquiring about a sole proprietorship
        generates an inquiry copy to the subject, per Swedish credit information
        law.
      operationId: debtsAndCreditsGetDebts
      parameters:
        - name: profileCountry
          in: path
          description: >-
            The country whose scope/entitlement profile (SE or NO) is used to
            authorize the request. Determines which market-specific rules apply,
            independent of the country the requested company is registered in.
          required: true
          schema:
            $ref: '#/components/schemas/Country'
        - name: AppId
          in: header
          description: App id
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Financial.Company'
          text/json:
            schema:
              $ref: '#/components/schemas/Financial.Company'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Financial.Company'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Debts'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
components:
  schemas:
    Country:
      enum:
        - SE
        - 'NO'
      type: string
      description: >-
        ISO country code supported for company lookups: SE (Sweden) or NO
        (Norway).
    Financial.Company:
      type: object
      properties:
        country:
          $ref: '#/components/schemas/Country'
        orgNr:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        Minimal company identity (country and organisation number) used when
        requesting financial data.
    Debts:
      type: object
      properties:
        paymentApplicationsCount:
          type: integer
          format: int32
          nullable: true
        applicationsSum:
          type: integer
          format: int32
          nullable: true
        notificationsCount:
          type: integer
          format: int32
          nullable: true
        notificationsSum:
          type: integer
          format: int32
          nullable: true
        notificationsWithAmalCount:
          type: integer
          format: int32
          nullable: true
        notificationsWithAmalSum:
          type: integer
          format: int32
          nullable: true
        notificationsWithEmalCount:
          type: integer
          format: int32
          nullable: true
        notificationsWithEmalSum:
          type: integer
          format: int32
          nullable: true
        debtSum:
          type: integer
          format: int32
          nullable: true
        latestDebtDate:
          type: string
          format: date-time
          nullable: true
        debtsWithAmalCount:
          type: integer
          format: int32
          nullable: true
        debtsWithAmalSum:
          type: integer
          format: int32
          nullable: true
        debtsWithEmalCount:
          type: integer
          format: int32
          nullable: true
        debtsWithEmalSum:
          type: integer
          format: int32
          nullable: true
        distraintAttempt:
          type: boolean
          nullable: true
        notificationsWithAmalLatestYearCount:
          type: integer
          format: int32
          nullable: true
        notificationsWithEmalLatestYearCount:
          type: integer
          format: int32
          nullable: true
        privateClaimsApplications:
          type: array
          items:
            $ref: '#/components/schemas/PrivateClaimApplication'
          nullable: true
        publicClaims:
          type: array
          items:
            $ref: '#/components/schemas/PublicClaim'
          nullable: true
        latestYearPublicClaims:
          type: array
          items:
            $ref: '#/components/schemas/PublicClaim'
          nullable: true
        privateClaims:
          type: array
          items:
            $ref: '#/components/schemas/PrivateClaim'
          nullable: true
        latestYearPrivateClaims:
          type: array
          items:
            $ref: '#/components/schemas/PrivateClaim'
          nullable: true
        historicalDebtDetails:
          type: array
          items:
            $ref: '#/components/schemas/HistoricalDebtDetail'
          nullable: true
        distraintRepossessionClaims:
          type: array
          items:
            $ref: '#/components/schemas/DistraintRepossessionClaim'
          nullable: true
      additionalProperties: false
      description: >-
        Aggregated debt information for a company: payment remarks,
        notifications, historical and current claims.
    ValidationProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: {}
      description: >-
        A machine-readable validation error response (RFC 7807 Problem Details)
        including per-field error messages.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
      description: >-
        A machine-readable error response following the RFC 7807 Problem Details
        format.
    FailResponse:
      type: object
      properties:
        message:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        Error response returned when a request fails, containing a
        human-readable message.
    PrivateClaimApplication:
      type: object
      properties:
        orgNumber:
          type: string
          nullable: true
        createdDate:
          type: string
          format: date-time
          nullable: true
        amount:
          type: integer
          format: int32
          nullable: true
        type:
          type: string
          nullable: true
        typeText:
          type: string
          nullable: true
        creditorOrgNr:
          type: string
          nullable: true
        creditorName:
          type: string
          nullable: true
        creditorForeign:
          type: boolean
          nullable: true
        comments:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        An application for a private payment claim registered against the
        company.
    PublicClaim:
      type: object
      properties:
        orgNumber:
          type: string
          nullable: true
        createdDate:
          type: string
          format: date-time
          nullable: true
        amount:
          type: integer
          format: int32
          nullable: true
        paymentNoteType:
          type: string
          nullable: true
        paymentNoteTypeText:
          type: string
          nullable: true
        term:
          type: string
          nullable: true
        comment:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        A public payment claim (e.g. from the Enforcement Authority) registered
        against the company.
    PrivateClaim:
      type: object
      properties:
        orgNumber:
          type: string
          nullable: true
        createdDate:
          type: string
          format: date-time
          nullable: true
        amount:
          type: integer
          format: int32
          nullable: true
        paymentNoteType:
          type: string
          nullable: true
        paymentNoteTypeText:
          type: string
          nullable: true
        creditorOrgNr:
          type: string
          nullable: true
        creditorName:
          type: string
          nullable: true
        creditorForeign:
          type: boolean
          nullable: true
        comments:
          type: string
          nullable: true
      additionalProperties: false
      description: A private (non-public) payment claim registered against the company.
    HistoricalDebtDetail:
      type: object
      properties:
        date:
          type: string
          format: date-time
          nullable: true
        numberPublic:
          type: integer
          format: int32
          nullable: true
        numberPrivate:
          type: integer
          format: int32
          nullable: true
        totalBalance:
          type: integer
          format: int32
          nullable: true
      additionalProperties: false
      description: >-
        A historical snapshot of the company's public and private claim counts
        and total balance for a given date.
    DistraintRepossessionClaim:
      type: object
      properties:
        orgNumber:
          type: string
          nullable: true
        createdDate:
          type: string
          format: date-time
          nullable: true
        type:
          type: string
          nullable: true
        typeText:
          type: string
          nullable: true
        comments:
          type: string
          nullable: true
      additionalProperties: false
      description: A distraint or repossession claim registered against the company.
  securitySchemes:
    X-Api-Key:
      type: apiKey
      description: 'Api key needed to access the endpoints. X-Api-Key: My api key'
      name: X-Api-Key
      in: header
    Bearer:
      type: http
      description: Please enter a valid token
      scheme: Bearer
      bearerFormat: JWT

````