Altoviz Receipts API

openapi: 3.2.0
info:
  title: Altoviz Receipts API
  description: 'RESTful APIs for the Altoviz services


    ## Deprecations


    ### Product prices


    A product now stores its sale price both excluding and including tax, so both are

    returned, along with the margin figures derived from them: `taxExcludedPrice`,

    `taxIncludedPrice`, `margin`, `markupRate` (margin over cost, FR « taux de marge ») and

    `marginRate` (margin over sale price, FR « taux de marque »).


    Two fields are deprecated as a result:


    | Deprecated | Use instead |

    | --- | --- |

    | `unitPrice` | `taxExcludedPrice` |

    | `isUnitPriceTaxIncluded` | `taxIncludedPrice`, to send a tax-included price |


    **`unitPrice` is now always the tax-excluded price.** It previously held whichever half

    the product was priced in, which `isUnitPriceTaxIncluded` told you. For a product priced

    tax-included, `unitPrice` therefore returns a different number than it used to, and

    `isUnitPriceTaxIncluded` is now always `false`. If you read the flag before using the

    price, your result is unchanged. If you assumed the price was tax-included, read

    `taxIncludedPrice`.


    Writing is unaffected. Both fields are still accepted and behave exactly as before:

    `unitPrice` alone is read as tax-excluded, and setting `isUnitPriceTaxIncluded` to `true`

    still means the price you are sending includes tax. `margin`, `markupRate` and

    `marginRate` are derived by the server and ignored if sent.'
  contact:
    name: Altoviz
    email: contact@altoviz.com
  license:
    name: Altoviz license
    url: https://altoviz.com/license
  version: v1
  x-logo:
    url: https://altoviz.com/altoviz-logo-ext-violet-262x72.png
    altText: Altoviz logo
servers:
- url: https://api.altoviz.com
  description: Altoviz
security:
- {}
tags:
- name: Receipts
  description: Receipts API
