How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Socotra

Socotra Billing API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Socotra Billing API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 135 operations across 124 paths, and defines 160 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

135 operations 124 paths 160 schemas 73 GET38 PATCH21 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
View terms
Resource Areas
1

Paths & Operations 135

Across 124 paths, the API surfaces 135 operations — 73 GET, 38 PATCH, 21 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Billing 135
GET
/billing/{tenantLocator}/payments/{locator}
fetchPayment 2 params → 200
PUT
/billing/{tenantLocator}/payments/{locator}
updatePaymentOverwriteData 2 params body → 200
PATCH
/billing/{tenantLocator}/payments/{locator}
updatePayment 2 params body → 200
GET
/billing/{tenantLocator}/disbursements/{locator}
fetchDisbursement 2 params → 200
PUT
/billing/{tenantLocator}/disbursements/{locator}
Updates the disbursement and replaces all existing data extensions with the data.
updateDisbursementReplaceData 2 params body → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}
updateDisbursement 2 params body → 200
GET
/billing/{tenantLocator}/creditDistributions/{locator}
fetchCreditDistribution 2 params → 200
PUT
/billing/{tenantLocator}/creditDistributions/{locator}
createOrReplaceCreditDistribution 2 params body → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}
updateCreditDistribution 2 params body → 200
POST
/billing/{tenantLocator}/writeOffs
writeOff 1 param body → 200
POST
/billing/{tenantLocator}/retryJobs/{policyLocator}/retryFailedTransactions
retryFailedTransactions 2 params → 200
POST
/billing/{tenantLocator}/payments
createPayment 1 param body → 200
POST
/billing/{tenantLocator}/payments/{locator}/number/set
setPaymentNumber 3 params → 200
POST
/billing/{tenantLocator}/payments/{locator}/number/generate
generatePaymentNumber 2 params → 200
POST
/billing/{tenantLocator}/jobs/delinquencies/moratoriums
runDelinquencyMoratoriumsWorkflow 1 param → 200
POST
/billing/{tenantLocator}/invoices
createAggregatedInvoice 1 param body → 200
POST
/billing/{tenantLocator}/invoices/{locator}/transfer
transferInvoicesBetweenAggregatedInvoices 2 params body → 200
POST
/billing/{tenantLocator}/invoices/{locator}/settle
settleNegativeOrZeroInvoice 3 params → 200
POST
/billing/{tenantLocator}/invoices/{locator}/number/set
setInvoiceNumber 3 params → 200
POST
/billing/{tenantLocator}/invoices/{locator}/number/generate
generateInvoiceNumber 2 params → 200
POST
/billing/{tenantLocator}/invoices/earlyInvoicing
initiateEarlyInvoicing 1 param body → 200
POST
/billing/{tenantLocator}/holds
createHold 1 param body → 200
POST
/billing/{tenantLocator}/financialInstruments
createFinancialInstrument 1 param body → 200
POST
/billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault
setFinancialInstrumentAsDefault 3 params → 200
POST
/billing/{tenantLocator}/disbursements
createDisbursement 1 param body → 200
POST
/billing/{tenantLocator}/disbursements/{locator}/number/set
setDisbursementNumber 3 params → 200
POST
/billing/{tenantLocator}/disbursements/{locator}/number/generate
generateDisbursementNumber 2 params → 200
POST
/billing/{tenantLocator}/creditDistributions
createCreditDistribution 1 param body → 200
POST
/billing/{tenantLocator}/accounts/{accountLocator}/charges
addCharges 2 params body → 200
POST
/billing/{tenantLocator}/accounts/{accountLocator}/charges/reverse
reverseCharges 2 params body → 200
PATCH
/billing/{tenantLocator}/writeOffs/{locator}/reverse
reverseWriteOff 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/validate
validatePayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/reverse
reversePayment 2 params body → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/reset
resetPayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/request
executePayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/post
postPayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/fail
failPayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/discard
discardPayment 2 params → 200
PATCH
/billing/{tenantLocator}/payments/{locator}/cancel
cancelPayment 2 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}
getInvoiceWithItems 2 params → 200
PATCH
/billing/{tenantLocator}/invoices/{locator}
updateInvoice 2 params body → 200
PATCH
/billing/{tenantLocator}/invoices/{locator}/writeOff
writeOffInvoice 2 params → 200
PATCH
/billing/{tenantLocator}/invoices/{locator}/aggregated
patchAggregatedInvoice 2 params body → 200
PATCH
/billing/{tenantLocator}/installments
updateInstallments 1 param body → 200
GET
/billing/{tenantLocator}/holds/{locator}
fetchHold 2 params → 200
PATCH
/billing/{tenantLocator}/holds/{locator}
updateHold 2 params body → 200
PATCH
/billing/{tenantLocator}/holds/{locator}/validate
validateHold 2 params → 200
PATCH
/billing/{tenantLocator}/holds/{locator}/reset
resetHold 2 params → 200
PATCH
/billing/{tenantLocator}/holds/{locator}/release
releaseHold 2 params → 200
PATCH
/billing/{tenantLocator}/holds/{locator}/discard
discardHold 2 params → 200
PATCH
/billing/{tenantLocator}/holds/{locator}/activate
activateHold 2 params → 200
GET
/billing/{tenantLocator}/financialInstruments/{locator}
fetchFinancialInstrument 2 params → 200
PATCH
/billing/{tenantLocator}/financialInstruments/{locator}
updateFinancialInstrument 2 params body → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/validate
validateDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/reverse
reverseDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/reset
resetDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/reject
rejectDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/execute
executeDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/discard
discardDisbursement 2 params → 200
PATCH
/billing/{tenantLocator}/disbursements/{locator}/approve
approveDisbursement 2 params → 200
GET
/billing/{tenantLocator}/delinquencies/{locator}
getDelinquency 2 params → 200
PATCH
/billing/{tenantLocator}/delinquencies/{locator}
updateDelinquency 2 params body → 200
GET
/billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
fetchDelinquencyEvent 2 params → 200
PATCH
/billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
updateDelinquencyEvent 2 params body → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}/validate
validateCreditDistribution 2 params → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}/reverse
reverseCreditDistribution 2 params body → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}/reset
resetCreditDistribution 2 params → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}/execute
executeCreditDistribution 2 params → 200
PATCH
/billing/{tenantLocator}/creditDistributions/{locator}/discard
discardCreditDistribution 2 params → 200
PATCH
/billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds
handleExcessFunds 3 params → 200
GET
/billing/{tenantLocator}/writeOffs/{locator}
fetchWriteOff 2 params → 200
GET
/billing/{tenantLocator}/writeOffs/list
fetchMultipleWriteOffs 5 params → 200
GET
/billing/{tenantLocator}/transactions/{transactionLocator}/charges/list
fetchChargesByTransaction 5 params → 200
GET
/billing/{tenantLocator}/shortfallCredits/{locator}
fetchShortfallCredit 2 params → 200
GET
/billing/{tenantLocator}/shortfallCredits/list
fetchMultipleShortfallCredits 5 params → 200
GET
/billing/{tenantLocator}/settings/{locator}
fetchInstallmentLatticeSettings 2 params → 200
GET
/billing/{tenantLocator}/policies/{policyLocator}/charges/list
fetchChargesByPolicy 4 params → 200
GET
/billing/{tenantLocator}/payments/{locator}/subpayments/list
fetchSubpayments 4 params → 200
GET
/billing/{tenantLocator}/payments/{locator}/shortfallCredits/list
listShortfallCredits 4 params → 200
GET
/billing/{tenantLocator}/payments/{locator}/previewValidate
previewPaymentValidate 2 params → 200
GET
/billing/{tenantLocator}/payments/{locator}/previewPost
previewPaymentPost 2 params → 200
GET
/billing/{tenantLocator}/payments/{locator}/invoices/list
fetchInvoicesTargetedByAPayment 6 params → 200
GET
/billing/{tenantLocator}/payments/numbers/{paymentNumber}
fetchPaymentsWithNumber 2 params → 200
GET
/billing/{tenantLocator}/payments/list
fetchMultiplePayments 6 params → 200
GET
/billing/{tenantLocator}/jobs/paymentExecutions/{locator}
fetchPaymentExecutionJobData 2 params → 200
GET
/billing/{tenantLocator}/jobs/invoicing/{jobLocator}
fetchInvoicingJob 2 params → 200
GET
/billing/{tenantLocator}/jobs/invoicing/accounts/{locator}/list
fetchInvoicingJobsForAccount 4 params → 200
GET
/billing/{tenantLocator}/jobs/invoicesLifecycle/{locator}
fetchInvoiceLifecycleJobData 2 params → 200
GET
/billing/{tenantLocator}/jobs/invoices/accounts/{locator}/list
fetchInvoiceJobDataForAccount 5 params → 200
GET
/billing/{tenantLocator}/jobs/installments/transactions/{locator}/list
fetchInstallmentsJobDataForTransactions 5 params → 200
GET
/billing/{tenantLocator}/jobs/installments/quotes/{locator}/listdeprecated
fetchInstallmentsJobDataForQuotes 5 params → 200
GET
/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list
fetchDelinquencyGraceJob 5 params → 200
GET
/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list
fetchDelinquencyEventJobs 4 params → 200
GET
/billing/{tenantLocator}/jobs/delinquencies/moratoriums/list
fetchDelinquencyMoratoriumJobsForTenant 3 params → 200
GET
/billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list
fetchCreateDelinquenciesJobDataForInvoice 5 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}/payments/list
fetchPaymentsForAnInvoice 6 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}/invoices/list
fetchInvoicesForAggregatedInvoice 4 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}/details
fetchInvoiceDetails 2 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}/credits/list
fetchCreditsForAnInvoice 6 params → 200
GET
/billing/{tenantLocator}/invoices/{locator}/creditDistributions/list
fetchCreditDistributionsForAnInvoice 6 params → 200
GET
/billing/{tenantLocator}/invoices/{invoiceLocator}/debits/list
fetchDebitsForAnInvoice 5 params → 200
GET
/billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoices
previewInvoicesForTransaction 4 params → 200
GET
/billing/{tenantLocator}/invoices/quotes/{quoteLocator}/list
fetchInvoicesForQuote 6 params → 200
GET
/billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoices
previewInvoicesForQuote 4 params → 200
GET
/billing/{tenantLocator}/invoices/quotes/statelessPreview
previewInvoicesForStatelessQuote 4 params → 200
GET
/billing/{tenantLocator}/invoices/policies/{policyLocator}/list
fetchInvoicesForPolicy 6 params → 200
GET
/billing/{tenantLocator}/invoices/numbers/{invoiceNumber}
fetchInvoiceWithNumber 2 params → 200
GET
/billing/{tenantLocator}/invoices/accounts/{accountLocator}/list
fetchInvoicesForAccount 6 params → 200
GET
/billing/{tenantLocator}/installments/{installmentLocator}
fetchInstallmentByLocator 2 params → 200
GET
/billing/{tenantLocator}/installments/transactions/{transactionLocator}/list
fetchInstallmentsForPolicyTransaction 5 params → 200
GET
/billing/{tenantLocator}/installments/quotes/{quoteLocator}/list
fetchInstallmentsForQuote 5 params → 200
GET
/billing/{tenantLocator}/installments/quotes/statelessPreview
previewInstallmentsForStatelessQuote 2 params → 200
GET
/billing/{tenantLocator}/installments/policies/{policyLocator}/list
fetchInstallmentsForPolicy 5 params → 200
GET
/billing/{tenantLocator}/installmentLattices/{installmentLatticeLocator}
fetchInstallmentLatticeByLocator 2 params → 200
GET
/billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}
fetchLatestInstallmentLatticeByQuoteLocator 2 params → 200
GET
/billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list
fetchInstallmentLatticesByPolicyLocator 5 params → 200
GET
/billing/{tenantLocator}/holds/accounts/{accountLocator}/list
fetchAllHoldsForAnAccount 6 params → 200
GET
/billing/{tenantLocator}/financialInstruments/list
listFinancialInstruments 5 params → 200
GET
/billing/{tenantLocator}/externalCashTransactions/{locator}
fetchExternalCashTransaction 2 params → 200
GET
/billing/events
fetchBillingEventDefinitions → 200
GET
/billing/{tenantLocator}/disbursements/numbers/{disbursementNumber}
fetchDisbursementsWithNumber 2 params → 200
GET
/billing/{tenantLocator}/disbursements/list
fetchMultipleDisbursements 5 params → 200
GET
/billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list
fetchDelinquencyEvents 4 params → 200
GET
/billing/{tenantLocator}/delinquencies/suspended/list
getSuspendedDelinquencies 5 params → 200
GET
/billing/{tenantLocator}/delinquencies/policies/{policyLocator}/list
getDelinquenciesForPolicy 5 params → 200
GET
/billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list
getDelinquenciesForInvoice 5 params → 200
GET
/billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list
getDelinquenciesForAccount 5 params → 200
GET
/billing/{tenantLocator}/credits/list
fetchCredits 5 params → 200
GET
/billing/{tenantLocator}/creditDistributions/{locator}/invoices/list
fetchInvoicesTargetedByACreditDistribution 5 params → 200
GET
/billing/{tenantLocator}/creditDistributions/list
fetchMultipleCreditDistributions 5 params → 200
GET
/billing/{tenantLocator}/accounts/{accountLocator}/charges/list
fetchChargesByAccount 4 params → 200
GET
/billing/{tenantLocator}/accounting/ledgerAccounts/{refType}/{refLocator}
fetchLedgerAccount 5 params → 200
GET
/billing/{tenantLocator}/accounting/ledgerAccounts/cash
fetchTenantLevelCashBalance 2 params → 200
GET
/billing/{tenantLocator}/accounting/ledgerAccounts/cash/list
fetchMultipleLedgerCashAccounts 6 params → 200
GET
/billing/{tenantLocator}/accounting/faTransactions/{locator}
fetchAccountingTransaction 2 params → 200

