Optimizely

Optimizely Invoice Histories API

The Invoice Histories API from Optimizely — 7 operation(s) for invoice histories.

GitHub OpenAPI
Business capability
Accounts Receivable Management BC-200.30

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/InvoiceHistories List historical invoices · Returns the EntitySet InvoiceHistories #
Ask an LLM
“How do I pull invoice history synced from our ERP?”
“Can I list only the invoices that are still open?”
Tell an agent
List all invoice history records.
List invoice histories matching {filter}, sorted by {orderby}.
POST /api/v1/admin/InvoiceHistories Add a historical invoice record · Post a new entity to EntitySet InvoiceHistories #
Ask an LLM
“How do I load an ERP invoice into the invoice history?”
“What fields are required when creating an invoice history record?”
Tell an agent
Create invoice history {invoiceNumber} of type {invoiceType} for customer {customerNumber}.
Add invoice {invoiceNumber} with total {invoiceTotal} due on {dueDate}.
GET /api/v1/admin/InvoiceHistories({id}) Get one historical invoice · Returns the entity with the key from InvoiceHistories #
Ask an LLM
“How do I view the totals and current balance of one invoice?”
“Can I choose which fields come back for a single invoice history record?”
Tell an agent
Get invoice history {id}.
Show only {select} for invoice history {id}.
PUT /api/v1/admin/InvoiceHistories({id}) Replace a historical invoice record · Replace entity in EntitySet InvoiceHistories #
Ask an LLM
“How do I overwrite an entire invoice history record?”
“Is there a way to fully replace a past invoice with new ERP data?”
Tell an agent
Replace invoice history {id} with the full record for invoice {invoiceNumber}.
Overwrite past invoice {id} entirely, setting current balance to {currentBalance}.
DELETE /api/v1/admin/InvoiceHistories({id}) Delete a historical invoice · Delete entity in EntitySet InvoiceHistories #
Ask an LLM
“How do I remove one invoice from invoice history?”
“Can I delete a past invoice only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete invoice history {id}.
Remove past invoice {id} if its ETag is still {etag}.
PATCH /api/v1/admin/InvoiceHistories({id}) Update fields on a historical invoice · Update entity in EntitySet InvoiceHistories #
Ask an LLM
“How do I mark a past invoice as closed?”
“Can I update just the current balance on an invoice history record?”
Tell an agent
Set isOpen to {isOpen} on invoice history {id}.
Update the balance of past invoice {id} to {currentBalance}.
GET /api/v1/admin/InvoiceHistories/Default.Default() Get a blank invoice history template · Call operation Default #
Ask an LLM
“What default values does a new invoice history record start with?”
“Can I fetch an empty invoice template before loading invoices?”
Tell an agent
Fetch the default invoice history template.
Show me the starting values for a new invoice history record.
DELETE /api/v1/admin/invoicehistories/delete Bulk delete historical invoices · Invoice histories delete route #
Ask an LLM
“How do I delete several past invoices at once?”
“Can I purge a batch of invoice history records by ID?”
Tell an agent destructive · confirm first
Bulk delete the invoice histories with IDs {ids}.
Remove these past invoices in one call: {ids}.
GET /api/v1/admin/invoicehistories({key})/customproperties({custompropertyKey}) Get a custom property on a historical invoice · Invoice histories get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a past invoice?”
“Can I fetch one extra field value from an invoice history record?”
Tell an agent
Get custom property {custompropertyKey} on invoice history {key}.
Show the custom property {custompropertyKey} of past invoice {key}.
GET /api/v1/admin/invoicehistories({key})/invoicehistorylines({invoicehistorylineKey}) Get a line item on a historical invoice · Invoice histories get invoice history line by key and invoicehistorylinekey #
Ask an LLM
“How do I see a single billed line from a past invoice?”
“Can I read one invoice history line by its key?”
Tell an agent
Get line {invoicehistorylineKey} of invoice history {key}.
Show billed line {invoicehistorylineKey} on past invoice {key}.
GET /api/v1/admin/invoicehistories({key})/invoicehistorytaxes({invoicehistorytaxKey}) Get a tax entry on a historical invoice · Invoice histories get invoice history tax by key and invoicehistorytaxkey #
Ask an LLM
“How do I see a tax breakdown entry on a past invoice?”
“Can I read one invoice history tax record by its key?”
Tell an agent
Get tax entry {invoicehistorytaxKey} on invoice history {key}.
Show tax line {invoicehistorytaxKey} for past invoice {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-invoice-histories-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/optimizely:optimizely-invoice-histories-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

optimizely-invoice-histories-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Invoice Histories API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Invoice Histories
paths:
  /api/v1/admin/InvoiceHistories:
    get:
      tags:
      - Invoice Histories
      summary: Returns the EntitySet InvoiceHistories
      operationId: InvoiceHistories_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Invoice Histories
      summary: Post a new entity to EntitySet InvoiceHistories
      operationId: InvoiceHistories_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.InvoiceHistory'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/InvoiceHistories({id}):
    get:
      tags:
      - Invoice Histories
      summary: Returns the entity with the key from InvoiceHistories
      operationId: InvoiceHistories_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Invoice Histories
      summary: Replace entity in EntitySet InvoiceHistories
      operationId: InvoiceHistories_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.InvoiceHistory'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Invoice Histories
      summary: Delete entity in EntitySet InvoiceHistories
      operationId: InvoiceHistories_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Invoice Histories
      summary: Update entity in EntitySet InvoiceHistories
      operationId: InvoiceHistories_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.InvoiceHistory'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/InvoiceHistories/Default.Default():
    get:
      tags:
      - Invoice Histories
      summary: Call operation Default
      operationId: InvoiceHistories_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/invoicehistories/delete:
    delete:
      tags:
      - Invoice Histories
      operationId: InvoiceHistories_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Invoice histories delete route
      x-summary-source: derived
  /api/v1/admin/invoicehistories({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Invoice Histories
      operationId: InvoiceHistories_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Invoice histories get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/invoicehistories({key})/invoicehistorylines({invoicehistorylineKey}):
    get:
      tags:
      - Invoice Histories
      operationId: InvoiceHistories_GetInvoiceHistoryLineByKeyAndInvoicehistorylinekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: invoicehistorylineKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Invoice histories get invoice history line by key and invoicehistorylinekey
      x-summary-source: derived
  /api/v1/admin/invoicehistories({key})/invoicehistorytaxes({invoicehistorytaxKey}):
    get:
      tags:
      - Invoice Histories
      operationId: InvoiceHistories_GetInvoiceHistoryTaxByKeyAndInvoicehistorytaxkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: invoicehistorytaxKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Invoice histories get invoice history tax by key and invoicehistorytaxkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.InvoiceHistory:
      required:
      - invoiceNumber
      - invoiceType
      - customerNumber
      - customerSequence
      - customerPO
      - status
      - currencyCode
      - terms
      - shipCode
      - salesperson
      - btCompanyName
      - btAddress1
      - btAddress2
      - btCity
      - btState
      - btPostalCode
      - btCountry
      - stCompanyName
      - stAddress1
      - stAddress2
      - stCity
      - stState
      - stPostalCode
      - stCountry
      - notes
      - customerVatNumber
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        invoiceNumber:
          maxLength: 50
          minLength: 0
          type: string
        invoiceDate:
          format: date-time
          type: string
        dueDate:
          format: date-time
          type: string
        invoiceType:
          maxLength: 50
          minLength: 0
          type: string
        customerNumber:
          maxLength: 50
          minLength: 0
          type: string
        customerSequence:
          maxLength: 50
          minLength: 0
          type: string
        customerPO:
          maxLength: 50
          minLength: 0
          type: string
        status:
          maxLength: 50
          minLength: 0
          type: string
        isOpen:
          type: boolean
        currencyCode:
          maxLength: 50
          minLength: 0
          type: string
        terms:
          maxLength: 50
          minLength: 0
          type: string
        shipCode:
          maxLength: 50
          minLength: 0
          type: string
        salesperson:
          maxLength: 50
          minLength: 0
          type: string
        btCompanyName:
          maxLength: 100
          minLength: 0
          type: string
        btAddress1:
          maxLength: 100
          minLength: 0
          type: string
        btAddress2:
          maxLength: 100
          minLength: 0
          type: string
        btCity:
          maxLength: 100
          minLength: 0
          type: string
        btState:
          maxLength: 50
          minLength: 0
          type: string
        btPostalCode:
          maxLength: 50
          minLength: 0
          type: string
        btCountry:
          maxLength: 100
          minLength: 0
          type: string
        stCompanyName:
          maxLength: 100
          minLength: 0
          type: string
        stAddress1:
          maxLength: 100
          minLength: 0
          type: string
        stAddress2:
          maxLength: 100
          minLength: 0
          type: string
        stCity:
          maxLength: 100
          minLength: 0
          type: string
        stState:
          maxLength: 50
          minLength: 0
          type: string
        stPostalCode:
          maxLength: 50
          minLength: 0
          type: string
        stCountry:
          maxLength: 100
          minLength: 0
          type: string
        notes:
          type: string
        productTotal:
          format: decimal
          type: number
        discountAmount:
          format: decimal
          type: number
        shippingAndHandling:
          format: decimal
          type: number
        otherCharges:
          format: decimal
          type: number
        taxAmount:
          format: decimal
          type: number
        invoiceTotal:
          format: decimal
          type: number
        currentBalance:
          format: decimal
          type: number
        customerVatNumber:
          maxLength: 50
          minLength: 0
          type: string
        shippingVatAmount:
          format: decimal
          type: number
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query