Skip to main content
Command reference

codespar boletos

DDA boletos: subscribe a document, list the boletos it receives

1 min read
View MarkdownEdit on GitHub

DDA boletos: subscribe a document, list the boletos it receives

4 commands in @codespar/cli 0.16.0.

Each one prints what its operation answered. What a command prints has the rule, and Configuration has the exit codes and the shape of a failure.

codespar boletos get-subscriptions

Read a DDA registration

codespar boletos get-subscriptions csm_0000000000000000 string
argumentwhat it is
<consumerId>String.
<document>CPF or CNPJ. Punctuation is accepted and stripped.
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/consumers/{consumerId}/dda/subscriptions/{document} · parameters, responses and refusals

codespar boletos delete-subscriptions

End a DDA registration

codespar boletos delete-subscriptions csm_0000000000000000 string
argumentwhat it is
<consumerId>String.
<document>CPF or CNPJ. Punctuation is accepted and stripped.
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document} · parameters, responses and refusals

codespar boletos list

The boletos DDA has mirrored for this consumer

codespar boletos list csm_0000000000000000
argumentwhat it is
<consumerId>String.
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/consumers/{consumerId}/dda/boletos · parameters, responses and refusals

codespar boletos create-subscriptions

Register the consumer's CPF/CNPJ with DDA

codespar boletos create-subscriptions csm_0000000000000000 --input '{"document":"string","client_name":"Example","idempotency_key":"string"}'
argumentwhat it is
<consumerId>String.
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds
-i, --input <json>Request body as a JSON string
-f, --input-file <path>Request body from a JSON file

POST /v1/consumers/{consumerId}/dda/subscriptions · parameters, responses and refusals

codespar boletos | CodeSpar