Skip to content
Invogi Docs

Read a CSV or Excel statement with chosen columns (ANALYST+, dashboard user)

POST
/statements/{statementId}/layout
curl --request POST \
  --url https://api.invogi.com/v1/statements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "columns": { "date": "example", "type": "example", "reference": "example", "description": "example", "debit": "example", "credit": "example", "amount": "example", "balance": "example", "dueDate": "example" }, "invertAmount": true, "dayFirst": true }'

The columns are remembered for the statement’s supplier and used for its later statements.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
statementId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
columns
required

The header for each column read; date and an amount (amount, or debit and/or credit) are needed

object
date
string
type
string
reference
string
description
string
debit
string
credit
string
amount
string
balance
string
dueDate
string
invertAmount

The single amount column shows payments and credits as positive

boolean
dayFirst

03/04/2026 is 3 April (default true)

boolean

Example generated

{
  "columns": {
    "date": "example",
    "type": "example",
    "reference": "example",
    "description": "example",
    "debit": "example",
    "credit": "example",
    "amount": "example",
    "balance": "example",
    "dueDate": "example"
  },
  "invertAmount": true,
  "dayFirst": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The statement

Media typeapplication/json
object
id
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
lineCount

List only

integer
supplierNameRaw

As printed on the statement

string | null
supplierTaxIdRaw

As printed on the statement

string | null
supplierMatchMethod

How the supplier was found

string | null
Allowed values: SENDER CONTACT TAX_ID NAME TITLE_TEXT PERSON
extractionMethods
Array<string>
pageCount
integer | null
layout

CSV/Excel only: the headers found, the column layout used, and a sample of rows

object | null
skippedRows
integer
lines
Array<object>
object
id
string format: uuid
lineNumber
integer
txnDate
string | null format: date
type
string
Allowed values: INVOICE CREDIT_NOTE PAYMENT ADJUSTMENT OTHER
reference
string | null
description
string | null
amount

Signed; positive adds to what the customer owes

string
balance

Running balance as printed

string | null
dueDate
string | null format: date
duplicate

Upload only

boolean

Example 

{
  "status": "PROCESSING",
  "reviewReasons": [
    "UNKNOWN_SUPPLIER"
  ],
  "source": "UPLOAD",
  "balanceCheck": "BALANCED",
  "supplierMatchMethod": "SENDER",
  "lines": [
    {
      "type": "INVOICE"
    }
  ]
}

400

Section titled “400”

Invalid request

Media typeapplication/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"
  }
}

404

Section titled “404”

Resource not found

Media typeapplication/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"
  }
}