Skip to content
vocapable.Docs

Re-read the invoice's state from the ledger

POST
/v1/workspace/accounting-invoices/{invoice_id}/refresh
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/accounting-invoices/example/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
invoice_id
required
Invoice Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceRetryRequest
object
expected_revision
required
Expected Revision
integer
>= 1
Examplegenerated
{
  "expected_revision": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
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
{
  "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": {}
    }
  ]
}