Payer API

openapi: 3.1.0
info:
  title: Payer API
  version: '2026-10-15'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 33 operation(s) read from 12 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Payer has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 27
    pages-with-code: 5
    pages-read: 12
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-15'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.developerhub.io/api/ref
  - https://docs.developerhub.io/api.md?operation=add-reference
  - https://docs.developerhub.io/api.md?operation=publish-reference
  - https://docs.developerhub.io/support-center/api-reference-faq.md
  - https://docs.developerhub.io/support-center/api-reference-settings.md
  - https://docs.developerhub.io/api.md?operation=read-reference-definition
  - https://docs.developerhub.io/support-center/api-key.md
  - https://docs.developerhub.io/api.md?operation=all-project
  - https://docs.developerhub.io/support-center/code-generation.md
  - https://payerdocs.developerhub.io/payer-docs/b2b-invoicing---quickstart
  - https://payerdocs.developerhub.io/payer-docs/events-api-and-subscribing-to-events
  - https://payerdocs.developerhub.io/payer-b2b/ref
servers:
- url: https://b2b.payer.se
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.developerhub.io/support-center/code-generation.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl](https://curl.haxx.se/) (Bash)

          - [request](https://www.npmjs.com/package/request) (Node.js)

          - [Requests](https://pypi.org/project/requests/2.7.0/) (Python)

          - [net/http](https://golang.org/pkg/net/http/) (Go)

          - [Guzzle](https://docs.guzzlephp.org/en/stable/) (PHP)

          - [HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-5.0) (C#)

          - [OkHttp](https://square.'
  /all:
    get:
      operationId: get_all
      tags:
      - All
      summary: Get all resources
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/events/callbacks:
    post:
      operationId: post_api_v1_events_callbacks
      tags:
      - Api
      summary: Subscribe to events
      x-source: https://payerdocs.developerhub.io/payer-docs/events-api-and-subscribing-to-events
      parameters:
      - name: type
        in: query
        required: true
        schema:
          type: string
        description: The event type to subscribe to (e.g., INVOICE_PAYMENT_RECEIVED).
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: The callback URL where the event payload will be sent.
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/page:
    get:
      operationId: get_api_v1_page
      tags:
      - Api
      summary: GET /api/v1/page
      x-source: https://docs.developerhub.io/support-center/api-reference-settings.md
      parameters:
      - name: documentation_id
        in: query
        required: false
        schema:
          type: string
      - name: documentation_slug
        in: query
        required: false
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
      - name: page_slug
        in: query
        required: false
        schema:
          type: string
      - name: version_id
        in: query
        required: false
        schema:
          type: string
      - name: version_slug
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request GET  --url https://api.developerhub.io/api/v1/page?version_id={version_id}&version_slug={version_slug}&documentation_id={documentation_id}&documentation_slug={documentation_slug}&page_slug={page_slug}&format={format}  --header
          "Accept: application/json"

          ```'
  /api/v2/orders/invoices:
    get:
      operationId: get_api_v2_orders_invoices
      tags:
      - Api
      summary: Returns an invoice for a given invoice number.
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2OrdersInvoicesResponse'
      x-evidence:
        kind: documentation
  /api/v2/orders/invoices/credit/{creditid}:
    post:
      operationId: post_api_v2_orders_invoices_credit_creditid
      tags:
      - Api
      summary: Returns a credit invoice for the full amount of the provided invoice.
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      parameters:
      - name: creditid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2OrdersInvoicesCreditCreditidRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV2OrdersInvoicesCreditCreditidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 3 example path(s) differing only at creditId
  /api/v2/orders/invoices/send:
    put:
      operationId: put_api_v2_orders_invoices_send
      tags:
      - Api
      summary: Sends a copy of an invoice.
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2OrdersInvoicesSendRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutApiV2OrdersInvoicesSendResponse'
      x-evidence:
        kind: documentation
  /api/v2/orders/invoices/{invoiceid}:
    get:
      operationId: get_api_v2_orders_invoices_invoiceid
      tags:
      - Api
      summary: Returns invoices with invoice number >= than given invoice number.
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      parameters:
      - name: invoiceid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2OrdersInvoicesInvoiceidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 3 example path(s) differing only at invoiceId
    post:
      operationId: post_api_v2_orders_invoices_invoiceid
      tags:
      - Api
      summary: Pays an invoice with an outstanding amount from a credit invoice.
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      parameters:
      - name: invoiceid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2OrdersInvoicesInvoiceidRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV2OrdersInvoicesInvoiceidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at invoiceId
  /api/v3/invoices:
    post:
      operationId: post_api_v3_invoices
      tags:
      - Api
      summary: POST /api/v3/invoices
      x-source: https://payerdocs.developerhub.io/payer-docs/b2b-invoicing---quickstart
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST \ --url ''https://b2b.payer.se/api/v3/invoices'' \ --header ''Authorization: Bearer {token}'' \ --data ''{
          "invoiceCustomer": { "address": { "companyName": "ABC Corp", "emailAddress": "customer@example.com", "streetAddress1": "123 Main Street",
          "zipCode": "12345", "city": "Stockholm", "countryCode": "SE" // Additional fields is be added here, such as phoneNumber, email etc.
          }, // Ad'
  /audit:
    get:
      operationId: get_audit
      tags:
      - Audit
      summary: Get audit log
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /changelog/{id}/post:
    get:
      operationId: get_changelog_id_post
      tags:
      - Changelog
      summary: List changelog posts
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_changelog_id_post
      tags:
      - Changelog
      summary: Create a changelog post
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /documentation/{id}/page:
    post:
      operationId: post_documentation_id_page
      tags:
      - Documentation
      summary: Create a page
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /export:
    get:
      operationId: get_export
      tags:
      - Export
      summary: Exports project
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /oauth2/token:
    post:
      operationId: post_oauth2_token
      tags:
      - Oauth2
      summary: POST /oauth2/token
      x-source: https://payerdocs.developerhub.io/payer-b2b/ref
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOauth2TokenResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  https://b2b.payer.se/oauth2/token  -H 'Accept: application/json'  -H 'Authorization: Basic <credentials>'  -H\
          \ 'Content-Type: application/x-www-form-urlencoded'  -d grant_type=client_credentials \n The POST will return a JSON response containing\
          \ an OAuth2 Bearer token: \n {\n \"access_token\": \"some-very-long-token\",\n \"expires_in\": 3599,\n \"scope\": \"\",\n \"token_type\"\
          : \"bearer\"\n} For all othe"
  /page:
    get:
      operationId: get_page
      tags:
      - Page
      summary: Get page by slug
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /page/{id}:
    delete:
      operationId: delete_page_id
      tags:
      - Page
      summary: Delete a page
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_page_id
      tags:
      - Page
      summary: Read page
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_page_id
      tags:
      - Page
      summary: Update a page
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /page/{id}/publish:
    put:
      operationId: put_page_id_publish
      tags:
      - Page
      summary: Publish a page
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reader-access:
    get:
      operationId: get_reader_access
      tags:
      - Reader Access
      summary: Get access details of all invited readers
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_reader_access
      tags:
      - Reader Access
      summary: Revoke access to reader
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_reader_access
      tags:
      - Reader Access
      summary: Grant access to reader
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reference/{id}/definition:
    get:
      operationId: get_reference_id_definition
      tags:
      - Reference
      summary: Read a reference specification
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reference/{id}/publish:
    put:
      operationId: put_reference_id_publish
      tags:
      - Reference
      summary: Publish a reference draft
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /search:
    get:
      operationId: get_search
      tags:
      - Search
      summary: Search content
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: Get users
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /version:
    get:
      operationId: get_version
      tags:
      - Version
      summary: Lists all project versions
      x-source: https://docs.developerhub.io/api/ref
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /version/{id}:
    put:
      operationId: put_version_id
      tags:
      - Version
      summary: Update a version
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /version/{id}/clone:
    post:
      operationId: post_version_id_clone
      tags:
      - Version
      summary: Clone a version
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /version/{id}/{id}:
    get:
      operationId: get_version_id_id
      tags:
      - Version
      summary: Get broken links report
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 3 example path(s) differing only at id
  /version/{versionid}/reference:
    post:
      operationId: post_version_versionid_reference
      tags:
      - Version
      summary: Adds or updates a reference specification
      x-source: https://docs.developerhub.io/api/ref
      parameters:
      - name: versionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV2OrdersInvoicesResponse:
      type: object
      properties:
        '200':
          type: object
          description: Invoice data.
    PostApiV2OrdersInvoicesCreditCreditidRequest:
      type: object
      properties:
        deliveryType:
          type: string
          description: Delivery type.
        externalInvoiceNumber:
          type: string
          description: External invoice number.
        invoiceDate:
          type: string
          description: Invoice date.
        invoiceNumber:
          type: integer
          description: Invoice number.
        referenceId:
          type: string
          description: Reference ID.
        standalone:
          type: boolean
          description: Standalone flag.
    PostApiV2OrdersInvoicesCreditCreditidResponse:
      type: object
      properties:
        '200':
          type: object
          description: Created credit invoice.
    PutApiV2OrdersInvoicesSendRequest:
      type: object
      properties:
        address:
          type: object
          description: Address object with 13 fields.
        deliveryType:
          type: string
          description: Delivery type.
        emailCC:
          type: array
          description: CC email addresses.
        emailTo:
          type: string
          description: Recipient email.
        gln:
          type: string
          description: GLN.
        invoiceNumber:
          type: integer
          description: Invoice number.
        smsNumber:
          type: string
          description: SMS number.
    PutApiV2OrdersInvoicesSendResponse:
      type: object
      properties:
        '200':
          type: string
          description: No response body.
    GetApiV2OrdersInvoicesInvoiceidResponse:
      type: object
      properties:
        '200':
          type: array
          description: Batch of invoices.
    PostApiV2OrdersInvoicesInvoiceidRequest:
      type: object
      properties:
        amount:
          type: integer
          description: Amount to pay.
        creditInvoiceNumber:
          type: integer
          description: Credit invoice number.
        toPayInvoiceAggregationId:
          type: string
          description: Monthly invoice statement ID.
        toPayInvoiceNumber:
          type: integer
          description: Invoice number to pay.
      required:
      - amount
      - creditInvoiceNumber
    PostApiV2OrdersInvoicesInvoiceidResponse:
      type: object
      properties:
        '200':
          type: string
          description: No response body.
    PostOauth2TokenResponse:
      type: object
      properties:
        access_token:
          type: string
        expires_in:
          type: integer
        scope:
          type: string
        token_type:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: All
- name: Api
- name: Audit
- name: Changelog
- name: Documentation
- name: Export
- name: Oauth2
- name: Page
- name: Reader Access
- name: Reference
- name: Search
- name: Users
- name: Version