List supplier statements, newest first (any role)

GET

/statements

const url = 'https://api.invogi.com/v1/statements?status=PROCESSING';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.invogi.com/v1/statements?status=PROCESSING' \
  --header 'Authorization: Bearer <token>'

Supplier statements read from email (the workspace’s statements address) or upload (docs/35 §14 Release 3). Discarded statements are not listed.

Authorizations

bearerAuth

Parameters

Query Parameters

status

string

Allowed values: PROCESSING NEEDS_REVIEW READY FAILED

supplier_id

string format: uuid

limit

integer

offset

integer

Responses

200

A page of statements

application/json

object

items

Array<object>

object

string format: uuid

status

string

Allowed values: PROCESSING NEEDS_REVIEW READY FAILED

reviewReasons

Array<string>

Allowed values: UNKNOWN_SUPPLIER SUPPLIER_MISMATCH UNBALANCED BALANCE_UNKNOWN NEEDS_LAYOUT NEEDS_PROCESSING_CONSENT UNGROUNDED_VALUES SKIPPED_ROWS

source

string

Allowed values: UPLOAD EMAIL

filename

string | null

mediaType

string

fromAddress

string | null

statementDate

string | null format: date

currency

string | null

openingBalance

Signed; negative is in the customer’s favour

string | null

closingBalance

Signed; negative means the supplier holds the customer’s money

string | null

balanceCheck

Opening balance + lines = closing balance

string | null

Allowed values: BALANCED UNBALANCED UNKNOWN

balanceDifference

string | null

balanceDetail

string | null

error

string | null

reviewedAt

string | null format: date-time

createdAt

string format: date-time

supplier

One of:

null
object

null

lineCount

List only

integer

total

integer

limit

integer

offset

integer

Example

{
  "items": [
    {
      "status": "PROCESSING",
      "reviewReasons": [
        "UNKNOWN_SUPPLIER"
      ],
      "source": "UPLOAD",
      "balanceCheck": "BALANCED"
    }
  ]
}

400

Invalid request

application/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}