paths:
  /v1/receipts:
    get:
      tags:
      - Receipts
      summary: List receipts
      operationId: GET_Receipts_List
      parameters:
      - name: PageIndex
        in: query
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: OrderBy
        in: query
        schema:
          type: string
      - name: query
        in: query
        description: query (full text search)
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            x-page-prev:
              description: Relative URL of previous page when available
              schema:
                type: string
            x-page-next:
              description: Relative URL of next page when available
              schema:
                type: string
            x-page-count:
              description: Total number of pages
              schema:
                type: integer
                format: int32
            x-record-count:
              description: Total number of matching records
              schema:
                type: integer
                format: int32
            x-page-index:
              description: Current page index
              schema:
                type: integer
                format: int32
            x-page-size:
              description: Current page size
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Receipt'
    post:
      tags:
      - Receipts
      summary: Create a new receipt
      operationId: POST_Receipts_Post
      requestBody:
        description: Receipt to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Receipt'
          text/json:
            schema:
              $ref: '#/components/schemas/Receipt'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Receipt'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/receipts/find:
    get:
      tags:
      - Receipts
      summary: Find a receipt by internal ID
      operationId: GET_Receipts_Find
      parameters:
      - name: internalId
        in: query
        description: Customer internal ID
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
  /v1/receipts/getbyinternalid/{internalid}:
    get:
      tags:
      - Receipts
      summary: Find a single receipt by its internal ID
      operationId: GET_Receipts_GetByInternalId
      parameters:
      - name: internalId
        in: path
        description: Receipt internal ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
  /v1/receipts/{id}:
    get:
      tags:
      - Receipts
      summary: Get a receipt by ID
      operationId: GET_Receipts_Get
      parameters:
      - name: id
        in: path
        description: Receipt id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - Receipts
      summary: Update a receipt
      operationId: PUT_Receipts_Update
      parameters:
      - name: id
        in: path
        description: Receipt ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Receipt'
          text/json:
            schema:
              $ref: '#/components/schemas/Receipt'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Receipt'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - Receipts
      summary: Delete a receipt
      operationId: DELETE_Receipts_Delete
      parameters:
      - name: id
        in: path
        description: Receipt id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    CustomerType:
      enum:
      - Business
      - Consumer
      - Government
      type: string
    DiscountType:
      enum:
      - Percent
      - Fixed
      type: string
    PaymentStatus:
      enum:
      - Success
      - Pending
      - Failed
      type: string
      description: Receipt Status
    CommitmentStatus:
      enum:
      - Unpaid
      - Paid
      - PartiallyPaid
      - Balanced
      type: string
    CustomerFamily:
      type: object
      properties:
        id:
          type: integer
          description: ID
          format: int32
          readOnly: true
        internalId:
          type:
          - string
          - 'null'
          description: Internal ID
        label:
          type:
          - string
          - 'null'
          description: Label
        number:
          type:
          - string
          - 'null'
          description: Number
      additionalProperties: false
      description: Customer family
    Discount:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DiscountType'
        value:
          type: number
          format: double
      additionalProperties: false
    ReceiptLinkType:
      enum:
      - Commitment
      - Invoice
      - Credit
      type: string
      description: Receipt Link type
    Customer:
      type: object
      properties:
        active:
          type: boolean
          description: Active
        billingAddress:
          $ref: '#/components/schemas/AddressFields'
        billingOptions:
          $ref: '#/components/schemas/BillingOptions'
        cellPhone:
          type:
          - string
          - 'null'
          description: Cell phone number
        companyInformations:
          $ref: '#/components/schemas/CompanyInfo'
        companyName:
          type:
          - string
          - 'null'
          description: Company name
        email:
          type:
          - string
          - 'null'
          description: Email
        family:
          $ref: '#/components/schemas/CustomerFamily'
        firstName:
          type:
          - string
          - 'null'
          description: First name
        id:
          type: integer
          description: Customer ID
          format: int32
          readOnly: true
        internalId:
          type:
          - string
          - 'null'
          description: ID used in information system
        internalNotes:
          type:
          - string
          - 'null'
          description: Internal notes
        lastName:
          type:
          - string
          - 'null'
          description: Last name
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Metadata: free-form key/value pairs carried with the customer, for an integration to keep

            its own identifiers and flags against it.


            Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out

            keep whatever they held, and a key is removed only when you send it as `null`. Omitting

            the property entirely leaves the whole bag untouched, and `""` stores an empty value

            rather than removing the key.'
        name:
          type:
          - string
          - 'null'
          description: Name
          readOnly: true
        number:
          type:
          - string
          - 'null'
          description: Number
        phone:
          type:
          - string
          - 'null'
          description: Phone number
        shippingAddress:
          $ref: '#/components/schemas/AddressFields'
        title:
          type:
          - string
          - 'null'
          description: Title
        type:
          $ref: '#/components/schemas/CustomerType'
      additionalProperties: false
      description: Customer
    Error:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of error messages
        message:
          type:
          - string
          - 'null'
          description: Error message
      additionalProperties: false
      description: Error
    CompanyInfo:
      type: object
      properties:
        effectiveElectronicAddress:
          type:
          - string
          - 'null'
        electronicAddress:
          type:
          - string
          - 'null'
        siret:
          type:
          - string
          - 'null'
        vatNumber:
          type:
          - string
          - 'null'
      additionalProperties: false
    AddressFields:
      type: object
      properties:
        city:
          type:
          - string
          - 'null'
        countryIso:
          type:
          - string
          - 'null'
        countryName:
          type:
          - string
          - 'null'
          readOnly: true
        formattedAddress:
          type:
          - string
          - 'null'
          readOnly: true
        inlineAddress:
          type:
          - string
          - 'null'
          readOnly: true
        street:
          type:
          - string
          - 'null'
        zipcode:
          type:
          - string
          - 'null'
      additionalProperties: false
    Receipt:
      type: object
      properties:
        amount:
          type: number
          description: Amount
          format: double
        customerId:
          type:
          - integer
          - 'null'
          description: Customer ID
          format: int32
        customerInternalId:
          type:
          - string
          - 'null'
          description: Customer number
        customerName:
          type:
          - string
          - 'null'
          description: Customer name
          readOnly: true
        customerNumber:
          type:
          - string
          - 'null'
          description: Customer number
        date:
          type: string
          description: Date
          format: date
        id:
          type: integer
          description: ID
          format: int32
          readOnly: true
        internalId:
          type:
          - string
          - 'null'
          description: Internal ID
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReceiptLink'
          description: Links used to mark documents as paid
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Metadata: free-form key/value pairs carried with the receipt, for an integration to keep

            its own identifiers and flags against it.


            Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out

            keep whatever they held, and a key is removed only when you send it as `null`. Omitting

            the property entirely leaves the whole bag untouched, and `""` stores an empty value

            rather than removing the key.'
        notes:
          type:
          - string
          - 'null'
          description: Notes
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        reference:
          type:
          - string
          - 'null'
          description: Reference
        status:
          $ref: '#/components/schemas/PaymentStatus'
      additionalProperties: false
      description: Receipt
    BillingOptions:
      type: object
      properties:
        allowed:
          type:
          - boolean
          - 'null'
          description: Allowed
        bankAccountId:
          type:
          - integer
          - 'null'
          description: Bank account ID
          format: int32
        buyerReference:
          type:
          - string
          - 'null'
          description: Buyer reference
        colleagueId:
          type:
          - integer
          - 'null'
          description: Colleague ID
          format: int32
        discount:
          $ref: '#/components/schemas/Discount'
        initialCommitmentAmount:
          type:
          - number
          - 'null'
          description: Intial commitment amount
          format: double
        initialCommitmentDate:
          type:
          - string
          - 'null'
          description: Initial commitment date
          format: date
        initialCommitmentStatus:
          $ref: '#/components/schemas/CommitmentStatus'
        liableToVat:
          type:
          - boolean
          - 'null'
          description: Indicates whether the document is liable to VAT
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        sendDocumentAsAttachment:
          type:
          - boolean
          - 'null'
          description: Send document as attachment
        settlementTermId:
          type:
          - integer
          - 'null'
          description: Settlement term ID
          format: int32
        useTaxIncludedPrices:
          type:
          - boolean
          - 'null'
          description: Use tax included prices
        vatReverseCharge:
          type:
          - boolean
          - 'null'
          description: Indicates VAT should be included in sales
        vendorReference:
          type:
          - string
          - 'null'
          description: Vendor reference. Used to be print on sales
      additionalProperties: false
      description: Billing options
    ReceiptLink:
      type: object
      properties:
        amount:
          type:
          - number
          - 'null'
          description: Amount
          format: double
        id:
          type: integer
          description: Linked document ID
          format: int32
        type:
          $ref: '#/components/schemas/ReceiptLinkType'
      additionalProperties: false
      description: ReceiptLink
    ProblemDetails:
      type: object
      properties:
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        title:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: {}
    PaymentMethod:
      enum:
      - Transfer
      - Order
      - Check
      - Cash
      - Card
      - Bill
      - Usec
      - Other
      type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header