financials

Documentation

Index

• Constants
• type Currency
• type FinanceAccount
• type FinanceAccountType
• type FinancialEntityID
• type FinancialEntityIDID
• type FinancialEntityIDType
• type FinancialEntityIdentifier
• type FinancialIdentifierExportStatus
• type FinancialsClient
  • func Init(creds resharmonics.Credentials, preAuthorize bool) (FinancialsClient, error)
• type Invoice
  • func (inv *Invoice) ExtractID() FinancialEntityIDID
  • func (inv *Invoice) Validate() error
• type InvoiceDetails
• type InvoiceNumber
• type ItemCode
• type ItemID
• type LineItem
• type ListInvoicesResponse

Constants

const EUR = Currency("EUR")

const FinancialEntityIDTypeCREDIT_NOTE = FinancialEntityIDType("CREDIT_NOTE")

const FinancialEntityIDTypeFINANCE_ACCOUNT = FinancialEntityIDType("FINANCE_ACCOUNT")

const FinancialEntityIDTypeINVOICE = FinancialEntityIDType("INVOICE")

const FinancialEntityIDTypePAYMENT = FinancialEntityIDType("PAYMENT")

const FinancialEntityIDTypePURCHASE_CREDIT_NOTE = FinancialEntityIDType("PURCHASE_CREDIT_NOTE")

const FinancialEntityIDTypePURCHASE_INVOICE = FinancialEntityIDType("PURCHASE_INVOICE")

const FinancialEntityIDTypeREFUND = FinancialEntityIDType("REFUND")

const FinancialEntityIdExportStatusCREATED = FinancialIdentifierExportStatus("CREATED")

const FinancialEntityIdExportStatusEXPORTED = FinancialIdentifierExportStatus("EXPORTED")

const FinancialEntityIdExportStatusFAILED = FinancialIdentifierExportStatus("FAILED")

const FinancialEntityIdExportStatusIMPORTED = FinancialIdentifierExportStatus("IMPORTED")

const FinancialEntityIdExportStatusPENDING = FinancialIdentifierExportStatus("PENDING")

const FinancialEntityIdExportStatusSENT = FinancialIdentifierExportStatus("SENT")

const FinancialEntityIdExportStatusSKIPPED = FinancialIdentifierExportStatus("SKIPPED")

const FinancyAccountTypeCompany = FinanceAccountType("COMPANY")

const FinancyAccountTypeContact = FinanceAccountType("CONTACT")

const GBP = Currency("GBP")

const HKD = Currency("HKD")

const SEK = Currency("SEK")

const USD = Currency("USD")

Types

type Currency

type Currency string

type FinanceAccount

type FinanceAccount struct {
	Type          FinanceAccountType         `json:"type"`
	AccountNumber string                     `json:"accountNumber"`
	ID            *FinancialEntityIdentifier `json:"id"`
	Email         string                     `json:"emailAddress"`
	AccountName   string                     `json:"accountName"`
}

type FinanceAccountType

type FinanceAccountType string

type FinancialEntityID

type FinancialEntityID struct {
	Type         FinancialEntityIDType           `json:"type"`
	ID           FinancialEntityIDID             `json:"id"`
	ExternalID   string                          `json:"externalId"`
	ExportStatus FinancialIdentifierExportStatus `json:"exportStatus"`

	// ExportDate $date-time
	ExportDate string `json:"exportDate"`
}

type FinancialEntityIDID

type FinancialEntityIDID int

type FinancialEntityIDType

type FinancialEntityIDType string

type FinancialEntityIdentifier

type FinancialEntityIdentifier struct {
}

type FinancialIdentifierExportStatus

type FinancialIdentifierExportStatus string

type FinancialsClient

type FinancialsClient interface {
	ListInvoices(period utils.BookingPeriod, org resharmonics.OrganizationID, pagination *utils.Pagination) ([]*Invoice, error)
	GetInvoice(invoiceID FinancialEntityIDID) (*Invoice, error)
}

func Init

func Init(creds resharmonics.Credentials, preAuthorize bool) (FinancialsClient, error)

type Invoice

type Invoice struct {
	FinanceAccount *FinanceAccount `json:"financeAccount"`
	// Number is unique
	Number   InvoiceNumber      `json:"invoiceNumber"`
	ID       *FinancialEntityID `json:"id"`
	TotalNet float64            `json:"totalNet"`
	TotalVat float64            `json:"totalTax"`
	Currency Currency           `json:"currencyCode"`

	// InvoiceDate $date, no time
	InvoiceDate string `json:"invoiceDate"`

	InvoiceDueDate string `json:"invoiceDueDate"`

	InvoiceReference string     `json:"invoiceReference,omitempty"`
	Items            []LineItem `json:"lineItems"`
}

func (*Invoice) ExtractID

func (inv *Invoice) ExtractID() FinancialEntityIDID

func (*Invoice) Validate

func (inv *Invoice) Validate() error

type InvoiceDetails

type InvoiceDetails struct {
	CustomerName string            `json:"customerName"`
	CompanyName  string            `json:"companyName"`
	Address      *property.Address `json:"address"`
}

type InvoiceNumber

type InvoiceNumber string

type ItemCode

type ItemCode string

type ItemID

type ItemID int

type LineItem

type LineItem struct {
	ID          ItemID `json:"itemId"`
	Description string `json:"description"`

	// Code a code that references the product that this line item corresponds to
	Code ItemCode `json:"itemCode"`

	// TaxType a mapping element used to specify the tax code used for this line item
	TaxType     string       `json:"taxType"`
	ProductID   product.ID   `json:"productId"`
	ProductCode product.Code `json:"productCode"`

	Quantity     float64 `json:"quantity"`
	UnitPriceNet float64 `json:"unitPriceNet"`
	TotalNet     float64 `json:"totalNet"`
	TotalTax     float64 `json:"totalTax"`

	CostCenter string `json:"costCenter"`

	UnitReference string `json:"unitReference"`

	BookingReference resharmonics.BookingReference `json:"bookingReference"`

	// ChargeFrom $date
	ChargeFrom string `json:"chargeFrom"`

	// ChargeTo $date
	ChargeTo string `json:"chargeTo"`
}

type ListInvoicesResponse

type ListInvoicesResponse struct {
	Invoices []*Invoice `json:"invoices"`
}