Request Invoice Review

POST

/api/v1/cashflow/invoice-reviews

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/cashflow/invoice-reviews \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "connection_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expected_artifact_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "feedback": "example", "request_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Local development

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

InvoiceReviewRequest

object

connection_id

required

Connection Id

string format: uuid

expected_artifact_id

Any of:

string

string format: uuid

null

null

feedback

Any of:

string

string

<= 4000 characters

null

null

request_id

required

Request Id

string format: uuid

Example^generated

{
  "connection_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "expected_artifact_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "feedback": "example",
  "request_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Successful Response

Media typeapplication/json

InvoiceReviewDetail

object

artifact

required

Any of:

InvoiceMemo

InvoiceMemo

object

content

required

Content

string

created_at

required

Created At

string format: date-time

id

required

Id

string

source

required

Source

object

key

additional properties

any

version

required

Version

integer

null

null

connection_id

required

Connection Id

string

credits_consumed

required

Credits Consumed

integer

dispatch_pending

Dispatch Pending

boolean

error

required

Any of:

string

string

null

null

expected_artifact_id

required

Any of:

string

string

null

null

feedback

required

Any of:

string

string

null

null

provenance_decision_id

required

Any of:

string

string

null

null

receipts

required

InvoiceReviewReceipts

object

audit_entry_ids

required

Audit Entry Ids

Array<integer>

credit_holds

required

Credit Holds

Array<object>

object

key

additional properties

any

tool

required

Any of:

object

object

key

additional properties

any

null

null

request_id

required

Request Id

string

review

required

Any of:

InvoiceMemoReview

InvoiceMemoReview

object

approval_token

required

Any of:

string

string

null

null

decision_id

required

Decision Id

string

feedback

required

Any of:

string

string

null

null

status

required

Status

string

null

null

status

required

Status

string

task_id

required

Task Id

string

thread_id

required

Thread Id

string

verification_warnings

required

Verification Warnings

Array<string>

Example

{
  "dispatch_pending": false
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}