beanie

package module
v0.0.0-...-74407ac Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2020 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for beanie

An API specification for interacting with the Beanie ERP system

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 0.8
  • Package version: 0.8.1
  • Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://bean.ie/help/api

Installation

Put the package under your project folder and add the following in import:

import "./beanie"

Documentation for API Endpoints

All URIs are relative to https://bean.ie

Class Method HTTP request Description
AddressBlockApi AddAddressBlock Post /address_blocks
AddressBlockApi FindAddressBlockById Get /address_blocks/{id} Find Address block by ID
AddressBlockApi FindAddressBlocks Get /address_blocks All address block
BankAccountApi AddBankAccount Post /bank_accounts
BankAccountApi FindBankAccountById Get /bank_accounts/{id} Find Bank Account by ID
BankAccountApi FindBankAccounts Get /bank_accounts All bank accounts
BankStatementApi AddBankStatement Post /bank_statements
BankStatementApi FindBankStatementById Get /bank_statements/{id} Find Bank statement by ID
BankStatementApi FindBankStatements Get /bank_statements All bank statement
BeanieTaskApi AddBeanieTask Post /beanie_tasks
BeanieTaskApi FindBeanieTaskById Get /beanie_tasks/{id} Find Beanie task by ID
BeanieTaskApi FindBeanieTasks Get /beanie_tasks All beanie task
BillOfMaterialsApi AddBillOfMaterial Post /bill_of_materials
BillOfMaterialsApi FindBillOfMaterialById Get /bill_of_materials/{id} Find Bill of Materials by ID
BillOfMaterialsApi FindBillOfMaterials Get /bill_of_materials All bill of materials
BillableApi AddBillable Post /billables
BillableApi FindBillableById Get /billables/{id} Find Billable record by ID
BillableApi FindBillables Get /billables All billable record
CompanyApi FindCompanyById Get /companies/{id} Find Company details by ID
DeliveryNoteApi AddDeliveryNote Post /delivery_notes
DeliveryNoteApi FindDeliveryNoteById Get /delivery_notes/{id} Find Delivery note by ID
DeliveryNoteApi FindDeliveryNotes Get /delivery_notes All delivery note
DocumentApi AddDocument Post /documents
DocumentApi FindDocumentById Get /documents/{id} Find Document by ID
DocumentApi FindDocuments Get /documents All document
FixedAssetApi AddFixedAsset Post /fixed_assets
FixedAssetApi FindFixedAssetById Get /fixed_assets/{id} Find Fixed asset by ID
FixedAssetApi FindFixedAssets Get /fixed_assets All fixed asset
ImageApi AddImage Post /images
ImageApi FindImageById Get /images/{id} Find Image by ID
ImageApi FindImages Get /images All image
JournalApi AddJournal Post /journals
JournalApi FindJournalById Get /journals/{id} Find Journal by ID
JournalApi FindJournals Get /journals All journal
NominalAccountApi AddNominalAccount Post /nominal_accounts
NominalAccountApi FindNominalAccountById Get /nominal_accounts/{id} Find Nominal account by ID
NominalAccountApi FindNominalAccounts Get /nominal_accounts All nominal account
NominalAccountCategoryApi AddNominalAccountCategory Post /nominal_account_categories
NominalAccountCategoryApi FindNominalAccountCategories Get /nominal_account_categories All nominal account category
NominalAccountCategoryApi FindNominalAccountCategoryById Get /nominal_account_categories/{id} Find Nominal account category by ID
PartnerApi AddPartner Post /partners
PartnerApi FindPartnerById Get /partners/{id} Find Partner by ID
PartnerApi FindPartners Get /partners All partners
PartnerAddressApi AddPartnerAddress Post /partner_addresses
PartnerAddressApi FindPartnerAddressById Get /partner_addresses/{id} Find Partner address by ID
PartnerAddressApi FindPartnerAddresses Get /partner_addresses All partner address
ProductApi AddProduct Post /products
ProductApi FindProductById Get /products/{id} Find Product by ID
ProductApi FindProducts Get /products All product
ProductCategoryApi AddProductCategory Post /product_categories
ProductCategoryApi FindProductCategories Get /product_categories All product category
ProductCategoryApi FindProductCategoryById Get /product_categories/{id} Find Product category by ID
ProductPriceApi AddProductPrice Post /product_prices
ProductPriceApi FindProductPriceById Get /product_prices/{id} Find Product price by ID
ProductPriceApi FindProductPrices Get /product_prices All product price
ProductVariantApi AddProductVariant Post /product_variants
ProductVariantApi FindProductVariantById Get /product_variants/{id} Find Product variant by ID
ProductVariantApi FindProductVariants Get /product_variants All product variant
ProductionOrderApi AddProductionOrder Post /production_orders
ProductionOrderApi FindProductionOrderById Get /production_orders/{id} Find Production order by ID
ProductionOrderApi FindProductionOrders Get /production_orders All production order
PurchaseInvoiceApi AddPurchaseInvoice Post /purchase_invoices
PurchaseInvoiceApi FindPurchaseInvoiceById Get /purchase_invoices/{id} Find Purchase invoice by ID
PurchaseInvoiceApi FindPurchaseInvoices Get /purchase_invoices All purchase invoice
PurchaseOrderApi AddPurchaseOrder Post /purchase_orders
PurchaseOrderApi FindPurchaseOrderById Get /purchase_orders/{id} Find Purchase order by ID
PurchaseOrderApi FindPurchaseOrders Get /purchase_orders All purchase order
SalesInvoiceApi AddSalesInvoice Post /sales_invoices
SalesInvoiceApi FindSalesInvoiceById Get /sales_invoices/{id} Find Sales invoice by ID
SalesInvoiceApi FindSalesInvoices Get /sales_invoices All sales invoice
SalesOrderApi AddSalesOrder Post /sales_orders
SalesOrderApi FindSalesOrder Get /sales_orders All sales order
SalesOrderApi FindSalesOrderById Get /sales_orders/{id} Find Sales order by ID
ShippingCentreApi AddShippingCentre Post /shipping_centres
ShippingCentreApi FindShippingCentreById Get /shipping_centres/{id} Find Shipping centre by ID
ShippingCentreApi FindShippingCentres Get /shipping_centres All shipping centre
StockAdjustmentApi AddStockAdjustment Post /stock_adjustments
StockAdjustmentApi FindStockAdjustmentById Get /stock_adjustments/{id} Find Stock adjustment by ID
StockAdjustmentApi FindStockAdjustments Get /stock_adjustments All stock adjustment
StockCategoryApi AddStockCategory Post /stock_categories
StockCategoryApi FindStockCategories Get /stock_categories All stock category
StockCategoryApi FindStockCategoryById Get /stock_categories/{id} Find Stock category by ID
StockItemApi AddStockItem Post /stock_items
StockItemApi FindStockItemById Get /stock_items/{id} Find Stock item by ID
StockItemApi FindStockItems Get /stock_items All stock item
StockLocationApi AddStockLocation Post /stock_locations
StockLocationApi FindStockLocationById Get /stock_locations/{id} Find Stock location by ID
StockLocationApi FindStockLocations Get /stock_locations All stock location
StockSupplierApi AddStockSupplier Post /stock_suppliers
StockSupplierApi FindStockSupplierById Get /stock_suppliers/{id} Find Stock supplier by ID
StockSupplierApi FindStockSuppliers Get /stock_suppliers All stock supplier
VatRecordApi AddVatRecord Post /vat_records
VatRecordApi FindVatRecordById Get /vat_records/{id} Find VAT record by ID
VatRecordApi FindVatRecords Get /vat_records All vat record
VatReturnApi AddVatReturn Post /vat_returns
VatReturnApi FindVatReturnById Get /vat_returns/{id} Find VAT return by ID
VatReturnApi FindVatReturns Get /vat_returns All vat return
WorkCentreApi FindWorkCentreById Get /work_centres/{id} Find Work centre by ID
WorkCentreApi FindWorkCentres Get /work_centre_groups/{work_centre_group_id}/work_centres All work centre
WorkCentreGroupApi FindWorkCentreGroupById Get /work_centre_groups/{id} Find Work centre group by ID
WorkCentreGroupApi FindWorkCentreGroups Get /work_centre_groups All work centre group

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

