Payer Orders API

openapi: 3.2.0
info:
  title: Payer Orders 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
security:
- bearer: []
tags:
- name: Orders
paths:
  /api/v2/orders/invoices:
    get:
      operationId: get_api_v2_orders_invoices
      tags:
      - Orders
      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:
      - Orders
      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:
      - Orders
      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:
      - Orders
      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:
      - Orders
      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
components:
  schemas:
    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.
    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
    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.
    GetApiV2OrdersInvoicesInvoiceidResponse:
      type: object
      properties:
        '200':
          type: array
          description: Batch of invoices.
    PostApiV2OrdersInvoicesInvoiceidResponse:
      type: object
      properties:
        '200':
          type: string
          description: No response body.
    PutApiV2OrdersInvoicesSendResponse:
      type: object
      properties:
        '200':
          type: string
          description: No response body.
    GetApiV2OrdersInvoicesResponse:
      type: object
      properties:
        '200':
          type: object
          description: Invoice data.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer