e-Próspera
Reference

Pay an amendment filing with a voucher

View as Markdown
POST
/api/v1/legal_entities/{id}/amendments/{filingId}/pay/voucher

The filing must be signed first (see nextSteps.signatureUrl). Creates the filing invoice when needed, applies the voucher, and submits the amendment for review when the voucher covers the full amount. Invoice preparation happens before voucher validation, so an invalid voucher can leave a locked Pending Payment filing with an unpaid invoice. Read state before retrying after errors/timeouts. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed agent:entity.filing.* scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: agent:entity.filing.pay.

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Authorization

AuthorizationBearer <token>

Personal standard API key. Send it as Authorization: Bearer sk-... and never delegate it.

In: header

Path Parameters

id*string
Formatuuid
filingId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/legal_entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/amendments/497f6eca-6276-4993-bfeb-53cbbbba6f08/pay/voucher" \  -H "Content-Type: application/json" \  -d '{    "voucherCode": "string"  }'
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "legalEntityId": "41192155-f2be-4dd0-9ea4-e32ad94824f7",    "statusId": "Draft",    "proposedChanges": {      "name": "string",      "extension": "string",      "nameStartsWithExtension": true,      "principalOfficeAddress": {        "line1": "string",        "line2": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "string"      }    },    "signed": true,    "signedAt": "2019-08-24T14:15:22Z",    "invoice": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "statusId": "string"    },    "submittedAt": "2019-08-24T14:15:22Z",    "approvedAt": "2019-08-24T14:15:22Z",    "rejectedAt": "2019-08-24T14:15:22Z",    "rejectedReason": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "nextSteps": {      "changesRequired": true,      "signatureUrl": "http://example.com",      "paymentRequired": true,      "reviewDispatchPending": true,      "submitReady": true    }  }}

Update proposed changes on a Draft amendment PATCH

Only `Draft` filings can be changed. Omitted fields are preserved; null clears a proposal. A revision invalidates the previous signature. Invoiced and submitted filings are read-only. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed `agent:entity.filing.*` scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: `agent:entity.filing.create`. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Submit a paid amendment filing for review POST

Use when the invoice was paid outside the voucher endpoint, for example by card in the portal. For the first submission, require `nextSteps.submitReady === true`: a signed, paid, unsubmitted filing in `Pending Payment`. Repeating a submission returns its current state; a pending dispatch is retried without changing the original submission time. Standard keys act on every entity the key owner actively represents. Agent Keys are limited to entities incorporated through the API and need active representation and the listed `agent:entity.filing.*` scope. Agent writes also require an active Manifestation of Will. OAuth tokens and Partner Keys cannot call these filing endpoints. See https://docs.eprospera.com/entity-filings for signing, payment, and recovery. Agent scope: `agent:entity.filing.pay`. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.