--- name: franconnect description: "CLI for the franconnect API" version: "0.1.0" source: https://github.com/neboai/franconnect license: MIT --- # FranConnect CLI for the franconnect API ## Quick Start ```bash # Check connectivity $FRANCONNECT_BIN ping # See all available commands $FRANCONNECT_BIN --help ``` ## Commands | Command | What it does | |---------|--------------| | `ping` | Check API reachability | | `payments retrieve` |

Payments that are made against a royalty report can be retrieved using the Payments endpoint. A payment can be retrieved by making a POST type of request to the specified API… | | `profit-loss create-new-statement` |

This operation is used to create a new P&L statement in the system. In order to do so, a POST type of call is to be made to the specified endpoint.

These are used to represent the categories that are present in P&L statements against which income and expenses are to be entered for each franchisee. To retrieve the Profit… | | `profit-loss retrieve-statements` |

This endpoint is used to retrieve an existing P&L statement. In order to do so, a POST type of call is to be made to the specified endpoint.

This endpoint is used to retrieve the Profit and Loss report periods for locations against which data is yet to be filled. To retrieve these report periods, a POST type of call is… | | `profit-loss update-existing-statement` |

This endpoint is used to update an existing P&L report. For this, a PUT type of call is to be made to the P&L endpoint.

Production API… | | `royalties get-payment-status` |

The payment status for Royalty reports can be retrieved by making a GET type of request is to be made to the specified endpoint.

Production API… | | `royalties retrieve-royalty-invoices` |

Royalty reports are generated on the basis of sales submitted for the locations and can be retrieved in a similar way as retrieving a sales report. To retrieve a royalty report, a… | | `sales create-new-report` |

Sales report can be created for a location for a given period for which the sales has not been filled yet. In order to do so, a POST type request is to be made to the specified… | | `sales retrieve` |

An existing sales report can be retrieved by making a POST type of request to the specified API endpoint.

Production API Endpoint : This represents the additional items apart from the finance and the The represents the finance categories used in sales report can be retrieved using the GET operation on the respective API endpoint.

Production API… | | `sales retrieve-non-finance-categories` |

This represents the non-financial/ KPI categories that are used as a part of the sales report. To retrieve the KPI categories, a GET request is to be sent to the API endpoint along… | | `sales retrieve-report-status` |

This section lists the various status that can be attributed to sales reports and can therefore be used as a search constraint in retrieve operations.

The create endpoint is used to create a new lead in the system.
Production API Endpoint : The update operation is performed to update an existing sales report for a given franchise location. In order for an existing sales report to be updated, a POST type of request is… | ## Bundled Skills | Skill | What it does | |-------|--------------| | `franconnect-quickstart` | Probe the API and learn the available subcommands. | | `franconnect-payments` | Manage payments | | `franconnect-profit-loss` | Manage profit loss | | `franconnect-royalties` | Manage royalties | | `franconnect-sales` | Manage sales | ## Data Privacy This plugin runs entirely on your machine. API calls go directly from your computer to the FranConnect API — no data passes through NeboAI servers. Credentials are stored locally and never leave your device.

franconnect

About this plugin