dev@bean.ie

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AddressBlockApi *AddressBlockApiService

	BankAccountApi *BankAccountApiService

	BankStatementApi *BankStatementApiService

	BeanieTaskApi *BeanieTaskApiService

	BillOfMaterialsApi *BillOfMaterialsApiService

	BillableApi *BillableApiService

	CompanyApi *CompanyApiService

	DeliveryNoteApi *DeliveryNoteApiService

	DocumentApi *DocumentApiService

	FixedAssetApi *FixedAssetApiService

	ImageApi *ImageApiService

	JournalApi *JournalApiService

	NominalAccountApi *NominalAccountApiService

	NominalAccountCategoryApi *NominalAccountCategoryApiService

	PartnerApi *PartnerApiService

	PartnerAddressApi *PartnerAddressApiService

	ProductApi *ProductApiService

	ProductCategoryApi *ProductCategoryApiService

	ProductPriceApi *ProductPriceApiService

	ProductVariantApi *ProductVariantApiService

	ProductionOrderApi *ProductionOrderApiService

	PurchaseInvoiceApi *PurchaseInvoiceApiService

	PurchaseOrderApi *PurchaseOrderApiService

	SalesInvoiceApi *SalesInvoiceApiService

	SalesOrderApi *SalesOrderApiService

	ShippingCentreApi *ShippingCentreApiService

	StockAdjustmentApi *StockAdjustmentApiService

	StockCategoryApi *StockCategoryApiService

	StockItemApi *StockItemApiService

	StockLocationApi *StockLocationApiService

	StockSupplierApi *StockSupplierApiService

	VatRecordApi *VatRecordApiService

	VatReturnApi *VatReturnApiService

	WorkCentreApi *WorkCentreApiService

	WorkCentreGroupApi *WorkCentreGroupApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Beanie ERP API API v0.8 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddressBlock 

type AddressBlock struct {
	Id int64 `json:"id"`
}

type AddressBlockApiService 

type AddressBlockApiService service

func (*AddressBlockApiService) AddAddressBlock 

func (a *AddressBlockApiService) AddAddressBlock(ctx context.Context, addressBlocks AddressBlockInput) (AddressBlock, *http.Response, error)

AddressBlockApiService Creates a new address block in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param addressBlocks Address block to add to the system

@return AddressBlock

func (*AddressBlockApiService) FindAddressBlockById 

func (a *AddressBlockApiService) FindAddressBlockById(ctx context.Context, id int64) (AddressBlock, *http.Response, error)

AddressBlockApiService Find Address block by ID Returns a single address block if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of address block to fetch

@return AddressBlock

func (*AddressBlockApiService) FindAddressBlocks 

func (a *AddressBlockApiService) FindAddressBlocks(ctx context.Context, localVarOptionals *FindAddressBlocksOpts) ([]AddressBlock, *http.Response, error)

type AddressBlockInput 

type AddressBlockInput struct {
	Id int64 `json:"id"`
}

type BankAccount 

type BankAccount struct {
	Name         string `json:"name"`
	BankName     string `json:"bank_name"`
	CurrencyCode string `json:"currency_code"`
	Swift        string `json:"swift"`
	Iban         string `json:"iban"`
	Address1     string `json:"address1,omitempty"`
	Address2     string `json:"address2,omitempty"`
	Address3     string `json:"address3,omitempty"`
	City         string `json:"city,omitempty"`
	StateCounty  string `json:"state_county,omitempty"`
	ZipPostcode  string `json:"zip_postcode,omitempty"`
	CountryName  string `json:"country_name"`
	ContactName  string `json:"contact_name,omitempty"`
	Phone        string `json:"phone,omitempty"`
	Email        string `json:"email,omitempty"`
	Website      string `json:"website,omitempty"`
	Id           int64  `json:"id,omitempty"`
}

type BankAccountApiService 

type BankAccountApiService service

func (*BankAccountApiService) AddBankAccount 

func (a *BankAccountApiService) AddBankAccount(ctx context.Context, bankAccount BankAccountInput) (BankAccount, *http.Response, error)

BankAccountApiService Creates a new bank account in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bankAccount Bank account to add to the system

@return BankAccount

func (*BankAccountApiService) FindBankAccountById 

func (a *BankAccountApiService) FindBankAccountById(ctx context.Context, id int64) (BankAccount, *http.Response, error)

BankAccountApiService Find Bank Account by ID Returns a single bank account if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of bank account to fetch

@return BankAccount

func (*BankAccountApiService) FindBankAccounts 

func (a *BankAccountApiService) FindBankAccounts(ctx context.Context, localVarOptionals *FindBankAccountsOpts) ([]BankAccount, *http.Response, error)

type BankAccountInput 

type BankAccountInput struct {
	Name         string `json:"name"`
	BankName     string `json:"bank_name"`
	CurrencyCode string `json:"currency_code"`
	Swift        string `json:"swift"`
	Iban         string `json:"iban"`
	Address1     string `json:"address1,omitempty"`
	Address2     string `json:"address2,omitempty"`
	Address3     string `json:"address3,omitempty"`
	City         string `json:"city,omitempty"`
	StateCounty  string `json:"state_county,omitempty"`
	ZipPostcode  string `json:"zip_postcode,omitempty"`
	CountryName  string `json:"country_name"`
	ContactName  string `json:"contact_name,omitempty"`
	Phone        string `json:"phone,omitempty"`
	Email        string `json:"email,omitempty"`
	Website      string `json:"website,omitempty"`
}

Bank account information

type BankStatement 

type BankStatement struct {
	Id int64 `json:"id"`
}

type BankStatementApiService 

type BankStatementApiService service

func (*BankStatementApiService) AddBankStatement 

func (a *BankStatementApiService) AddBankStatement(ctx context.Context, bankStatements BankStatementInput) (BankStatement, *http.Response, error)

BankStatementApiService Creates a new bank statement in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bankStatements Bank statement to add to the system

@return BankStatement

func (*BankStatementApiService) FindBankStatementById 

func (a *BankStatementApiService) FindBankStatementById(ctx context.Context, id int64) (BankStatement, *http.Response, error)

BankStatementApiService Find Bank statement by ID Returns a single bank statement if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of bank statement to fetch

@return BankStatement

func (*BankStatementApiService) FindBankStatements 

func (a *BankStatementApiService) FindBankStatements(ctx context.Context, localVarOptionals *FindBankStatementsOpts) ([]BankStatement, *http.Response, error)

type BankStatementData 

type BankStatementData struct {
	Id int64 `json:"id"`
}

type BankStatementDataInput 

type BankStatementDataInput struct {
	Id int64 `json:"id"`
}

type BankStatementInput 

type BankStatementInput struct {
	Id int64 `json:"id"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BeanieTask 

type BeanieTask struct {
	Id int64 `json:"id"`
}

type BeanieTaskApiService 

type BeanieTaskApiService service

func (*BeanieTaskApiService) AddBeanieTask 

func (a *BeanieTaskApiService) AddBeanieTask(ctx context.Context, beanieTasks BeanieTaskInput) (BeanieTask, *http.Response, error)

BeanieTaskApiService Creates a new beanie task in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param beanieTasks Beanie task to add to the system

@return BeanieTask

func (*BeanieTaskApiService) FindBeanieTaskById 

func (a *BeanieTaskApiService) FindBeanieTaskById(ctx context.Context, id int64) (BeanieTask, *http.Response, error)

BeanieTaskApiService Find Beanie task by ID Returns a single beanie task if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of beanie task to fetch

@return BeanieTask

func (*BeanieTaskApiService) FindBeanieTasks 

func (a *BeanieTaskApiService) FindBeanieTasks(ctx context.Context, localVarOptionals *FindBeanieTasksOpts) ([]BeanieTask, *http.Response, error)

type BeanieTaskInput 

type BeanieTaskInput struct {
	Id int64 `json:"id"`
}

type BillOfMaterial 

type BillOfMaterial struct {
	Id int64 `json:"id"`
}

type BillOfMaterialInput 

type BillOfMaterialInput struct {
	Id int64 `json:"id"`
}

type BillOfMaterialsApiService 

type BillOfMaterialsApiService service

func (*BillOfMaterialsApiService) AddBillOfMaterial 

func (a *BillOfMaterialsApiService) AddBillOfMaterial(ctx context.Context, billOfMaterials BillOfMaterialInput) (BillOfMaterial, *http.Response, error)

BillOfMaterialsApiService Creates a new bill of materials in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param billOfMaterials Bill of Materials to add to the system

@return BillOfMaterial

func (*BillOfMaterialsApiService) FindBillOfMaterialById 

func (a *BillOfMaterialsApiService) FindBillOfMaterialById(ctx context.Context, id int64) (BillOfMaterial, *http.Response, error)

BillOfMaterialsApiService Find Bill of Materials by ID Returns a single bill of materials if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of bill of materials to fetch

@return BillOfMaterial

func (*BillOfMaterialsApiService) FindBillOfMaterials 

func (a *BillOfMaterialsApiService) FindBillOfMaterials(ctx context.Context, localVarOptionals *FindBillOfMaterialsOpts) ([]BillOfMaterial, *http.Response, error)

type Billable 

type Billable struct {
	Id int64 `json:"id"`
}

type BillableApiService 

type BillableApiService service

func (*BillableApiService) AddBillable 

func (a *BillableApiService) AddBillable(ctx context.Context, billables BillableInput) (Billable, *http.Response, error)

BillableApiService Creates a new billable record in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param billables Billable record to add to the system

@return Billable

func (*BillableApiService) FindBillableById 

func (a *BillableApiService) FindBillableById(ctx context.Context, id int64) (Billable, *http.Response, error)

BillableApiService Find Billable record by ID Returns a single billable record if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of billable record to fetch

@return Billable

func (*BillableApiService) FindBillables 

func (a *BillableApiService) FindBillables(ctx context.Context, localVarOptionals *FindBillablesOpts) ([]Billable, *http.Response, error)

type BillableInput 

type BillableInput struct {
	Id int64 `json:"id"`
}

type BomItem 

type BomItem struct {
	Id int64 `json:"id"`
}

type BomItemInput 

type BomItemInput struct {
	Id int64 `json:"id"`
}

type Company 

type Company struct {
	Id int64 `json:"id"`
}

type CompanyApiService 

type CompanyApiService service

func (*CompanyApiService) FindCompanyById 

func (a *CompanyApiService) FindCompanyById(ctx context.Context, id int64) (Company, *http.Response, error)

CompanyApiService Find Company details by ID Returns a single company details if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of company details to fetch

@return Company

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type DeliveryNote 

type DeliveryNote struct {
	Id int64 `json:"id"`
}

type DeliveryNoteApiService 

type DeliveryNoteApiService service

func (*DeliveryNoteApiService) AddDeliveryNote 

func (a *DeliveryNoteApiService) AddDeliveryNote(ctx context.Context, deliveryNotes DeliveryNoteInput) (DeliveryNote, *http.Response, error)

DeliveryNoteApiService Creates a new delivery note in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deliveryNotes Delivery note to add to the system

@return DeliveryNote

func (*DeliveryNoteApiService) FindDeliveryNoteById 

func (a *DeliveryNoteApiService) FindDeliveryNoteById(ctx context.Context, id int64) (DeliveryNote, *http.Response, error)

DeliveryNoteApiService Find Delivery note by ID Returns a single delivery note if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of delivery note to fetch

@return DeliveryNote

func (*DeliveryNoteApiService) FindDeliveryNotes 

func (a *DeliveryNoteApiService) FindDeliveryNotes(ctx context.Context, localVarOptionals *FindDeliveryNotesOpts) ([]DeliveryNote, *http.Response, error)

type DeliveryNoteInput 

type DeliveryNoteInput struct {
	Id int64 `json:"id"`
}

type DeliveryNoteItem 

type DeliveryNoteItem struct {
	Id int64 `json:"id"`
}

type DeliveryNoteItemInput 

type DeliveryNoteItemInput struct {
	Id int64 `json:"id"`
}

type Document 

type Document struct {
	Id int64 `json:"id"`
}

type DocumentApiService 

type DocumentApiService service

func (*DocumentApiService) AddDocument 

func (a *DocumentApiService) AddDocument(ctx context.Context, documents DocumentInput) (Document, *http.Response, error)

DocumentApiService Creates a new document in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param documents Document to add to the system

@return Document

func (*DocumentApiService) FindDocumentById 

func (a *DocumentApiService) FindDocumentById(ctx context.Context, id int64) (Document, *http.Response, error)

DocumentApiService Find Document by ID Returns a single document if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of document to fetch

@return Document

func (*DocumentApiService) FindDocuments 

func (a *DocumentApiService) FindDocuments(ctx context.Context, localVarOptionals *FindDocumentsOpts) ([]Document, *http.Response, error)

type DocumentInput 

type DocumentInput struct {
	Id int64 `json:"id"`
}

type ErrorModel 

type ErrorModel struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

type FindAddressBlocksOpts 

type FindAddressBlocksOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindBankAccountsOpts 

type FindBankAccountsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindBankStatementsOpts 

type FindBankStatementsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindBeanieTasksOpts 

type FindBeanieTasksOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindBillOfMaterialsOpts 

type FindBillOfMaterialsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindBillablesOpts 

type FindBillablesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindDeliveryNotesOpts 

type FindDeliveryNotesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindDocumentsOpts 

type FindDocumentsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindFixedAssetsOpts 

type FindFixedAssetsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindImagesOpts 

type FindImagesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindJournalsOpts 

type FindJournalsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindNominalAccountCategoriesOpts 

type FindNominalAccountCategoriesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindNominalAccountsOpts 

type FindNominalAccountsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindPartnerAddressesOpts 

type FindPartnerAddressesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindPartnersOpts 

type FindPartnersOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindProductCategoriesOpts 

type FindProductCategoriesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindProductPricesOpts 

type FindProductPricesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindProductVariantsOpts 

type FindProductVariantsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindProductionOrdersOpts 

type FindProductionOrdersOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindProductsOpts 

type FindProductsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindPurchaseInvoicesOpts 

type FindPurchaseInvoicesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindPurchaseOrdersOpts 

type FindPurchaseOrdersOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindSalesInvoicesOpts 

type FindSalesInvoicesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindSalesOrderOpts 

type FindSalesOrderOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindShippingCentresOpts 

type FindShippingCentresOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindStockAdjustmentsOpts 

type FindStockAdjustmentsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindStockCategoriesOpts 

type FindStockCategoriesOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindStockItemsOpts 

type FindStockItemsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindStockLocationsOpts 

type FindStockLocationsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindStockSuppliersOpts 

type FindStockSuppliersOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindVatRecordsOpts 

type FindVatRecordsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindVatReturnsOpts 

type FindVatReturnsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindWorkCentreGroupsOpts 

type FindWorkCentreGroupsOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FindWorkCentresOpts 

type FindWorkCentresOpts struct {
	Tags  optional.Interface
	Limit optional.Int32
}

type FiscalYear 

type FiscalYear struct {
	Year   int32 `json:"year"`
	Closed bool  `json:"closed"`
}

type FixedAsset 

type FixedAsset struct {
	Id int64 `json:"id"`
}

type FixedAssetApiService 

type FixedAssetApiService service

func (*FixedAssetApiService) AddFixedAsset 

func (a *FixedAssetApiService) AddFixedAsset(ctx context.Context, fixedAssets FixedAssetInput) (FixedAsset, *http.Response, error)

FixedAssetApiService Creates a new fixed asset in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fixedAssets Fixed asset to add to the system

@return FixedAsset

func (*FixedAssetApiService) FindFixedAssetById 

func (a *FixedAssetApiService) FindFixedAssetById(ctx context.Context, id int64) (FixedAsset, *http.Response, error)

FixedAssetApiService Find Fixed asset by ID Returns a single fixed asset if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of fixed asset to fetch

@return FixedAsset

func (*FixedAssetApiService) FindFixedAssets 

func (a *FixedAssetApiService) FindFixedAssets(ctx context.Context, localVarOptionals *FindFixedAssetsOpts) ([]FixedAsset, *http.Response, error)

type FixedAssetInput 

type FixedAssetInput struct {
	Id int64 `json:"id"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GoodsReceivedNote 

type GoodsReceivedNote struct {
	Id int64 `json:"id"`
}

type GoodsReceivedNoteInput 

type GoodsReceivedNoteInput struct {
	Id int64 `json:"id"`
}

type Image 

type Image struct {
	Id int64 `json:"id"`
}

type ImageApiService 

type ImageApiService service

func (*ImageApiService) AddImage 

func (a *ImageApiService) AddImage(ctx context.Context, images ImageInput) (Image, *http.Response, error)

ImageApiService Creates a new image in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param images Image to add to the system

@return Image

func (*ImageApiService) FindImageById 

func (a *ImageApiService) FindImageById(ctx context.Context, id int64) (Image, *http.Response, error)

ImageApiService Find Image by ID Returns a single image if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of image to fetch

@return Image

func (*ImageApiService) FindImages 

func (a *ImageApiService) FindImages(ctx context.Context, localVarOptionals *FindImagesOpts) ([]Image, *http.Response, error)

type ImageInput 

type ImageInput struct {
	Id int64 `json:"id"`
}

type Journal 

type Journal struct {
	Id int64 `json:"id"`
}

type JournalApiService 

type JournalApiService service

func (*JournalApiService) AddJournal 

func (a *JournalApiService) AddJournal(ctx context.Context, journals JournalInput) (Journal, *http.Response, error)

JournalApiService Creates a new journal in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param journals Journal to add to the system

@return Journal

func (*JournalApiService) FindJournalById 

func (a *JournalApiService) FindJournalById(ctx context.Context, id int64) (Journal, *http.Response, error)

JournalApiService Find Journal by ID Returns a single journal if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of journal to fetch

@return Journal

func (*JournalApiService) FindJournals 

func (a *JournalApiService) FindJournals(ctx context.Context, localVarOptionals *FindJournalsOpts) ([]Journal, *http.Response, error)

type JournalInput 

type JournalInput struct {
	Id int64 `json:"id"`
}

type JournalItem 

type JournalItem struct {
	Id int64 `json:"id"`
}

type JournalItemInput 

type JournalItemInput struct {
	Id int64 `json:"id"`
}

type NominalAccount 

type NominalAccount struct {
	Id int64 `json:"id"`
}

type NominalAccountApiService 

type NominalAccountApiService service

func (*NominalAccountApiService) AddNominalAccount 

func (a *NominalAccountApiService) AddNominalAccount(ctx context.Context, nominalAccounts NominalAccountInput) (NominalAccount, *http.Response, error)

NominalAccountApiService Creates a new nominal account in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param nominalAccounts Nominal account to add to the system

@return NominalAccount

func (*NominalAccountApiService) FindNominalAccountById 

func (a *NominalAccountApiService) FindNominalAccountById(ctx context.Context, id int64) (NominalAccount, *http.Response, error)

NominalAccountApiService Find Nominal account by ID Returns a single nominal account if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of nominal account to fetch

@return NominalAccount

func (*NominalAccountApiService) FindNominalAccounts 

func (a *NominalAccountApiService) FindNominalAccounts(ctx context.Context, localVarOptionals *FindNominalAccountsOpts) ([]NominalAccount, *http.Response, error)

type NominalAccountCategory 

type NominalAccountCategory struct {
	Id int64 `json:"id"`
}

type NominalAccountCategoryApiService 

type NominalAccountCategoryApiService service

func (*NominalAccountCategoryApiService) AddNominalAccountCategory 

func (a *NominalAccountCategoryApiService) AddNominalAccountCategory(ctx context.Context, nominalAccountCategories NominalAccountCategoryInput) (NominalAccountCategory, *http.Response, error)

NominalAccountCategoryApiService Creates a new nominal account category in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param nominalAccountCategories Nominal account category to add to the system

@return NominalAccountCategory

func (*NominalAccountCategoryApiService) FindNominalAccountCategories 

func (a *NominalAccountCategoryApiService) FindNominalAccountCategories(ctx context.Context, localVarOptionals *FindNominalAccountCategoriesOpts) ([]NominalAccountCategory, *http.Response, error)

func (*NominalAccountCategoryApiService) FindNominalAccountCategoryById 

func (a *NominalAccountCategoryApiService) FindNominalAccountCategoryById(ctx context.Context, id int64) (NominalAccountCategory, *http.Response, error)

NominalAccountCategoryApiService Find Nominal account category by ID Returns a single nominal account category if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of nominal account category to fetch

@return NominalAccountCategory

type NominalAccountCategoryInput 

type NominalAccountCategoryInput struct {
	Id int64 `json:"id"`
}

type NominalAccountInput 

type NominalAccountInput struct {
	Id int64 `json:"id"`
}

type Partner 

type Partner struct {
	Name               string              `json:"name"`
	CurrencyCode       string              `json:"currency_code"`
	NetTerms           int32               `json:"net_terms,omitempty"`
	CreditLimit        float64             `json:"credit_limit,omitempty"`
	PartnerVat         string              `json:"partner_vat,omitempty"`
	Id                 int64               `json:"id,omitempty"`
	Code               string              `json:"code,omitempty"`
	State              string              `json:"state,omitempty"`
	CreditHold         bool                `json:"credit_hold,omitempty"`
	Balance            float64             `json:"balance,omitempty"`
	AddressIds         []int32             `json:"address_ids,omitempty"`
	Notes              []PartnerNote       `json:"notes,omitempty"`
	ReceivablesLedgers []ReceivablesLedger `json:"receivables_ledgers,omitempty"`
	PayablesLedgers    []PayablesLedger    `json:"payables_ledgers,omitempty"`
}

Partner Details

type PartnerAddress 

type PartnerAddress struct {
	Id int64 `json:"id"`
}

type PartnerAddressApiService 

type PartnerAddressApiService service

func (*PartnerAddressApiService) AddPartnerAddress 

func (a *PartnerAddressApiService) AddPartnerAddress(ctx context.Context, partnerAddresses PartnerAddressInput) (PartnerAddress, *http.Response, error)

PartnerAddressApiService Creates a new partner address in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param partnerAddresses Partner address to add to the system

@return PartnerAddress

func (*PartnerAddressApiService) FindPartnerAddressById 

func (a *PartnerAddressApiService) FindPartnerAddressById(ctx context.Context, id int64) (PartnerAddress, *http.Response, error)

PartnerAddressApiService Find Partner address by ID Returns a single partner address if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of partner address to fetch

@return PartnerAddress

func (*PartnerAddressApiService) FindPartnerAddresses 

func (a *PartnerAddressApiService) FindPartnerAddresses(ctx context.Context, localVarOptionals *FindPartnerAddressesOpts) ([]PartnerAddress, *http.Response, error)

type PartnerAddressInput 

type PartnerAddressInput struct {
	Id int64 `json:"id"`
}

type PartnerApiService 

type PartnerApiService service

func (*PartnerApiService) AddPartner 

func (a *PartnerApiService) AddPartner(ctx context.Context, partners PartnerInput) (Partner, *http.Response, error)

PartnerApiService Creates a new partner in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param partners Partner to add to the system

@return Partner

func (*PartnerApiService) FindPartnerById 

func (a *PartnerApiService) FindPartnerById(ctx context.Context, id int64) (Customer, *http.Response, error)

PartnerApiService Find Partner by ID Returns a single partner if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of partner to fetch

@return Customer

func (*PartnerApiService) FindPartners 

func (a *PartnerApiService) FindPartners(ctx context.Context, localVarOptionals *FindPartnersOpts) ([]Partner, *http.Response, error)

type PartnerInput 

type PartnerInput struct {
	Name         string  `json:"name"`
	CurrencyCode string  `json:"currency_code"`
	NetTerms     int32   `json:"net_terms,omitempty"`
	CreditLimit  float64 `json:"credit_limit,omitempty"`
	PartnerVat   string  `json:"partner_vat,omitempty"`
}

Partner Details

type PartnerNote 

type PartnerNote struct {
	Date   time.Time `json:"date"`
	Author string    `json:"author"`
	Note   string    `json:"note"`
}

type PayablesLedger 

type PayablesLedger struct {
	Date           string  `json:"date"`
	LedgerType     string  `json:"ledger_type"`
	Narrative      string  `json:"narrative"`
	Amount         float64 `json:"amount"`
	Reconciled     bool    `json:"reconciled"`
	JournalId      int64   `json:"journal_id,omitempty"`
	SalesInvoiceId int64   `json:"sales_invoice_id,omitempty"`
}

type Product 

type Product struct {
	Id int64 `json:"id"`
}

type ProductApiService 

type ProductApiService service

func (*ProductApiService) AddProduct 

func (a *ProductApiService) AddProduct(ctx context.Context, products ProductInput) (Product, *http.Response, error)

ProductApiService Creates a new product in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param products Product to add to the system

@return Product

func (*ProductApiService) FindProductById 

func (a *ProductApiService) FindProductById(ctx context.Context, id int64) (Product, *http.Response, error)

ProductApiService Find Product by ID Returns a single product if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of product to fetch

@return Product

func (*ProductApiService) FindProducts 

func (a *ProductApiService) FindProducts(ctx context.Context, localVarOptionals *FindProductsOpts) ([]Product, *http.Response, error)

type ProductCategory 

type ProductCategory struct {
	Id int64 `json:"id"`
}

type ProductCategoryApiService 

type ProductCategoryApiService service

func (*ProductCategoryApiService) AddProductCategory 

func (a *ProductCategoryApiService) AddProductCategory(ctx context.Context, productCategories ProductCategoryInput) (ProductCategory, *http.Response, error)

ProductCategoryApiService Creates a new product category in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param productCategories Product category to add to the system

@return ProductCategory

func (*ProductCategoryApiService) FindProductCategories 

func (a *ProductCategoryApiService) FindProductCategories(ctx context.Context, localVarOptionals *FindProductCategoriesOpts) ([]ProductCategory, *http.Response, error)

func (*ProductCategoryApiService) FindProductCategoryById 

func (a *ProductCategoryApiService) FindProductCategoryById(ctx context.Context, id int64) (ProductCategory, *http.Response, error)

ProductCategoryApiService Find Product category by ID Returns a single product category if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of product category to fetch

@return ProductCategory

type ProductCategoryInput 

type ProductCategoryInput struct {
	Id int64 `json:"id"`
}

type ProductInput 

type ProductInput struct {
	Id int64 `json:"id"`
}

type ProductPrice 

type ProductPrice struct {
	Id int64 `json:"id"`
}

type ProductPriceApiService 

type ProductPriceApiService service

func (*ProductPriceApiService) AddProductPrice 

func (a *ProductPriceApiService) AddProductPrice(ctx context.Context, productPrices ProductPriceInput) (ProductPrice, *http.Response, error)

ProductPriceApiService Creates a new product price in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param productPrices Product price to add to the system

@return ProductPrice

func (*ProductPriceApiService) FindProductPriceById 

func (a *ProductPriceApiService) FindProductPriceById(ctx context.Context, id int64) (ProductPrice, *http.Response, error)

ProductPriceApiService Find Product price by ID Returns a single product price if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of product price to fetch

@return ProductPrice

func (*ProductPriceApiService) FindProductPrices 

func (a *ProductPriceApiService) FindProductPrices(ctx context.Context, localVarOptionals *FindProductPricesOpts) ([]ProductPrice, *http.Response, error)

type ProductPriceInput 

type ProductPriceInput struct {
	Id int64 `json:"id"`
}

type ProductVariant 

type ProductVariant struct {
	Id int64 `json:"id"`
}

type ProductVariantApiService 

type ProductVariantApiService service

func (*ProductVariantApiService) AddProductVariant 

func (a *ProductVariantApiService) AddProductVariant(ctx context.Context, productVariants ProductVariantInput) (ProductVariant, *http.Response, error)

ProductVariantApiService Creates a new product variant in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param productVariants Product variant to add to the system

@return ProductVariant

func (*ProductVariantApiService) FindProductVariantById 

func (a *ProductVariantApiService) FindProductVariantById(ctx context.Context, id int64) (ProductVariant, *http.Response, error)

ProductVariantApiService Find Product variant by ID Returns a single product variant if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of product variant to fetch

@return ProductVariant

func (*ProductVariantApiService) FindProductVariants 

func (a *ProductVariantApiService) FindProductVariants(ctx context.Context, localVarOptionals *FindProductVariantsOpts) ([]ProductVariant, *http.Response, error)

type ProductVariantInput 

type ProductVariantInput struct {
	Id int64 `json:"id"`
}

type ProductionOrder 

type ProductionOrder struct {
	Priority          int32                `json:"priority"`
	Quantity          int32                `json:"quantity"`
	Notes             string               `json:"notes,omitempty"`
	BillOfMaterialsId int64                `json:"bill_of_materials_id,omitempty"`
	SalesOrderId      int64                `json:"sales_order_id,omitempty"`
	Id                int64                `json:"id,omitempty"`
	WorkCentreGroupId int64                `json:"work_centre_group_id,omitempty"`
	JobOrder          int64                `json:"job_order,omitempty"`
	State             string               `json:"state,omitempty"`
	Logs              []ProductionOrderLog `json:"logs,omitempty"`
}

Production Order Details

type ProductionOrderApiService 

type ProductionOrderApiService service

func (*ProductionOrderApiService) AddProductionOrder 

func (a *ProductionOrderApiService) AddProductionOrder(ctx context.Context, productionOrders ProductionOrderInput) (ProductionOrder, *http.Response, error)

ProductionOrderApiService Creates a new production order in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param productionOrders Production order to add to the system

@return ProductionOrder

func (*ProductionOrderApiService) FindProductionOrderById 

func (a *ProductionOrderApiService) FindProductionOrderById(ctx context.Context, id int64) (ProductionOrder, *http.Response, error)

ProductionOrderApiService Find Production order by ID Returns a single production order if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of production order to fetch

@return ProductionOrder

func (*ProductionOrderApiService) FindProductionOrders 

func (a *ProductionOrderApiService) FindProductionOrders(ctx context.Context, localVarOptionals *FindProductionOrdersOpts) ([]ProductionOrder, *http.Response, error)

type ProductionOrderInput 

type ProductionOrderInput struct {
	Priority          int32  `json:"priority"`
	Quantity          int32  `json:"quantity"`
	Notes             string `json:"notes,omitempty"`
	BillOfMaterialsId int64  `json:"bill_of_materials_id,omitempty"`
	SalesOrderId      int64  `json:"sales_order_id,omitempty"`
}

Production Order Details

type ProductionOrderLog 

type ProductionOrderLog struct {
	Date    time.Time `json:"date"`
	Member  string    `json:"member"`
	Message string    `json:"message"`
}

type PurchaseInvoice 

type PurchaseInvoice struct {
	Id int64 `json:"id"`
}

type PurchaseInvoiceApiService 

type PurchaseInvoiceApiService service

func (*PurchaseInvoiceApiService) AddPurchaseInvoice 

func (a *PurchaseInvoiceApiService) AddPurchaseInvoice(ctx context.Context, purchaseInvoices PurchaseInvoiceInput) (PurchaseInvoice, *http.Response, error)

PurchaseInvoiceApiService Creates a new purchase invoice in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param purchaseInvoices Purchase invoice to add to the system

@return PurchaseInvoice

func (*PurchaseInvoiceApiService) FindPurchaseInvoiceById 

func (a *PurchaseInvoiceApiService) FindPurchaseInvoiceById(ctx context.Context, id int64) (PurchaseInvoice, *http.Response, error)

PurchaseInvoiceApiService Find Purchase invoice by ID Returns a single purchase invoice if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of purchase invoice to fetch

@return PurchaseInvoice

func (*PurchaseInvoiceApiService) FindPurchaseInvoices 

func (a *PurchaseInvoiceApiService) FindPurchaseInvoices(ctx context.Context, localVarOptionals *FindPurchaseInvoicesOpts) ([]PurchaseInvoice, *http.Response, error)

type PurchaseInvoiceInput 

type PurchaseInvoiceInput struct {
	Id int64 `json:"id"`
}

type PurchaseOrder 

type PurchaseOrder struct {
	Id int64 `json:"id"`
}

type PurchaseOrderApiService 

type PurchaseOrderApiService service

func (*PurchaseOrderApiService) AddPurchaseOrder 

func (a *PurchaseOrderApiService) AddPurchaseOrder(ctx context.Context, purchaseOrders PurchaseOrderInput) (PurchaseOrder, *http.Response, error)

PurchaseOrderApiService Creates a new purchase order in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param purchaseOrders Purchase order to add to the system

@return PurchaseOrder

func (*PurchaseOrderApiService) FindPurchaseOrderById 

func (a *PurchaseOrderApiService) FindPurchaseOrderById(ctx context.Context, id int64) (PurchaseOrder, *http.Response, error)

PurchaseOrderApiService Find Purchase order by ID Returns a single purchase order if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of purchase order to fetch

@return PurchaseOrder

func (*PurchaseOrderApiService) FindPurchaseOrders 

func (a *PurchaseOrderApiService) FindPurchaseOrders(ctx context.Context, localVarOptionals *FindPurchaseOrdersOpts) ([]PurchaseOrder, *http.Response, error)

type PurchaseOrderInput 

type PurchaseOrderInput struct {
	Id int64 `json:"id"`
}

type PurchaseOrderItem 

type PurchaseOrderItem struct {
	Id int64 `json:"id"`
}

type PurchaseOrderItemInput 

type PurchaseOrderItemInput struct {
	Id int64 `json:"id"`
}

type ReceivablesLedger 

type ReceivablesLedger struct {
	Date           string  `json:"date"`
	LedgerType     string  `json:"ledger_type"`
	Narrative      string  `json:"narrative"`
	Amount         float64 `json:"amount"`
	Reconciled     bool    `json:"reconciled"`
	JournalId      int64   `json:"journal_id,omitempty"`
	SalesInvoiceId int64   `json:"sales_invoice_id,omitempty"`
}

type SalesInvoice 

type SalesInvoice struct {
	Id int64 `json:"id"`
}

type SalesInvoiceApiService 

type SalesInvoiceApiService service

func (*SalesInvoiceApiService) AddSalesInvoice 

func (a *SalesInvoiceApiService) AddSalesInvoice(ctx context.Context, salesInvoices SalesInvoiceInput) (SalesInvoice, *http.Response, error)

SalesInvoiceApiService Creates a new sales invoice in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param salesInvoices Sales invoice to add to the system

@return SalesInvoice

func (*SalesInvoiceApiService) FindSalesInvoiceById 

func (a *SalesInvoiceApiService) FindSalesInvoiceById(ctx context.Context, id int64) (SalesInvoice, *http.Response, error)

SalesInvoiceApiService Find Sales invoice by ID Returns a single sales invoice if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of sales invoice to fetch

@return SalesInvoice

func (*SalesInvoiceApiService) FindSalesInvoices 

func (a *SalesInvoiceApiService) FindSalesInvoices(ctx context.Context, localVarOptionals *FindSalesInvoicesOpts) ([]SalesInvoice, *http.Response, error)

type SalesInvoiceInput 

type SalesInvoiceInput struct {
	Id int64 `json:"id"`
}

type SalesInvoiceItem 

type SalesInvoiceItem struct {
	Id int64 `json:"id"`
}

type SalesInvoiceItemInput 

type SalesInvoiceItemInput struct {
	Id int64 `json:"id"`
}

type SalesOrder 

type SalesOrder struct {
	Id int64 `json:"id"`
}

type SalesOrderApiService 

type SalesOrderApiService service

func (*SalesOrderApiService) AddSalesOrder 

func (a *SalesOrderApiService) AddSalesOrder(ctx context.Context, salesOrders SalesOrderInput) (SalesOrder, *http.Response, error)

SalesOrderApiService Creates a new sales order in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param salesOrders Sales order to add to the system

@return SalesOrder

func (*SalesOrderApiService) FindSalesOrder 

func (a *SalesOrderApiService) FindSalesOrder(ctx context.Context, localVarOptionals *FindSalesOrderOpts) ([]SalesOrder, *http.Response, error)

func (*SalesOrderApiService) FindSalesOrderById 

func (a *SalesOrderApiService) FindSalesOrderById(ctx context.Context, id int64) (SalesOrder, *http.Response, error)

SalesOrderApiService Find Sales order by ID Returns a single sales order if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of sales order to fetch

@return SalesOrder

type SalesOrderInput 

type SalesOrderInput struct {
	Id int64 `json:"id"`
}

type SalesOrderItem 

type SalesOrderItem struct {
	Id int64 `json:"id"`
}

type SalesOrderItemInput 

type SalesOrderItemInput struct {
	Id int64 `json:"id"`
}

type ShippingCentre 

type ShippingCentre struct {
	Id int64 `json:"id"`
}

type ShippingCentreApiService 

type ShippingCentreApiService service

func (*ShippingCentreApiService) AddShippingCentre 

func (a *ShippingCentreApiService) AddShippingCentre(ctx context.Context, shippingCentres ShippingCentreInput) (ShippingCentre, *http.Response, error)

ShippingCentreApiService Creates a new shipping centre in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param shippingCentres Shipping centre to add to the system

@return ShippingCentre

func (*ShippingCentreApiService) FindShippingCentreById 

func (a *ShippingCentreApiService) FindShippingCentreById(ctx context.Context, id int64) (ShippingCentre, *http.Response, error)

ShippingCentreApiService Find Shipping centre by ID Returns a single shipping centre if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of shipping centre to fetch

@return ShippingCentre

func (*ShippingCentreApiService) FindShippingCentres 

func (a *ShippingCentreApiService) FindShippingCentres(ctx context.Context, localVarOptionals *FindShippingCentresOpts) ([]ShippingCentre, *http.Response, error)

type ShippingCentreInput 

type ShippingCentreInput struct {
	Id int64 `json:"id"`
}

type StockAdjustment 

type StockAdjustment struct {
	Id int64 `json:"id"`
}

type StockAdjustmentApiService 

type StockAdjustmentApiService service

func (*StockAdjustmentApiService) AddStockAdjustment 

func (a *StockAdjustmentApiService) AddStockAdjustment(ctx context.Context, stockAdjustments StockAdjustmentInput) (StockAdjustment, *http.Response, error)

StockAdjustmentApiService Creates a new stock adjustment in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stockAdjustments Stock adjustment to add to the system

@return StockAdjustment

func (*StockAdjustmentApiService) FindStockAdjustmentById 

func (a *StockAdjustmentApiService) FindStockAdjustmentById(ctx context.Context, id int64) (StockAdjustment, *http.Response, error)

StockAdjustmentApiService Find Stock adjustment by ID Returns a single stock adjustment if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of stock adjustment to fetch

@return StockAdjustment

func (*StockAdjustmentApiService) FindStockAdjustments 

func (a *StockAdjustmentApiService) FindStockAdjustments(ctx context.Context, localVarOptionals *FindStockAdjustmentsOpts) ([]StockAdjustment, *http.Response, error)

type StockAdjustmentInput 

type StockAdjustmentInput struct {
	Id int64 `json:"id"`
}

type StockCategory 

type StockCategory struct {
	Id int64 `json:"id"`
}

type StockCategoryApiService 

type StockCategoryApiService service

func (*StockCategoryApiService) AddStockCategory 

func (a *StockCategoryApiService) AddStockCategory(ctx context.Context, stockCategories StockCategoryInput) (StockCategory, *http.Response, error)

StockCategoryApiService Creates a new stock category in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stockCategories Stock category to add to the system

@return StockCategory

func (*StockCategoryApiService) FindStockCategories 

func (a *StockCategoryApiService) FindStockCategories(ctx context.Context, localVarOptionals *FindStockCategoriesOpts) ([]StockCategory, *http.Response, error)

func (*StockCategoryApiService) FindStockCategoryById 

func (a *StockCategoryApiService) FindStockCategoryById(ctx context.Context, id int64) (StockCategory, *http.Response, error)

StockCategoryApiService Find Stock category by ID Returns a single stock category if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of stock category to fetch

@return StockCategory

type StockCategoryInput 

type StockCategoryInput struct {
	Id int64 `json:"id"`
}

type StockItem 

type StockItem struct {
	Id int64 `json:"id"`
}

type StockItemApiService 

type StockItemApiService service

func (*StockItemApiService) AddStockItem 

func (a *StockItemApiService) AddStockItem(ctx context.Context, stockItems StockItemInput) (StockItem, *http.Response, error)

StockItemApiService Creates a new stock item in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stockItems Stock item to add to the system

@return StockItem

func (*StockItemApiService) FindStockItemById 

func (a *StockItemApiService) FindStockItemById(ctx context.Context, id int64) (StockItem, *http.Response, error)

StockItemApiService Find Stock item by ID Returns a single stock item if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of stock item to fetch

@return StockItem

func (*StockItemApiService) FindStockItems 

func (a *StockItemApiService) FindStockItems(ctx context.Context, localVarOptionals *FindStockItemsOpts) ([]StockItem, *http.Response, error)

type StockItemInput 

type StockItemInput struct {
	Id int64 `json:"id"`
}

type StockLocation 

type StockLocation struct {
	Id int64 `json:"id"`
}

type StockLocationApiService 

type StockLocationApiService service

func (*StockLocationApiService) AddStockLocation 

func (a *StockLocationApiService) AddStockLocation(ctx context.Context, stockLocations StockLocationInput) (StockLocation, *http.Response, error)

StockLocationApiService Creates a new stock location in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stockLocations Stock location to add to the system

@return StockLocation

func (*StockLocationApiService) FindStockLocationById 

func (a *StockLocationApiService) FindStockLocationById(ctx context.Context, id int64) (StockLocation, *http.Response, error)

StockLocationApiService Find Stock location by ID Returns a single stock location if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of stock location to fetch

@return StockLocation

func (*StockLocationApiService) FindStockLocations 

func (a *StockLocationApiService) FindStockLocations(ctx context.Context, localVarOptionals *FindStockLocationsOpts) ([]StockLocation, *http.Response, error)

type StockLocationInput 

type StockLocationInput struct {
	Id int64 `json:"id"`
}

type StockSupplier 

type StockSupplier struct {
	Id int64 `json:"id"`
}

type StockSupplierApiService 

type StockSupplierApiService service

func (*StockSupplierApiService) AddStockSupplier 

func (a *StockSupplierApiService) AddStockSupplier(ctx context.Context, stockSuppliers StockSupplierInput) (StockSupplier, *http.Response, error)

StockSupplierApiService Creates a new stock supplier in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stockSuppliers Stock supplier to add to the system

@return StockSupplier

func (*StockSupplierApiService) FindStockSupplierById 

func (a *StockSupplierApiService) FindStockSupplierById(ctx context.Context, id int64) (StockSupplier, *http.Response, error)

StockSupplierApiService Find Stock supplier by ID Returns a single stock supplier if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of stock supplier to fetch

@return StockSupplier

func (*StockSupplierApiService) FindStockSuppliers 

func (a *StockSupplierApiService) FindStockSuppliers(ctx context.Context, localVarOptionals *FindStockSuppliersOpts) ([]StockSupplier, *http.Response, error)

type StockSupplierInput 

type StockSupplierInput struct {
	Id int64 `json:"id"`
}

type VatRecord 

type VatRecord struct {
	Id int64 `json:"id"`
}

type VatRecordApiService 

type VatRecordApiService service

func (*VatRecordApiService) AddVatRecord 

func (a *VatRecordApiService) AddVatRecord(ctx context.Context, vatRecords VatRecordInput) (VatRecord, *http.Response, error)

VatRecordApiService Creates a new vat record in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vatRecords VAT record to add to the system

@return VatRecord

func (*VatRecordApiService) FindVatRecordById 

func (a *VatRecordApiService) FindVatRecordById(ctx context.Context, id int64) (VatRecord, *http.Response, error)

VatRecordApiService Find VAT record by ID Returns a single vat record if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of vat record to fetch

@return VatRecord

func (*VatRecordApiService) FindVatRecords 

func (a *VatRecordApiService) FindVatRecords(ctx context.Context, localVarOptionals *FindVatRecordsOpts) ([]VatRecord, *http.Response, error)

type VatRecordInput 

type VatRecordInput struct {
	Id   int64  `json:"id"`
	Name string `json:"name"`
}

type VatReturn 

type VatReturn struct {
	Id int64 `json:"id"`
}

type VatReturnApiService 

type VatReturnApiService service

func (*VatReturnApiService) AddVatReturn 

func (a *VatReturnApiService) AddVatReturn(ctx context.Context, vatReturns VatReturnInput) (VatReturn, *http.Response, error)

VatReturnApiService Creates a new vat return in the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vatReturns VAT return to add to the system

@return VatReturn

func (*VatReturnApiService) FindVatReturnById 

func (a *VatReturnApiService) FindVatReturnById(ctx context.Context, id int64) (VatReturn, *http.Response, error)

VatReturnApiService Find VAT return by ID Returns a single vat return if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of vat return to fetch

@return VatReturn

func (*VatReturnApiService) FindVatReturns 

func (a *VatReturnApiService) FindVatReturns(ctx context.Context, localVarOptionals *FindVatReturnsOpts) ([]VatReturn, *http.Response, error)

type VatReturnInput 

type VatReturnInput struct {
	Id int64 `json:"id"`
}

type WorkCentre 

type WorkCentre struct {
	Id                int64     `json:"id,omitempty"`
	CreatedAt         time.Time `json:"created_at,omitempty"`
	UpdatedAt         time.Time `json:"updated_at,omitempty"`
	Name              string    `json:"name,omitempty"`
	Description       string    `json:"description,omitempty"`
	WorkCentreGroupId int64     `json:"work_centre_group_id,omitempty"`
	Location          string    `json:"location,omitempty"`
	State             int64     `json:"state,omitempty"`
	ProductionOrderId int64     `json:"production_order_id,omitempty"`
}

Work Centre Details

type WorkCentreApiService 

type WorkCentreApiService service

func (*WorkCentreApiService) FindWorkCentreById 

func (a *WorkCentreApiService) FindWorkCentreById(ctx context.Context, id int64) (WorkCentre, *http.Response, error)

WorkCentreApiService Find Work centre by ID Returns a single work centre if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of work centre to fetch

@return WorkCentre

func (*WorkCentreApiService) FindWorkCentres 

func (a *WorkCentreApiService) FindWorkCentres(ctx context.Context, workCentreGroupId int64, localVarOptionals *FindWorkCentresOpts) ([]WorkCentre, *http.Response, error)

type WorkCentreGroup 

type WorkCentreGroup struct {
	Id          int64     `json:"id,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	Name        string    `json:"name,omitempty"`
	Description string    `json:"description,omitempty"`
	Code        string    `json:"code,omitempty"`
	Url         string    `json:"url,omitempty"`
}

Work Centre Group Details

type WorkCentreGroupApiService 

type WorkCentreGroupApiService service

func (*WorkCentreGroupApiService) FindWorkCentreGroupById 

func (a *WorkCentreGroupApiService) FindWorkCentreGroupById(ctx context.Context, id int64) (WorkCentreGroup, *http.Response, error)

WorkCentreGroupApiService Find Work centre group by ID Returns a single work centre group if the user has access

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of work centre group to fetch

@return WorkCentreGroup

func (*WorkCentreGroupApiService) FindWorkCentreGroups 

func (a *WorkCentreGroupApiService) FindWorkCentreGroups(ctx context.Context, localVarOptionals *FindWorkCentreGroupsOpts) ([]WorkCentreGroup, *http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.