Schemas 160

The contract defines 160 schemas that model the data the API accepts and returns. The most detailed are Installment (28 properties), PaymentResponse (26 properties), PreviewPaymentResponse (20 properties), InvoiceResponse (18 properties). Each schema is shown below with its type and property counts.

CreditListResponse
object
2 properties 2 required
PaymentExecutionJobData
object
2 properties 2 required
ExecutionAttempt
object
5 properties 2 required
FinancialInstrumentCreateRequest
object
9 properties
ShortfallEventData
object
1 property 1 required
CreditDistributionListResponse
object
2 properties 2 required
DelinquencyCreateJobDataListResponse
object
2 properties 2 required
CreditResponse
object
10 properties 6 required
DelinquencyEvents
object
3 properties
ExcludedDebitsAmountResult
object
4 properties 4 required
ShortfallCreditResponse
object
11 properties 10 required
ExternalCashTransactionResponse
object
4 properties 2 required
CreditItem
object
3 properties 2 required
InvoiceEvents
object
5 properties
AggregatedInvoiceCreateRequest
object
7 properties 2 required
InvoiceSummaryView
object
17 properties 10 required
ListPageResponseInstallmentJobData
object
2 properties 2 required
InvoiceLifecycleTriggerUpdate
object
4 properties 4 required
AccountLineItem
object
4 properties 4 required
ListPageResponseInvoicePaymentPreview
object
2 properties 2 required
InvoicePaymentPreview
object
5 properties 3 required
NumberingEventData
object
1 property 1 required
AggregatedInvoiceTransferRequest
object
2 properties 2 required
DebitResponse
object
6 properties 4 required
SuspendedDelinquencyListResponse
object
2 properties 2 required
InvoiceSettledEventData
object
4 properties 4 required
ListPageResponseCreditDistributionResponse
object
2 properties 2 required
WorkflowContextDelinquencyMoratoriumJobData
object
5 properties 4 required
InstallmentJobData
object
8 properties 8 required
QuoteBillingPreviewRequest
object
10 properties 5 required
CreditDistributionEventData
object
1 property 1 required
InvoiceSummary
object
4 properties 1 required
WriteOffResponse
object
11 properties 9 required
DisbursementListResponse
object
2 properties 2 required
WriteOffEvents
object
3 properties
ValidationResult
object
2 properties 1 required
EarlyInvoicingGenerationData
object
2 required
Settings
object
4 properties 4 required
WriteOffTarget
object
3 properties 2 required
InvoiceItemSummary
object
11 properties 6 required
CreditDistributionPutRequest
object
5 properties 3 required
PaymentUpdateRequest
object
15 properties 4 required
InvoiceAutopayData
object
5 properties 5 required
InstallmentEvents
object
1 property
PreviewChargeRequest
object
4 properties 2 required
InstallmentLatticeResponse
object
16 properties 11 required
DisbursementEvents
object
6 properties
InvoiceLifecycleJobData
object
5 properties 4 required
InvoicingData
object
1 property 1 required
FlatChargeSummary
object
5 properties 1 required
InstallmentPreferences
object
13 properties 1 required
WorkflowContextPaymentExecutionJobData
object
5 properties 4 required
ChargesReversalRequest
object
2 properties 2 required
CreditDistributionResponse
object
14 properties 9 required
ListPageResponseChargeResponse
object
2 properties 2 required
EarlyInvoicingResponse
object
2 properties 2 required
DisbursementResponse
object
14 properties 9 required
AccountingTransactionResponse
object
5 properties 5 required
FinancialInstrumentResponse
object
11 properties 2 required
ListPageResponseInvoiceSummaryView
object
2 properties 2 required
InvoiceGeneratedEventData
object
5 properties 5 required
SubpaymentResponse
object
2 properties 2 required
GraceJobDataListResponse
object
2 properties 2 required
HoldEvents
object
6 properties
HoldEventData
object
1 property 1 required
DisbursementEventData
object
1 property 1 required
InstallmentItemSummary
object
8 properties 4 required
ChargeQueueItem
object
8 properties 7 required
DelinquencySettings
object
4 properties 3 required
EarlyInvoicingRequest
object
6 properties 2 required
PaymentResponse
object
26 properties 11 required
ChargeCreateRequest
object
6 properties 2 required
WriteOffEventData
object
2 properties 2 required
DelinquencyEventEvents
object
4 properties
InvoiceGenerationJob
object
9 properties 9 required
DisbursementUpdateRequest
object
12 properties 4 required
CreditDistributionUpdateRequest
object
7 properties 4 required
DelinquencyMoratoriumJobsListResponse
object
2 properties 2 required
InvoicePreviewResponse
object
8 properties 8 required
ListPageResponseInvoicingJobData
object
2 properties 2 required
InstallmentLatticeListResponse
object
2 properties 2 required
ConfiguredDelinquencyEvent
object
3 properties 3 required
GraceJobData
object
7 properties 5 required
CreditDistributionCreateRequest
object
5 properties 3 required
InstallmentItem
object
12 properties 10 required
FinancialInstrumentListResponse
object
2 properties 2 required
ListPageResponseShortfallCreditResponse
object
2 properties 2 required
DelinquencyEventJobData
object
12 properties 8 required
InvoiceGenerationJobListResponse
object
2 properties 2 required
DelinquencyCreateJobData
object
8 properties 7 required
InvoiceItemPreview
object
8 properties 6 required
HoldListResponse
object
2 properties 2 required
ChargesCreateRequest
object
4 properties 1 required
InvoiceLifecycleTrigger
object
2 properties 2 required
InvoiceDetailsResponse
object
18 properties 13 required
DelinquencyResponse
object
12 properties 8 required
WriteOffListResponse
object
2 properties 2 required
HoldResponse
object
7 properties 6 required
PaymentCreateRequest
object
12 properties 4 required
InstallmentLatticeFrame
object
10 properties 10 required
HoldCreateRequest
object
2 properties 2 required
ShortfallCreditListResponse
object
2 properties 2 required
InstallmentLatticeCreateData
object
1 property 1 required
DelinquencyEventUpdateRequest
object
2 properties
LedgerAccountLineItem
object
5 properties 5 required
InvoiceListResponse
object
2 properties 2 required
InvoiceItemResponse
object
15 properties 8 required
DelinquencyListResponse
object
2 properties 2 required
DelinquencyUpdateRequest
object
1 property
WriteOffRequest
object
2 properties 2 required
TenantCashBalance
object
2 properties 2 required
HoldUpdateRequest
object
2 properties
ValidationItemResponse
object
3 properties 3 required
ImmediateInvoicingData
object
2 required
SuspendedDelinquency
object
5 properties 5 required
PreviewPaymentResponse
object
20 properties 11 required
Installment
object
28 properties 19 required
InvoicingJobData
object
8 properties 6 required
ListPageResponseULID
object
2 properties 2 required
LedgerAccountListResponse
object
2 properties 2 required
SettingsResponse
object
2 properties 2 required
ChargeResponse
object
14 properties 7 required
CreditDistributionEvents
object
3 properties
CreditDistributionReverseRequest
object
1 property 1 required
ListPageResponsePaymentResponse
object
2 properties 2 required
DelinquencyEventData
object
2 properties 2 required
AccountExcessHandlingResult
object
7 properties 5 required
ChargeMetadata
object
5 properties
DelinquencyEventResponse
object
10 properties 9 required
PaymentRequestExecutionLogItem
object
6 properties 3 required
DelinquencyReference
object
6 properties 4 required
PaymentListResponse
object
2 properties 2 required
InstallmentJobDataListResponse
object
2 properties 2 required
DelinquencyEventEventData
object
3 properties 3 required
ShortfallCreditEvents
object
3 properties
InstallmentSettings
object
12 properties 5 required
InvoiceResponse
object
18 properties 10 required
BillingNumberingEvents
object
3 properties
ShortfallCreditPreviewResponse
object
7 properties 7 required
DelinquencyMoratoriumJobData
object
4 properties 4 required
ListPageResponseDebitResponse
object
2 properties 2 required
ExcessCreditCreateDisbursementResult
object
4 properties 3 required
InvoiceLifecycleResult
object
2 properties 2 required
LedgerAccountResponse
object
5 properties 5 required
DelinquencyEventJobDataListResponse
object
2 properties 2 required
ExcludedDebit
object
2 properties 2 required
BillingServiceEventTypeDefinitions
object
11 properties 11 required
WorkflowContextInvoiceLifecycleJobData
object
5 properties 4 required
InstallmentListResponse
object
2 properties 2 required
DisbursementUpdateReplaceDataRequest
object
10 properties 5 required
CreditWithBalance
object
3 properties 3 required
InstallmentsPreview
object
9 properties 6 required
PaymentEventData
object
2 properties 2 required
AggregatedInvoicePatchRequest
object
7 properties 2 required
PatchInstallmentsRequest
object
4 properties 1 required
DelinquencyEventsResponse
object
4 properties 4 required
InvoiceGenerationInstance
object
9 properties 9 required
DisbursementCreateRequest
object
10 properties 5 required
InvoiceUpdateRequest
object
2 properties 2 required
PaymentEvents
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-billing-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
AE Profile APIs.io
Socotra Auxdata API
AE Profile APIs.io
Socotra Business Stats API
AE Profile APIs.io
Socotra Claim API
AE Profile APIs.io
Socotra Compliance API
AE Profile APIs.io
Socotra Config API
AE Profile APIs.io
Socotra Contact API
AE Profile APIs.io
Socotra Document API
AE Profile APIs.io
Socotra Event API
AE Profile APIs.io
Socotra Migration API
AE Profile APIs.io
Socotra Payment Execution API
AE Profile APIs.io
Socotra Plugin API
AE Profile APIs.io
#Billing
← Back to S APIs
API Details
ID
socotra:socotra-billing-api
Base URL
https://api.sandbox.socotra.com
Docs
https://docs.socotra.com/docs/api
Provider
Socotra
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=socotra-billing-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/socotra-billing-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Socotra Billing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.