Skip to content
vocapable.Docs

Accounting invoice references of a quote

GET
/v1/workspace/quotes/{quote_id}/accounting
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/quotes/example/accounting \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
quote_id
required
Quote Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceQuoteAccounting
object
ledgers
required
Ledgers
Array<object>
WorkspaceBusinessSystem

One connected system that could take this record, and why it can’t yet.

object
installation_id
required
Installation Id
string
provider
required
Provider
string
label
required
Any of:
string
environment
required
Environment
string
Allowed values: test live
ready
required
Ready
boolean
blockers
required
Blockers
Array<string>
invoices
required
Invoices
Array<object>
WorkspaceAccountingInvoice
object
id
required
Id
string
quote_id
required
Quote Id
string
quote_version_id
required
Quote Version Id
string
installation_id
required
Installation Id
string
provider
required
Provider
string
Allowed values: quickbooks xero
status
required
Status
string
Allowed values: queued created
delivery
required
WorkspaceBusinessDelivery

Where the provider operation behind a record stands (Connection activity has the full history). failed/held records are retried by reconciling first.

object
state
required
State
string
Allowed values: not_started pending succeeded failed uncertain held
error_class
required
Any of:
string
can_retry
required
Can Retry
boolean
ledger_state
required
Any of:
string
Allowed values: draft open partially_paid paid voided deleted
number
required
Any of:
string
external_invoice_id
required
Any of:
string
external_customer_id
required
Any of:
string
currency
required
Currency
string
total_minor
required
Total Minor
integer
balance_minor
required
Any of:
integer
amount_paid_minor
required
Any of:
integer
superseded
required
Superseded
boolean
last_synced_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
Example
{
  "ledgers": [
    {
      "environment": "test"
    }
  ],
  "invoices": [
    {
      "provider": "quickbooks",
      "status": "queued",
      "delivery": {
        "state": "not_started"
      },
      "ledger_state": "draft"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}