evictionsapi-com Charges API

openapi: 3.2.0
info:
  title: Evictionsapi Com Charges API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Charges across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: Charges
paths:
  /v1/charges:
    get:
      summary: Every charge of the organization's cases in this mode, newest first, optionally…
      security:
      - ApiKey: []
      - SessionToken: []
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
          maxLength: 512
      - name: limit
        in: query
        required: false
        schema:
          type: string
          pattern: ^\d{1,9}$
      - name: status
        in: query
        required: false
        schema:
          type: string
          enum:
          - due
          - paid
          - void
          - refunded
      - name: from
        in: query
        required: false
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
      - name: to
        in: query
        required: false
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
      - name: landlordId
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^[A-Za-z0-9_-]+$
      responses:
        '200':
          description: 'A page of charges, and the totals over all of them. `paymentsEnabled` false: online payment is off, and `checkout` answers 409 `payments_unavailable`.'
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                - nextCursor
                - paymentsEnabled
                - totals
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerCharge'
                  nextCursor:
                    type:
                    - string
                    - 'null'
                  paymentsEnabled:
                    type: boolean
                  totals:
                    $ref: '#/components/schemas/ChargeTotals'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Charges
      operationId: getV1Charges
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/charges/by-landlord:
    get:
      summary: The organization's charges in this mode totalled per landlord of their cases…
      security:
      - ApiKey: []
      - SessionToken: []
      responses:
        '200':
          description: One line per landlord.
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      required:
                      - landlordId
                      - landlordName
                      - dueCents
                      - paidThisYearCents
                      - count
                      properties:
                        landlordId:
                          type:
                          - string
                          - 'null'
                          description: Null for the cases with no landlord.
                        landlordName:
                          type: string
                          description: The landlord's current name; "No landlord" for the cases with none, and "Unknown landlord" should a name not be readable.
                        dueCents:
                          type: integer
                          description: US cents due.
                        paidThisYearCents:
                          type: integer
                          description: US cents paid this calendar year (UTC).
                        count:
                          type: integer
                          description: How many charges, of any status.
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Charges
      operationId: getV1ChargesByLandlord
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    CustomerCharge:
      type: object
      description: 'A charge on one of the organization''s cases, as the billing page lists it: the case''s id, the property''s state and the case''s landlord, and the charge as `GET /v1/cases/{id}/charges` shows it.'
      required:
      - id
      - caseId
      - propertyState
      - landlord
      - kind
      - description
      - amountCents
      - status
      - collection
      - paidAt
      - receiptUrl
      - createdAt
      properties:
        id:
          type: string
        caseId:
          type: string
        propertyState:
          type: string
          description: Two-letter code of the property's state. Empty for a case whose details were erased.
        landlord:
          type:
          - object
          - 'null'
          required:
          - id
          - name
          properties:
            id:
              type: string
            name:
              type: string
          description: The case's landlord (one of `GET /v1/landlords`, archived ones too) with its current name; null when the case has none.
        kind:
          enum:
          - platform_fee
          - court_costs
          - service_costs
          - other
        description:
          type: string
        amountCents:
          type: integer
          description: US cents.
        status:
          enum:
          - due
          - paid
          - void
          - refunded
        collection:
          enum:
          - checkout
          - automatic
          description: As on `Charge`.
        paidAt:
          type:
          - string
          - 'null'
          format: date-time
        receiptUrl:
          type:
          - string
          - 'null'
          format: uri
          description: As on `Charge`.
        createdAt:
          type: string
          format: date-time
    ChargeTotals:
      type: object
      description: The billing page's totals over all the organization's charges in the mode, whatever the filter, in US cents. Years are UTC calendar years. "Refunded this year" counts charges by the day they were refunded.
      required:
      - dueCount
      - dueCents
      - paidLast30Cents
      - paidThisYearCents
      - refundedThisYearCents
      properties:
        dueCount:
          type: integer
        dueCents:
          type: integer
        paidLast30Cents:
          type: integer
        paidThisYearCents:
          type: integer
        refundedThisYearCents:
          type: integer
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json