Restaurant365 AP Invoices API

openapi: 3.2.0
info:
  title: R365 AP Invoices API
  description: The R365 API lets approved third-party services and vendors connect to a Restaurant365 customer database to retrieve data and push records, including accounts payable (AP) invoices and general ledger (GL) entries. Each request is authenticated with a bearer token obtained from the Authenticate operation. Access is provisioned per customer by contacting R365 Support to enable a vendor. All paths are served from the customer's unique R365 database host.
  version: v1
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: Proprietary
servers:
- url: https://{customerHost}.restaurant365.com
  description: Customer-specific Restaurant365 database host
  variables:
    customerHost:
      default: yourcompany
      description: The unique customer subdomain assigned by Restaurant365
tags:
- name: AP Invoices
  description: Create accounts payable invoices in the customer database
paths:
  /APIv1/APInvoices:
    post:
      operationId: createApInvoices
      summary: Create AP Invoices
      description: Create one or more accounts payable invoices in the customer database using vendor and product (item) level detail. Vendor name and retailer store number must match values configured in the customer's R365 database.
      tags:
      - AP Invoices
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/APInvoice'
      responses:
        '200':
          description: Processing result with successes and failures
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingResult'
        '401':
          description: Missing or invalid bearer token
components:
  schemas:
    APInvoice:
      type: object
      required:
      - Vendor_Name
      - Retailer_Store_Number
      - Invoice_Date
      properties:
        BatchId:
          type: string
          description: Optional batch identifier grouping records
        userId:
          type: string
          description: Optional user identifier for the submitting user
        Vendor_Name:
          type: string
          description: Vendor name as configured in the customer's R365 database
        Retailer_Store_Number:
          type: string
          description: Retailer store number for the location
        Invoice_Date:
          type: string
          description: Invoice date in MM/DD/YYYY format
        Invoice_Due_Date:
          type: string
          description: Invoice due date in MM/DD/YYYY format
        Invoice_Number:
          type: string
          description: Vendor invoice number
        Invoice_Amount:
          type: number
          description: Total invoice amount
        Image_URL:
          type: string
          format: uri
          description: URL of the invoice image
        Product_Number:
          type: string
          description: Vendor item (product) number
        Quantity:
          type: number
          description: Quantity of the item
        Invoice_Line_Item_Cost:
          type: number
          description: Per-unit cost of the line item
        Extended_Price:
          type: number
          description: Extended price for the line item
        Product_Description:
          type: string
          description: Description of the item
        Unit_Of_Measure:
          type: string
          description: Unit of measure; must match an R365 UOFM value
        Split_Case:
          type: boolean
          description: Whether the case is split
    ProcessingResult:
      type: object
      description: Result envelope returned by record-creation operations
      properties:
        errors:
          type: array
          description: Request-level errors
          items:
            type: object
            properties:
              reason:
                type: string
              solution:
                type: string
        success:
          type: array
          description: Count of records successfully processed
          items:
            type: object
            properties:
              Count:
                type: integer
        failures:
          type: array
          description: Records that failed processing
          items:
            type: object
            properties:
              record:
                type: string
              reason:
                type: string
              solution:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token returned by the Authenticate operation