Socotra

Socotra Billing API

The Billing API from Socotra — 124 operation(s) for billing.

GitHub OpenAPI
Business capability
Premium Accounting Management BC-2150

Operations 135

GET /billing/{tenantLocator}/payments/{locator} Fetch payment #
PUT /billing/{tenantLocator}/payments/{locator} Update payment overwrite data #
PATCH /billing/{tenantLocator}/payments/{locator} Update payment #
GET /billing/{tenantLocator}/disbursements/{locator} Fetch disbursement #
PUT /billing/{tenantLocator}/disbursements/{locator} Update disbursement replace data #
PATCH /billing/{tenantLocator}/disbursements/{locator} Update disbursement #
GET /billing/{tenantLocator}/creditDistributions/{locator} Fetch credit distribution #
PUT /billing/{tenantLocator}/creditDistributions/{locator} Create or replace credit distribution #
PATCH /billing/{tenantLocator}/creditDistributions/{locator} Update credit distribution #
POST /billing/{tenantLocator}/writeOffs Write off #
POST /billing/{tenantLocator}/retryJobs/{policyLocator}/retryFailedTransactions Retry failed transactions #
POST /billing/{tenantLocator}/payments Create payment #
POST /billing/{tenantLocator}/payments/{locator}/number/set Set payment number #
POST /billing/{tenantLocator}/payments/{locator}/number/generate Generate payment number #
POST /billing/{tenantLocator}/jobs/delinquencies/moratoriums Run delinquency moratoriums workflow #
POST /billing/{tenantLocator}/invoices Create aggregated invoice #
POST /billing/{tenantLocator}/invoices/{locator}/transfer Transfer invoices between aggregated invoices #
POST /billing/{tenantLocator}/invoices/{locator}/settle Settle negative or zero invoice #
POST /billing/{tenantLocator}/invoices/{locator}/number/set Set invoice number #
POST /billing/{tenantLocator}/invoices/{locator}/number/generate Generate invoice number #
POST /billing/{tenantLocator}/invoices/earlyInvoicing Initiate early invoicing #
POST /billing/{tenantLocator}/holds Create hold #
POST /billing/{tenantLocator}/financialInstruments Create financial instrument #
POST /billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault Set financial instrument as default #
POST /billing/{tenantLocator}/disbursements Create disbursement #
POST /billing/{tenantLocator}/disbursements/{locator}/number/set Set disbursement number #
POST /billing/{tenantLocator}/disbursements/{locator}/number/generate Generate disbursement number #
POST /billing/{tenantLocator}/creditDistributions Create credit distribution #
POST /billing/{tenantLocator}/accounts/{accountLocator}/charges Add charges #
POST /billing/{tenantLocator}/accounts/{accountLocator}/charges/reverse Reverse charges #
PATCH /billing/{tenantLocator}/writeOffs/{locator}/reverse Reverse write off #
PATCH /billing/{tenantLocator}/payments/{locator}/validate Validate payment #
PATCH /billing/{tenantLocator}/payments/{locator}/reverse Reverse payment #
PATCH /billing/{tenantLocator}/payments/{locator}/reset Reset payment #
PATCH /billing/{tenantLocator}/payments/{locator}/request Execute payment #
PATCH /billing/{tenantLocator}/payments/{locator}/post Post payment #
PATCH /billing/{tenantLocator}/payments/{locator}/fail Fail payment #
PATCH /billing/{tenantLocator}/payments/{locator}/discard Discard payment #
PATCH /billing/{tenantLocator}/payments/{locator}/cancel Cancel payment #
GET /billing/{tenantLocator}/invoices/{locator} Get invoice with items #
PATCH /billing/{tenantLocator}/invoices/{locator} Update invoice #
PATCH /billing/{tenantLocator}/invoices/{locator}/writeOff Write off invoice #
PATCH /billing/{tenantLocator}/invoices/{locator}/aggregated Patch aggregated invoice #
PATCH /billing/{tenantLocator}/installments Update installments #
GET /billing/{tenantLocator}/holds/{locator} Fetch hold #
PATCH /billing/{tenantLocator}/holds/{locator} Update hold #
PATCH /billing/{tenantLocator}/holds/{locator}/validate Validate hold #
PATCH /billing/{tenantLocator}/holds/{locator}/reset Reset hold #
PATCH /billing/{tenantLocator}/holds/{locator}/release Release hold #
PATCH /billing/{tenantLocator}/holds/{locator}/discard Discard hold #
PATCH /billing/{tenantLocator}/holds/{locator}/activate Activate hold #
GET /billing/{tenantLocator}/financialInstruments/{locator} Fetch financial instrument #
PATCH /billing/{tenantLocator}/financialInstruments/{locator} Update financial instrument #
PATCH /billing/{tenantLocator}/disbursements/{locator}/validate Validate disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/reverse Reverse disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/reset Reset disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/reject Reject disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/execute Execute disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/discard Discard disbursement #
PATCH /billing/{tenantLocator}/disbursements/{locator}/approve Approve disbursement #
GET /billing/{tenantLocator}/delinquencies/{locator} Get delinquency #
PATCH /billing/{tenantLocator}/delinquencies/{locator} Update delinquency #
GET /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator} Fetch delinquency event #
PATCH /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator} Update delinquency event #
PATCH /billing/{tenantLocator}/creditDistributions/{locator}/validate Validate credit distribution #
PATCH /billing/{tenantLocator}/creditDistributions/{locator}/reverse Reverse credit distribution #
PATCH /billing/{tenantLocator}/creditDistributions/{locator}/reset Reset credit distribution #
PATCH /billing/{tenantLocator}/creditDistributions/{locator}/execute Execute credit distribution #
PATCH /billing/{tenantLocator}/creditDistributions/{locator}/discard Discard credit distribution #
PATCH /billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds Handle excess funds #
GET /billing/{tenantLocator}/writeOffs/{locator} Fetch write off #
GET /billing/{tenantLocator}/writeOffs/list Fetch multiple write offs #
GET /billing/{tenantLocator}/transactions/{transactionLocator}/charges/list Fetch charges by transaction #
GET /billing/{tenantLocator}/shortfallCredits/{locator} Fetch shortfall credit #
GET /billing/{tenantLocator}/shortfallCredits/list Fetch multiple shortfall credits #
GET /billing/{tenantLocator}/settings/{locator} Fetch installment lattice settings #
GET /billing/{tenantLocator}/policies/{policyLocator}/charges/list Fetch charges by policy #
GET /billing/{tenantLocator}/payments/{locator}/subpayments/list Fetch subpayments #
GET /billing/{tenantLocator}/payments/{locator}/shortfallCredits/list List shortfall credits #
GET /billing/{tenantLocator}/payments/{locator}/previewValidate Preview payment validate #
GET /billing/{tenantLocator}/payments/{locator}/previewPost Preview payment post #
GET /billing/{tenantLocator}/payments/{locator}/invoices/list Fetch invoices targeted by APayment #
GET /billing/{tenantLocator}/payments/numbers/{paymentNumber} Fetch payments with number #
GET /billing/{tenantLocator}/payments/list Fetch multiple payments #
GET /billing/{tenantLocator}/jobs/paymentExecutions/{locator} Fetch payment execution job data #
GET /billing/{tenantLocator}/jobs/invoicing/{jobLocator} Fetch invoicing job #
GET /billing/{tenantLocator}/jobs/invoicing/accounts/{locator}/list Fetch invoicing jobs for account #
GET /billing/{tenantLocator}/jobs/invoicesLifecycle/{locator} Fetch invoice lifecycle job data #
GET /billing/{tenantLocator}/jobs/invoices/accounts/{locator}/list Fetch invoice job data for account #
GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/list Fetch installments job data for transactions #
GET /billing/{tenantLocator}/jobs/installments/quotes/{locator}/list Fetch installments job data for quotes #
GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list Fetch delinquency grace job #
GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list Fetch delinquency event jobs #
GET /billing/{tenantLocator}/jobs/delinquencies/moratoriums/list Fetch delinquency moratorium jobs for tenant #
GET /billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list Fetch create delinquencies job data for invoice #
GET /billing/{tenantLocator}/invoices/{locator}/payments/list Fetch payments for an invoice #
GET /billing/{tenantLocator}/invoices/{locator}/invoices/list Fetch invoices for aggregated invoice #
GET /billing/{tenantLocator}/invoices/{locator}/details Fetch invoice details #
GET /billing/{tenantLocator}/invoices/{locator}/credits/list Fetch credits for an invoice #
GET /billing/{tenantLocator}/invoices/{locator}/creditDistributions/list Fetch credit distributions for an invoice #
GET /billing/{tenantLocator}/invoices/{invoiceLocator}/debits/list Fetch debits for an invoice #
GET /billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoices Preview invoices for transaction #
GET /billing/{tenantLocator}/invoices/quotes/{quoteLocator}/list Fetch invoices for quote #
GET /billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoices Preview invoices for quote #
GET /billing/{tenantLocator}/invoices/quotes/statelessPreview Preview invoices for stateless quote #
GET /billing/{tenantLocator}/invoices/policies/{policyLocator}/list Fetch invoices for policy #
GET /billing/{tenantLocator}/invoices/numbers/{invoiceNumber} Fetch invoice with number #
GET /billing/{tenantLocator}/invoices/accounts/{accountLocator}/list Fetch invoices for account #
GET /billing/{tenantLocator}/installments/{installmentLocator} Fetch installment by locator #
GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list Fetch installments for policy transaction #
GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list Fetch installments for quote #
GET /billing/{tenantLocator}/installments/quotes/statelessPreview Preview installments for stateless quote #
GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list Fetch installments for policy #
GET /billing/{tenantLocator}/installmentLattices/{installmentLatticeLocator} Fetch installment lattice by locator #
GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator} Fetch latest installment lattice by quote locator #
GET /billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list Fetch installment lattices by policy locator #
GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list Fetch all holds for an account #
GET /billing/{tenantLocator}/financialInstruments/list List financial instruments #
GET /billing/{tenantLocator}/externalCashTransactions/{locator} Fetch external cash transaction #
GET /billing/events Fetch billing event definitions #
GET /billing/{tenantLocator}/disbursements/numbers/{disbursementNumber} Fetch disbursements with number #
GET /billing/{tenantLocator}/disbursements/list Fetch multiple disbursements #
GET /billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list Fetch delinquency events #
GET /billing/{tenantLocator}/delinquencies/suspended/list Get suspended delinquencies #
GET /billing/{tenantLocator}/delinquencies/policies/{policyLocator}/list Get delinquencies for policy #
GET /billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list Get delinquencies for invoice #
GET /billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list Get delinquencies for account #
GET /billing/{tenantLocator}/credits/list Fetch credits #
GET /billing/{tenantLocator}/creditDistributions/{locator}/invoices/list Fetch invoices targeted by ACredit distribution #
GET /billing/{tenantLocator}/creditDistributions/list Fetch multiple credit distributions #
GET /billing/{tenantLocator}/accounts/{accountLocator}/charges/list Fetch charges by account #
GET /billing/{tenantLocator}/accounting/ledgerAccounts/{refType}/{refLocator} Fetch ledger account #
GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash Fetch tenant level cash balance #
GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash/list Fetch multiple ledger cash accounts #
GET /billing/{tenantLocator}/accounting/faTransactions/{locator} Fetch accounting transaction #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-billing-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/socotra-billing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

socotra-billing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Socotra Insurance Suite OpenAPI Definition Billing API
  description: Socotra Insurance Suite API
  termsOfService: https://www.socotra.com
  version: v0
servers:
- url: /
  description: Generated server url
tags:


# --- truncated at 32 KB (267 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-billing-api-openapi.yml