Skip to content
Proud to collaborate with Microsoft for Startups

bling.create-receivable ​

Create a new accounts-receivable row at Bling (POST /contas/receber). Persists into commerce_entity (entity_type='receivable').

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-bling
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
connection_uuiduuidYes——
counterparty_external_refstringYes—Bling customer (contato) id
amountstringYes——
due_datestringYes——
issue_datestringNo——
document_numberstringNo——
descriptionstringNo——
payment_method_external_refstringNo——
financial_category_external_refstringNo——
idempotency_keystringNo——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
connection_uuiduuidYes——
counterparty_external_refstringYes—Bling customer (contato) id
amountstringYes——
due_datestringYes——
issue_datestringNo——
document_numberstringNo——
descriptionstringNo——
payment_method_external_refstringNo——
financial_category_external_refstringNo——
idempotency_keystringNo——
actorstringNo——
provider_resource_refstringNo——
commerce_entity_uuiduuidNo——
created_at_isostringNo——
failure_reasonstringNo——
failed_atstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepjsonNo——
failed_layerjsonNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—createCreate requested
completedNoYesYes—Receivable created + persisted
failedNoYesNo—Create failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedcreatecompleted—
initiatedfailfailed—

Business Errors ​

CodeMessage Template
BLING_CONNECTION_NOT_FOUNDBling connection {connection_uuid} not found in organization
BLING_CONNECTION_WRONG_PROVIDERConnection {connection_uuid} is not a Bling connection
BLING_RECEIVABLE_MISSING_FIELD{field} is required to create a Bling receivable
BLING_RECEIVABLE_CREATE_FAILEDBling refused receivable create:
BLING_RECEIVABLE_PERSIST_FAILEDcommerce_entity persist failed:

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "bling.create-receivable",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "counterparty_external_ref": "value",
    "amount": "value"
  }
}