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

Agicap Clients API

The Clients API from Agicap — 1 operation(s) for clients.

Agicap Clients API is one of 52 APIs that Agicap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 1 path, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.agicap.com, https://api.agicap.internal.

4 operations 1 paths 23 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.agicap.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Agicap Clients API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (OPAQUE) (bearerAuth).

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Clients 4
DELETE
/public/ar-clients/v1/entities/{entityId}/clients
Delete clients in bulk by externalId. A client with linked invoices or credit notes cannot be deleted.
Delete clients 1 param body → 200401403429
GET
/public/ar-clients/v1/entities/{entityId}/clients
Retrieve a paginated list of clients for the given entity.
List clients 9 params → 200401403429
POST
/public/ar-clients/v1/entities/{entityId}/clients
Create clients in bulk. Clients with an already existing externalId are ignored. Maximum 1000 items per request.
Create clients 1 param body → 200401403429
PUT
/public/ar-clients/v1/entities/{entityId}/clients
Update clients in bulk by Agicap ID or externalId (Agicap ID takes priority). Non-existing clients are ignored. Maximum 1000 items per request.
Update clients 1 param body → 200401403429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Client (14 properties), ClientToUpdate (6 properties), ClientToCreate (6 properties), DueAmountSummaryItem (4 properties). Each schema is shown below with its type and property counts.

CreateClientsResponse
object
2 properties 2 required
PaginationMetadataDto
object
2 properties 2 required
ClientToUpdate
object
6 properties 3 required
DeleteClientsResponse
object
2 properties 2 required
NotDeletedClient
object
2 properties 2 required
OutstandingAmountSummaryItem
object
4 properties 4 required
ClientSummaryDto
object
2 properties 2 required
DueAmountSummaryItem
object
4 properties 4 required
GetClientsSortByEnum
string
Field to sort clients by. Defaults to a stable identifier order when omitted.
NotUpdatedClient
object
2 properties 2 required
UpdateClientsRequest
object
1 property 1 required
Currency
string
Currency of the outstanding amount.
SortDirectionEnum
string
Sort direction. Defaults to ascending.
DeleteClientsRequest
object
1 property 1 required
NotCreatedClient
object
2 properties 2 required
CreateClientsRequest
object
1 property 1 required
ClientToCreate
object
6 properties 4 required
UpdateClientsResponse
object
2 properties 2 required
UpdatedClient
object
2 properties 2 required
NotUpdatedReasonEnum
string
Reason why the client could not be updated
CreateClientFailureEnum
string
Reason why the client could not be created
GetClientsResponse
object
2 properties 2 required
Client
object
14 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agicap-clients-api-openapi.yml Raw ↑

Other APIs Agicap publishes across the network.

Agicap Account reports API
Agicap Accrued interests API
Agicap Analytical Plan API
Agicap Anything API
Agicap Authentication API
Agicap Bank accounts API
Agicap Bank files API
Agicap Beta API
Agicap Card expenses bank journal API
Agicap Causales API
Agicap Client addresses API
Agicap Client Credit Notes API
Where this information came from

This is an independent, third-party profile of Agicap Clients 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.