List statement requests (any role)

GET

/statement-requests

const url = 'https://api.invogi.com/v1/statement-requests?status=open&limit=50&offset=0';
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/statement-requests?status=open&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Overdue first (sent, past its reply-by date), then by reply-by date.

Authorizations

bearerAuth

Parameters

Query Parameters

status

string

default: open

Allowed values: open all

limit

integer

default: 50 >= 1 <= 200

offset

integer

Responses

200

Requests

application/json

object

items

Array<object>

object

required

string format: uuid

status

required

string

Allowed values: PREPARED SENT RECEIVED CANCELLED

supplier

required

object

string format: uuid

name

string

contact

object

name

string | null

email

string | null

replyBy

required

string format: date

sentAt

string | null format: date-time

remindedAt

string | null format: date-time

reminderCount

integer

overdue

required

Sent and past its reply-by date

boolean

receivedStatementId

string | null format: uuid

receivedAt

string | null format: date-time

createdAt

string format: date-time

total

integer

Example

{
  "items": [
    {
      "status": "PREPARED"
    }
  ]
}

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"
  }
}