find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/invoicepdfs-com:invoicepdfs-com-business-profiles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Invoicepdfs Com Business Profiles API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged business-profiles across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: business-profiles
paths:
  /api/v1/business-profiles:
    get:
      tags:
      - business-profiles
      summary: List Business Profiles
      description: 'The identities you issue documents *as*, newest first.


        One per entity you bill from — a business with two trading names or two tax

        registrations needs two. For how documents *look* rather than who issues

        them, see the branding profiles.'
      operationId: list_business_profiles
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProfilesListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - business-profiles
      summary: Create Business Profile
      description: 'Create an identity to issue documents as: the seller side.


        `legal_name`, `tax_id`, address and bank details are what appears as the

        issuer, and what an e-invoicing ruleset checks. Distinct from a branding

        profile, which sets colours and a logo and says nothing about who you are.'
      operationId: create_business_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessProfileCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/business-profiles/{business_profile_id}:
    get:
      tags:
      - business-profiles
      summary: Get Business Profile
      description: One business profile.
      operationId: get_business_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: business_profile_id
        in: path
        required: true
        schema:
          type: string
          title: Business Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - business-profiles
      summary: Update Business Profile
      description: 'Change a business profile.


        Only the fields you send are changed. Documents already issued keep the

        issuer details they carried at the time.'
      operationId: update_business_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: business_profile_id
        in: path
        required: true
        schema:
          type: string
          title: Business Profile Id
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessProfilePatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - business-profiles
      summary: Delete Business Profile
      description: 'Remove a business profile.


        `409` if any document was issued under it, naming what still points at it.'
      operationId: delete_business_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: business_profile_id
        in: path
        required: true
        schema:
          type: string
          title: Business Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleBoolResponse'
        '409':
          description: The profile is named on documents or recurring invoices. `details.referenced_by` counts each one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    BusinessProfileCreate:
      properties:
        legal_name:
          type: string
          title: Legal Name
          examples:
          - Acme Corp Inc.
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
          examples:
          - Acme Corp
        contact_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact Name
          description: Who to ask about an invoice — a person or a department, not the company. EN 16931 calls it the contact point (BT-41 for the seller, BT-56 for the buyer); some national rulesets require it.
          examples:
          - Accounts Receivable
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          examples:
          - billing@acme.com
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
          examples:
          - +1-555-123-4567
        website:
          anyOf:
          - type: string
          - type: 'null'
          title: Website
          examples:
          - https://acme.com
        tax_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tax Id
          examples:
          - US-EIN-12-3456789
        address:
          anyOf:
          - $ref: '#/components/schemas/PostalAddress'
          - type: 'null'
        bank_account:
          anyOf:
          - $ref: '#/components/schemas/InvoiceBankAccountInput'
          - type: 'null'
          description: Where to send the money. Becomes the invoice's payment instructions (BG-16) unless a document states an account of its own; some national rulesets require them.
        electronic_address:
          anyOf:
          - $ref: '#/components/schemas/ElectronicAddress'
          - type: 'null'
          description: Network address for e-invoicing. Required by Peppol; not the tax id.
        default_currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Currency
          examples:
          - USD
        default_locale:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Locale
          examples:
          - en-US
        default_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Timezone
          examples:
          - America/New_York
        logo_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Logo File Id
          examples:
          - file_01ABC
      type: object
      required:
      - legal_name
      title: BusinessProfileCreate
    BusinessProfileResponse:
      properties:
        data:
          $ref: '#/components/schemas/BusinessProfileOut'
      type: object
      required:
      - data
      title: BusinessProfileResponse
    PostalAddress:
      properties:
        line1:
          type: string
          title: Line1
          examples:
          - 1 Main St
        line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Line2
          examples:
          - Suite 200
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          examples:
          - San Francisco
        state:
          anyOf:
          - type: string
          - type: 'null'
          title: State
          examples:
          - CA
        postal_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Postal Code
          examples:
          - '94105'
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          examples:
          - US
      type: object
      required:
      - line1
      title: PostalAddress
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    SimpleBoolResponse:
      properties:
        data:
          additionalProperties:
            type: boolean
          type: object
          title: Data
      type: object
      required:
      - data
      title: SimpleBoolResponse
      description: 'Generic boolean response envelope.


        Example:

        {"data": {"deleted": true}}'
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    BusinessProfilesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/BusinessProfileOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: BusinessProfilesListResponse
    ElectronicAddress:
      properties:
        value:
          type: string
          minLength: 1
          title: Value
          examples:
          - '9482348239'
        scheme_id:
          type: string
          minLength: 1
          title: Scheme Id
          description: EAS code list identifier — 0088 is GLN, 9930 a German VAT number.
          examples:
          - 0088
      type: object
      required:
      - value
      - scheme_id
      title: ElectronicAddress
      description: 'BT-34 / BT-49 — where a document is routed on Peppol or DBNA.


        Both halves are required: an identifier without its scheme cannot be

        resolved, because the same string means different things in different code

        lists. This is not the tax id, which identifies a company to a tax

        authority rather than a mailbox on a network.'
    BusinessProfilePatch:
      properties:
        legal_name:
          type: string
          title: Legal Name
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        contact_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact Name
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        website:
          anyOf:
          - type: string
          - type: 'null'
          title: Website
        tax_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tax Id
        address:
          anyOf:
          - $ref: '#/components/schemas/PostalAddress'
          - type: 'null'
        bank_account:
          anyOf:
          - $ref: '#/components/schemas/InvoiceBankAccountInput'
          - type: 'null'
        electronic_address:
          anyOf:
          - $ref: '#/components/schemas/ElectronicAddress'
          - type: 'null'
        default_currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Currency
        default_locale:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Locale
        default_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Timezone
        logo_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Logo File Id
      type: object
      title: BusinessProfilePatch
    BusinessProfileOut:
      properties:
        legal_name:
          type: string
          title: Legal Name
          examples:
          - Acme Corp Inc.
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
          examples:
          - Acme Corp
        contact_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact Name
          description: Who to ask about an invoice — a person or a department, not the company. EN 16931 calls it the contact point (BT-41 for the seller, BT-56 for the buyer); some national rulesets require it.
          examples:
          - Accounts Receivable
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          examples:
          - billing@acme.com
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
          examples:
          - +1-555-123-4567
        website:
          anyOf:
          - type: string
          - type: 'null'
          title: Website
          examples:
          - https://acme.com
        tax_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tax Id
          examples:
          - US-EIN-12-3456789
        address:
          anyOf:
          - $ref: '#/components/schemas/PostalAddress'
          - type: 'null'
        bank_account:
          anyOf:
          - $ref: '#/components/schemas/InvoiceBankAccountInput'
          - type: 'null'
          description: Where to send the money. Becomes the invoice's payment instructions (BG-16) unless a document states an account of its own; some national rulesets require them.
        electronic_address:
          anyOf:
          - $ref: '#/components/schemas/ElectronicAddress'
          - type: 'null'
          description: Network address for e-invoicing. Required by Peppol; not the tax id.
        default_currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Currency
          examples:
          - USD
        default_locale:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Locale
          examples:
          - en-US
        default_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Timezone
          examples:
          - America/New_York
        logo_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Logo File Id
          examples:
          - file_01ABC
        id:
          type: string
          title: Id
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - legal_name
      - id
      - created_at
      - updated_at
      title: BusinessProfileOut
    InvoiceBankAccountInput:
      properties:
        bank_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Bank Name
          examples:
          - First National Bank
        account_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Account Name
          examples:
          - Acme Corp
        account_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Account Number
          examples:
          - '1234567890'
        routing_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Routing Number
          examples:
          - '021000021'
        swift:
          anyOf:
          - type: string
          - type: 'null'
          title: Swift
          examples:
          - FNBKUS33
        iban:
          anyOf:
          - type: string
          - type: 'null'
          title: Iban
          examples:
          - US82FNBK0000001234567890
      type: object
      title: InvoiceBankAccountInput
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs