Skip to content

Latest commit

 

History

History
738 lines (554 loc) · 25.5 KB

BillingNotesApi.md

File metadata and controls

738 lines (554 loc) · 25.5 KB

Flowaccount.OpenAPITools.Api.BillingNotesApi

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

Method HTTP request Description
BillingNotesEmailDocumentPost POST /billing-notes/email-document Send email billing notes document.
BillingNotesGet GET /billing-notes Get list all billing notes documents.
BillingNotesIdAttachmentPost POST /billing-notes/{id}/attachment Add Attachment to billing notes document.
BillingNotesIdDelete DELETE /billing-notes/{id} Get billing notes document.
BillingNotesIdGet GET /billing-notes/{id} Get billing notes document.
BillingNotesIdStatusKeyStatusIdPost POST /billing-notes/{id}/status-key/{statusId} Change status of billing notes document.
BillingNotesInlinePost POST /billing-notes/inline Create billing notes document with discount and tax inline.
BillingNotesPost POST /billing-notes Create billing notes document.
BillingNotesSharedocumentPost POST /billing-notes/sharedocument Share link billing notes document.

BillingNotesEmailDocumentPost

SendEmailResponse BillingNotesEmailDocumentPost (string authorization, SendEmailCoppies sendEmailCoppies)

Send email billing notes document.

