billing

List billing invoices

Changed on
get/invoices

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/invoices
  • Auth
    API key in header X-Schematic-Api-Key

Query parameters

company_idstring
contract_idstring
document_state'credited' | 'draft' | 'finalized' | 'void'
past_dueboolean

Only open invoices with an amount left to pay whose due date has passed.

provider_type'metronome' | 'orb' | 'schematic' | 'stripe'

Only invoices from this billing provider. Leave empty for invoices from Schematic and Stripe.

qstring

Search by invoice number, provider invoice ID or company name.

status'draft' | 'open' | 'paid' | 'uncollectible' | 'void'
limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • e92a4ba2fbb0Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      api operation id listNativeInvoices removed and replaced with listBillingInvoices

    • info

      added the new optional query request parameter past_due

    • info

      added the new optional query request parameter provider_type

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      removed the credited enum value from the // response property for the response status

    • info

      removed the draft enum value from the // response property for the response status

    • info

      removed the finalized enum value from the // response property for the response status

    • info

      removed the void enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

  • 6a825174a24fRevision changes
    • info

      endpoint added