Create an organization Operation Route

Error

A valid request URL is required to generate request examples

{
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "account": {
    "ruleType": "alias",
    "validIf": "<unknown>"
  },
  "accountingEntries": {
    "block": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "cancel": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "commit": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "crossLedger": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "direct": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "hold": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "overdraft": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "revert": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "unblock": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    }
  },
  "code": "EXT-001",
  "description": "This operation route handles cash-in transactions from service charge collections",
  "id": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "ledgerId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "metadata": {},
  "operationType": "source",
  "organizationId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "title": "Cashin from service charge"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

organizations

{organization_id}

operation-routes

Error

A valid request URL is required to generate request examples

{
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "account": {
    "ruleType": "alias",
    "validIf": "<unknown>"
  },
  "accountingEntries": {
    "block": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "cancel": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "commit": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "crossLedger": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "direct": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "hold": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "overdraft": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "revert": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    },
    "unblock": {
      "credit": {
        "code": "1001",
        "description": "Cash"
      },
      "debit": {
        "code": "1001",
        "description": "Cash"
      }
    }
  },
  "code": "EXT-001",
  "description": "This operation route handles cash-in transactions from service charge collections",
  "id": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "ledgerId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "metadata": {},
  "operationType": "source",
  "organizationId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "title": "Cashin from service charge"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

Body

application/json

metadata

object

required

Show child attributes

account

object

Show child attributes

accountingEntries

object

Show child attributes

code

string

Example:

"EXT-001"

description

string

Example:

"This operation route handles cash-in transactions from service charge collections"

operationType

enum<string>

Available options:

source,

destination,

bidirectional

Example:

"source"

title

string

Example:

"Cashin from service charge"

Response

Created

createdAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

required

Example:

"2021-01-01T00:00:00Z"

updatedAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

account

object

Show child attributes

accountingEntries

object

Show child attributes

code

string

Example:

"EXT-001"

description

string

Example:

"This operation route handles cash-in transactions from service charge collections"

string

Example:

"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"

ledgerId

string

Example:

"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"

metadata

object

Show child attributes

operationType

string

Example:

"source"

organizationId

string

Example:

"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"

title

string

Example:

"Cashin from service charge"

Getting started

Core

CRM

Fees

Error handling

Events

Create an organization Operation Route

Authorizations

Path Parameters

Body

Response