Retrieve Invoices

GET 
/invoices

Returns a list of Invoices.

Request

Query Parameters

sortColumn string

Possible values: <= 255 characters

Entity field used to sort the results

sort string

Possible values: [asc, desc]

Direction to use when sorting records

perPage integer

Possible values: >= 1

Number to indicate how many records should be returned per page

page integer

Possible values: >= 1

Page number to retrieve records

q string

Possible values: <= 255 characters

Query to filter records. Query will search the following fields: customer_id status

Responses

200

Invoices retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object[]

Array [

id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

status string

Possible values: [draft, open, processing, paid, uncollectible, void]

total_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

subtotal_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

customer_id uuidnullable

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

customer_name stringnullable

Name of the customer the invoice is linked to.

customer_email email

Possible values: <= 255 characters

Email Address

due_date Unix timestamp

Unix timestamp representing the date

can_finalize boolean

When true the invoice can be finialized as it meets minimum required data.

finalize_errors stringnullable

If the invoice cannot be finalized, errors will be returned here.

can_be_edited boolean

Whether the invoice can be edited or not.

can_be_paid boolean

Whether the invoice can be paid or not.

can_be_sent boolean

Whether the invoice can be sent through email or not.

line_items

object[]

nullable

Array [

id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

description string

Description of the line item

quantity integer

Possible values: >= 1

Quantity. The total will be calculated by multiplying the quantity and the unit_amount

unit_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

total_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

discounted_total

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

]

created_on Unix timestamp

Unix timestamp representing the date

]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

pagination

object

total_records integer

page integer

records_per_page integer

Example (from schema)

{
  "status": "success",
  "data": [
    {
      "id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
      "status": "draft",
      "total_amount": {
        "value": 99,
        "currency": "USD"
      },
      "subtotal_amount": {
        "value": 99,
        "currency": "USD"
      },
      "customer_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
      "customer_name": "string",
      "customer_email": "peter@pathly.io",
      "due_date": 1656656767,
      "can_finalize": true,
      "finalize_errors": "string",
      "can_be_edited": true,
      "can_be_paid": true,
      "can_be_sent": true,
      "line_items": [
        {
          "id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
          "description": "Web design service hour",
          "quantity": 5,
          "unit_amount": {
            "value": 99,
            "currency": "USD"
          },
          "total_amount": {
            "value": 99,
            "currency": "USD"
          },
          "discounted_total": {
            "value": 99,
            "currency": "USD"
          }
        }
      ],
      "created_on": 1656656767
    }
  ],
  "code": 200,
  "message": "Successful request",
  "pagination": {
    "total_records": 0,
    "page": 0,
    "records_per_page": 0
  }
}

401

Access token is missing or invalid

403

Access denied

409

Payment Method not found

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

422

Request failed due to invalid data provided

application/json

Schema

Schema

status string

Possible values: [error]

data object
code integer

Possible values: [422]

message string

Example (from schema)

{
  "status": "error",
  "data": {
    "dob": {
      "day": "Value expected to be 'integer', 'string' given."
    }
  },
  "code": 422,
  "message": "cannot process the provided entity"
}

500

Server error

Loading...