Skip to content

flowaccount/flowaccount-openapi-sdk-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
docs
docs
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

OpenAPIClient-php

Introduction

Servers Production

Site: https://www.flowaccount.com

Api url: https://openapi.flowaccount.com/v1

Beta test

Site: http://sandbox-new.flowaccount.com/

Api url: https://openapi.flowaccount.com/test

PostMan Collection

Link: https://www.getpostman.com/collections/01e7c68d7093e2092a64

Overview

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 2-oas3
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://www.flowaccount.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\AuthenticationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$content_type = 'application/x-www-form-urlencoded'; // string | 
$grant_type = 'grant_type_example'; // string | 
$scope = 'scope_example'; // string | 
$client_id = 'client_id_example'; // string | 
$client_secret = 'client_secret_example'; // string | 
$guid = 'guid_example'; // string | 

try {
    $result = $apiInstance->tokenPost($content_type, $grant_type, $scope, $client_id, $client_secret, $guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->tokenPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://openapi.flowaccount.com/v1

Class Method HTTP request Description
AuthenticationApi tokenPost POST /token Generate Access Token
BankAccountApi bankAccountsGet GET /bank-accounts Get list all My Bank Account
BankAccountApi bankAccountsPost POST /bank-accounts Create bank account.
BillingNotesApi billingNotesEmailDocumentPost POST /billing-notes/email-document Send email billing notes document.
BillingNotesApi billingNotesGet GET /billing-notes Get all billing notes documents.
BillingNotesApi billingNotesIdAttachmentPost POST /billing-notes/{id}/attachment Attachment billing notes document.
BillingNotesApi billingNotesIdDelete DELETE /billing-notes/{id} Delete billing notes document.
BillingNotesApi billingNotesIdGet GET /billing-notes/{id} Get billing notes document.
BillingNotesApi billingNotesIdPut PUT /billing-notes/{id} Edit billing notes document.
BillingNotesApi billingNotesIdStatusStatusIdPost POST /billing-notes/{id}/status/{statusId} Change status billing notes document.
BillingNotesApi billingNotesInlinePost POST /billing-notes/inline Create billing notes document inline discount or inline vat.
BillingNotesApi billingNotesPost POST /billing-notes Create billing notes document.
BillingNotesApi billingNotesSharedocumentPost POST /billing-notes/sharedocument Share link billing notes document.
BusinessInfomationApi companyInfoGet GET /company/info Get business infomation
BusinessInfomationApi companyInfoPut PUT /company/info Edit business infomation
CashInvoiceApi cashInvoicesEmailDocumentPost POST /cash-invoices/email-document Send email cash invoices document.
CashInvoiceApi cashInvoicesGet GET /cash-invoices Get all cash invoices documents
CashInvoiceApi cashInvoicesIdAttachmentPost POST /cash-invoices/{id}/attachment Attachment cash invoices document.
CashInvoiceApi cashInvoicesIdDelete DELETE /cash-invoices/{id} Delete cash invoices document.
CashInvoiceApi cashInvoicesIdGet GET /cash-invoices/{id} Get cash invoices document.
CashInvoiceApi cashInvoicesIdPaymentPost POST /cash-invoices/{id}/payment Change status is paid cash invoices document.
CashInvoiceApi cashInvoicesIdPut PUT /cash-invoices/{id} Edit cash invoices document.
CashInvoiceApi cashInvoicesIdStatusStatusIdPost POST /cash-invoices/{id}/status/{statusId} Change status cash invoices document.
CashInvoiceApi cashInvoicesInlinePost POST /cash-invoices/inline Create cash invoices document inline discount or inline vat.
CashInvoiceApi cashInvoicesInlineWithPaymentPost POST /cash-invoices/inline/with-payment Create cash invoices document inline discount or inline vat with payment.
CashInvoiceApi cashInvoicesPost POST /cash-invoices Create cash invoices document.
CashInvoiceApi cashInvoicesSharedocumentPost POST /cash-invoices/sharedocument Share link cash invoices document.
CashInvoiceApi cashInvoicesWithPaymentPost POST /cash-invoices/with-payment Create cash invoices document with payment.
ContactsApi contactsGet GET /contacts Get list all contacts.
ContactsApi contactsIdDelete DELETE /contacts/{id} Delete contacts.
ContactsApi contactsIdGet GET /contacts/{id} Get contacts.
ContactsApi contactsIdPut PUT /contacts/{id} Update contacts.
ContactsApi contactsPost POST /contacts Create contacts
ExpensesApi expensesCategoriesAccountingGet GET /expenses/categories/accounting Accounting categories expenses document.
ExpensesApi expensesCategoriesBusinessGet GET /expenses/categories/business Business categories expenses document.
ExpensesApi expensesEmailDocumentPost POST /expenses/email-document Send email expenses document.
ExpensesApi expensesGet GET /expenses Get list all expenses documents.
ExpensesApi expensesIdAttachmentPost POST /expenses/{id}/attachment Attachment to expenses document.
ExpensesApi expensesIdDelete DELETE /expenses/{id} Delete expenses document.
ExpensesApi expensesIdGet GET /expenses/{id} Get expenses document.
ExpensesApi expensesIdPaymentPost POST /expenses/{id}/payment Change status is paid expenses document.
ExpensesApi expensesIdPut PUT /expenses/{id} Edit expenses document.
ExpensesApi expensesIdStatusStatusIdPost POST /expenses/{id}/status/{statusId} Change status expenses document.
ExpensesApi expensesInlinePost POST /expenses/inline Create expenses document inline discount or inline vat.
ExpensesApi expensesInlineWithPaymentPost POST /expenses/inline/with-payment Create expenses document inline discount or inline vat with payment.
ExpensesApi expensesPost POST /expenses Create expenses document.
ExpensesApi expensesSharedocumentPost POST /expenses/sharedocument Share link expenses document.
ExpensesApi expensesWithPaymentPost POST /expenses/with-payment Create expenses document with payment.
ProductsApi productsGet GET /products Get list all products.
ProductsApi productsIdDelete DELETE /products/{id} Delete products.
ProductsApi productsIdGet GET /products/{id} Get products.
ProductsApi productsIdPut PUT /products/{id} Update products.
ProductsApi productsPost POST /products Create products.
PurchaseOrderApi purchasesOrdersEmailDocumentPost POST /purchases-orders/email-document Send email purchase order document.
PurchaseOrderApi purchasesOrdersGet GET /purchases-orders Get all purchase order documents.
PurchaseOrderApi purchasesOrdersIdAttachmentPost POST /purchases-orders/{id}/attachment Attachment purchase order document.
PurchaseOrderApi purchasesOrdersIdDelete DELETE /purchases-orders/{id} Delete purchase order document.
PurchaseOrderApi purchasesOrdersIdGet GET /purchases-orders/{id} Get purchase order document.
PurchaseOrderApi purchasesOrdersIdPut PUT /purchases-orders/{id} Edit purchase order document.
PurchaseOrderApi purchasesOrdersIdStatusStatusIdPost POST /purchases-orders/{id}/status/{statusId} Change status purchase order document.
PurchaseOrderApi purchasesOrdersInlinePost POST /purchases-orders/inline Create purchase order document inline discount or inline vat.
PurchaseOrderApi purchasesOrdersPost POST /purchases-orders Create purchase order document.
PurchaseOrderApi purchasesOrdersSharedocumentPost POST /purchases-orders/sharedocument Share link purchase order document.
QuotationsApi quotationsEmailDocumentPost POST /quotations/email-document Send email quotations document.
QuotationsApi quotationsGet GET /quotations Get all quotations documents.
QuotationsApi quotationsIdAttachmentPost POST /quotations/{id}/attachment Attachment quotations document.
QuotationsApi quotationsIdDelete DELETE /quotations/{id} Delete quotations document.
QuotationsApi quotationsIdGet GET /quotations/{id} Get quotations document.
QuotationsApi quotationsIdPut PUT /quotations/{id} Edit quotations document.
QuotationsApi quotationsIdStatusStatusIdPost POST /quotations/{id}/status/{statusId} Change status quotations document.
QuotationsApi quotationsInlinePost POST /quotations/inline Create quotations document inline discount or inline vat.
QuotationsApi quotationsPost POST /quotations Create quotations document.
QuotationsApi quotationsSharedocumentPost POST /quotations/sharedocument Share link quotations document.
ReceiptApi receiptsEmailDocumentPost POST /receipts/email-document Send email receipt document.
ReceiptApi receiptsGet GET /receipts Get all receipt documents
ReceiptApi receiptsIdAttachmentPost POST /receipts/{id}/attachment Attachment receipt document.
ReceiptApi receiptsIdDelete DELETE /receipts/{id} Delete receipt document.
ReceiptApi receiptsIdGet GET /receipts/{id} Get receipt document.
ReceiptApi receiptsIdPaymentPost POST /receipts/{id}/payment Change status is paid receipt document.
ReceiptApi receiptsIdPut PUT /receipts/{id} Edit receipt document.
ReceiptApi receiptsIdStatusStatusIdPost POST /receipts/{id}/status/{statusId} Change status receipt document.
ReceiptApi receiptsInlinePost POST /receipts/inline Create receipt document inline discount or inline vat.
ReceiptApi receiptsInlineWithPaymentPost POST /receipts/inline/with-payment Create receipt document inline discount or inline vat with payment.
ReceiptApi receiptsPost POST /receipts Create receipt document.
ReceiptApi receiptsSharedocumentPost POST /receipts/sharedocument Share link receipt document.
ReceiptApi receiptsWithPaymentPost POST /receipts/with-payment Create receipt document with payment.
ReceivingInventoryApi purchasesEmailDocumentPost POST /purchases/email-document Send email receiving inventory document.
ReceivingInventoryApi purchasesGet GET /purchases Get all receiving inventory documents.
ReceivingInventoryApi purchasesIdAttachmentPost POST /purchases/{id}/attachment Attachment receiving inventory document.
ReceivingInventoryApi purchasesIdDelete DELETE /purchases/{id} Delete receiving inventory document.
ReceivingInventoryApi purchasesIdGet GET /purchases/{id} Get receiving inventory document.
ReceivingInventoryApi purchasesIdPaymentPost POST /purchases/{id}/payment Change status is paid receiving inventory document.
ReceivingInventoryApi purchasesIdPut PUT /purchases/{id} Edit receiving inventory document.
ReceivingInventoryApi purchasesIdStatusStatusIdPost POST /purchases/{id}/status/{statusId} Change status receiving inventory document.
ReceivingInventoryApi purchasesInlinePost POST /purchases/inline Create receiving inventory document inline discount or inline vat.
ReceivingInventoryApi purchasesInlineWithPaymentPost POST /purchases/inline/with-payment Create receiving inventory document inline discount or inline vat with payment.
ReceivingInventoryApi purchasesPost POST /purchases Create receiving inventory document.
ReceivingInventoryApi purchasesSharedocumentPost POST /purchases/sharedocument Share link receiving inventory document.
ReceivingInventoryApi purchasesWithPaymentPost POST /purchases/with-payment Create receiving inventory document with payment.
TaxInvoiceApi taxInvoicesEmailDocumentPost POST /tax-invoices/email-document Send Email tax invoice document
TaxInvoiceApi taxInvoicesGet GET /tax-invoices Get all tax invocie documents.
TaxInvoiceApi taxInvoicesIdAttachmentPost POST /tax-invoices/{id}/attachment Attachment tax Invoices document.
TaxInvoiceApi taxInvoicesIdDelete DELETE /tax-invoices/{id} Delete tax invoices document.
TaxInvoiceApi taxInvoicesIdGet GET /tax-invoices/{id} Get tax invoices document.
TaxInvoiceApi taxInvoicesIdPaymentPost POST /tax-invoices/{id}/payment Change status is paid tax-invoice document.
TaxInvoiceApi taxInvoicesIdPut PUT /tax-invoices/{id} Edit tax invoices document.
TaxInvoiceApi taxInvoicesIdStatusStatusIdPost POST /tax-invoices/{id}/status/{statusId} Change status tax invoices document.
TaxInvoiceApi taxInvoicesInlinePost POST /tax-invoices/inline Create tax invocie document inline discount or inline vat.
TaxInvoiceApi taxInvoicesInlineWithPaymentPost POST /tax-invoices/inline/with-payment Create tax invocie document inline discount or inline vat with payment.
TaxInvoiceApi taxInvoicesPost POST /tax-invoices Create tax invocie document.
TaxInvoiceApi taxInvoicesSharedocumentPost POST /tax-invoices/sharedocument Share link tax invoice document.
TaxInvoiceApi taxInvoicesWithPaymentPost POST /tax-invoices/with-payment Create tax invocie document with payment.
WithholdingTaxApi withholdingTaxesEmailDocumentPost POST /withholding-taxes/email-document Send email withholding tax.
WithholdingTaxApi withholdingTaxesGet GET /withholding-taxes Get all withholding tax documents.
WithholdingTaxApi withholdingTaxesIdAttachmentPost POST /withholding-taxes/{id}/attachment Attachment withholding tax.
WithholdingTaxApi withholdingTaxesIdDelete DELETE /withholding-taxes/{id} Delete withholding tax document.
WithholdingTaxApi withholdingTaxesIdGet GET /withholding-taxes/{id} Get withholding tax document.
WithholdingTaxApi withholdingTaxesIdPut PUT /withholding-taxes/{id} Edit withholding tax document.
WithholdingTaxApi withholdingTaxesIdStatusStatusIdPost POST /withholding-taxes/{id}/status/{statusId} Change status withholding tax document.
WithholdingTaxApi withholdingTaxesPost POST /withholding-taxes Create withholding tax document.
WithholdingTaxApi withholdingTaxesSharedocumentPost POST /withholding-taxes/sharedocument Share link withholding tax.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages