Counterparties

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/counterparties

List this project's counterparties

const result = await cs.api.get("/v1/counterparties");

Parameters, body and every documented response: GET /v1/counterparties in the HTTP reference.

POST /v1/counterparties

Register a counterparty, or merge into the one already there

const result = await cs.api.post("/v1/counterparties", {
  body: {
    kind: "supplier",
    name: "Example",
    identifier: "string",
    identifier_kind: "cnpj",
    metadata: {}
  }
});

Parameters, body and every documented response: POST /v1/counterparties in the HTTP reference.

GET /v1/counterparties/{id}

Read one counterparty

const result = await cs.api.get("/v1/counterparties/{id}", {
  path: {
    id: "counterpartie_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/counterparties/{id} in the HTTP reference.