ส่งเอกสารใบวางบิล ผ่านทางอีเมล ตามเลขที่เอกสารที่ต้องการ

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesEmailDocumentPostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var sendEmailCoppies = new SendEmailCoppies(); // SendEmailCoppies | 

            try
            {
                // Send email billing notes document.
                SendEmailResponse result = apiInstance.BillingNotesEmailDocumentPost(authorization, sendEmailCoppies);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesEmailDocumentPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
sendEmailCoppies SendEmailCoppies

Return type

SendEmailResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesGet

InlineDocumentResponse BillingNotesGet (int currentPage, int pageSize, string authorization, string sortBy = null, string filter = null)

Get list all billing notes documents.

เรียกดูข้อมูลเอกสารใบวางบิลทั้งหมดในระบบ

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesGetExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var currentPage = 56;  // int | Query current page document billing notes. <br>Example Pattern: <ex>/billing-notes?currentPage=1 </ex><ex>/billing-notes?currentPage=1&pageSize=20</ex>
            var pageSize = 56;  // int | Query document billing notes list amount per page. <br>Example Pattern: <ex> /billing-notes?pageSize=20 </ex>
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var sortBy = sortBy_example;  // string |  (optional) 
            var filter = filter_example;  // string |  (optional) 

            try
            {
                // Get list all billing notes documents.
                InlineDocumentResponse result = apiInstance.BillingNotesGet(currentPage, pageSize, authorization, sortBy, filter);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
currentPage int Query current page document billing notes. <br>Example Pattern: <ex>/billing-notes?currentPage=1 </ex><ex>/billing-notes?currentPage=1&pageSize=20</ex>
pageSize int Query document billing notes list amount per page. <br>Example Pattern: <ex> /billing-notes?pageSize=20 </ex>
authorization string [default to "Bearer accessToken"]
sortBy string [optional]
filter string [optional]

Return type

InlineDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesIdAttachmentPost

AttachmentResponse BillingNotesIdAttachmentPost (string authorization, string id, System.IO.Stream file = null)

Add Attachment to billing notes document.

แนบไฟล์ รูปภาพ หรือ เอกสารที่เกี่ยวข้อง ในเอกสารใบวางบิลตามเลขที่เอกสารที่ต้องการ

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesIdAttachmentPostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var id = id_example;  // string | documentId หรือ recordId ของเอกสารที่ต้องการแนบ
            var file = BINARY_DATA_HERE;  // System.IO.Stream | รูปแบบ file ที่ใช้แนบในเอกสารเป็นแบบ Binary (optional) 

            try
            {
                // Add Attachment to billing notes document.
                AttachmentResponse result = apiInstance.BillingNotesIdAttachmentPost(authorization, id, file);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesIdAttachmentPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
id string documentId หรือ recordId ของเอกสารที่ต้องการแนบ
file System.IO.Stream รูปแบบ file ที่ใช้แนบในเอกสารเป็นแบบ Binary [optional]

Return type

AttachmentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesIdDelete

DeleteResponse BillingNotesIdDelete (string authorization, string id)

Get billing notes document.

ลบ เอกสารใบวางบิล ตามเลขที่เอกสารที่ต้องการ
** การลบเอกสาร เอกสารต้องอยู่ในสถานะ รอวางบิล

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesIdDeleteExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var id = id_example;  // string | ID เอกสารใช้ recordId

            try
            {
                // Get billing notes document.
                DeleteResponse result = apiInstance.BillingNotesIdDelete(authorization, id);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesIdDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
id string ID เอกสารใช้ recordId

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesIdGet

InlineDocumentResponse BillingNotesIdGet (string authorization, string id)

Get billing notes document.

เรียกดูข้อมูลเอกสารใบวางบิลตามเลขที่เอกสารที่ต้องการ

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesIdGetExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var id = id_example;  // string | ID เอกสารใช้ recordId

            try
            {
                // Get billing notes document.
                InlineDocumentResponse result = apiInstance.BillingNotesIdGet(authorization, id);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesIdGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
id string ID เอกสารใช้ recordId

Return type

InlineDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesIdStatusKeyStatusIdPost

InlineDocumentResponse BillingNotesIdStatusKeyStatusIdPost (string authorization, string id, string statusId)

Change status of billing notes document.

เปลี่ยนสถานะของเอกสารใบวางบิล สร้างเอกสารใหม่ครั้งแรกจะได้รับสถานะ รอวางบิล (awaiting)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesIdStatusKeyStatusIdPostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var id = id_example;  // string | ID เอกสารใช้ recordId
            var statusId = statusId_example;  // string | เปลี่ยนสถานะเอกสารได้ 4 สถานะ <br> awaiting = รอวางบิล <br> approved = วางบิลแล้ว <br> approvedandprocessed = เปิดบิลแล้ว <br> void = ยกเลิก

            try
            {
                // Change status of billing notes document.
                InlineDocumentResponse result = apiInstance.BillingNotesIdStatusKeyStatusIdPost(authorization, id, statusId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesIdStatusKeyStatusIdPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
id string ID เอกสารใช้ recordId
statusId string เปลี่ยนสถานะเอกสารได้ 4 สถานะ <br> awaiting = รอวางบิล <br> approved = วางบิลแล้ว <br> approvedandprocessed = เปิดบิลแล้ว <br> void = ยกเลิก

Return type

InlineDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesInlinePost

InlineDocumentResponse BillingNotesInlinePost (string authorization, InlineDocument inlineDocument)

Create billing notes document with discount and tax inline.

สร้างเอกสารใบวางบิล แบบส่วนลด หรือ ภาษี แยกตามรายการสินค้า เมื่อสร้างสำเร็จสถานะเอกสารจะอยู่ในสถานะ รอวางบิล (awaiting)

ข้อมูลการออกเอกสารใบวางบิล : https://flowaccount.com/blog/ใบวางบิล-ใบแจ้งหนี้

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesInlinePostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var inlineDocument = new InlineDocument(); // InlineDocument | 

            try
            {
                // Create billing notes document with discount and tax inline.
                InlineDocumentResponse result = apiInstance.BillingNotesInlinePost(authorization, inlineDocument);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesInlinePost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
inlineDocument InlineDocument

Return type

InlineDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesPost

SimpleDocumentResponse BillingNotesPost (string authorization, SimpleDocument simpleDocument)

Create billing notes document.

สร้างเอกสารใบวางบิล เมื่อสร้างสำเร็จสถานะเอกสารจะอยู่ในสถานะ รอวาบิล (awaiting)

ข้อมูลการออกเอกสารใบวางบิล : https://flowaccount.com/blog/ใบวางบิล-ใบแจ้งหนี้

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesPostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var simpleDocument = new SimpleDocument(); // SimpleDocument | 

            try
            {
                // Create billing notes document.
                SimpleDocumentResponse result = apiInstance.BillingNotesPost(authorization, simpleDocument);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
simpleDocument SimpleDocument

Return type

SimpleDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BillingNotesSharedocumentPost

ShareDocumentResponse BillingNotesSharedocumentPost (string authorization, ShareDocument shareDocument)

Share link billing notes document.

แชร์ลิงค์ เอกสารใบวางบิลที่ต้องการ จะได้รับลิงค์สำหรับแชร์และเรียกดูเอกสาร

Example

using System.Collections.Generic;
using System.Diagnostics;
using Flowaccount.OpenAPITools.Api;
using Flowaccount.OpenAPITools.Client;
using Flowaccount.OpenAPITools.Model;

namespace Example
{
    public class BillingNotesSharedocumentPostExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://openapi.flowaccount.com/v1";
            var apiInstance = new BillingNotesApi(Configuration.Default);
            var authorization = authorization_example;  // string |  (default to "Bearer accessToken")
            var shareDocument = new ShareDocument(); // ShareDocument | 

            try
            {
                // Share link billing notes document.
                ShareDocumentResponse result = apiInstance.BillingNotesSharedocumentPost(authorization, shareDocument);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BillingNotesApi.BillingNotesSharedocumentPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authorization string [default to "Bearer accessToken"]
shareDocument ShareDocument

Return type

ShareDocumentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 response -
401 401 response -
500 500 response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]