Connectors Reference
Zahara is a complete purchase management platform enabling paperless approvals for supplier invoices and purchase requisition.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Create Draft Invoice |
|
|
Create Invoice |
|
|
CreatePurchaseOrder (PurchaseOrderAddIntegrationModel model) |
Create Purchase Order |
|
Create Supplier |
|
|
UpdateSupplier (integer id, SupplierAmendIntegrationModel model) |
Update Supplier |
|
Name |
Summary |
|
New Cost Code |
|
|
New Approval Comment |
|
|
New Document Approved |
|
|
New Invoice |
|
|
New Invoice Set as Exported |
|
|
New Nominal Code |
|
|
New Project |
|
|
New Purchase Order |
|
|
New Purchase Order Sent to Supplier |
|
|
New Purchase Requsition |
|
|
New Supplier |
|
|
Supplier Amended |
|
|
New Tax Code |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
File to upload |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create Draft Invoice
Description: Creates a new draft invoice.
Syntax:
Zahara.CreateDraftInvoice (string SenderEmail, string RecipientEmail, [Optional]string RaisedDate, [Optional]file File)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
SenderEmail |
string (Sender Email) |
Sender Email |
True |
|
|
RecipientEmail |
string (Receiver Email) |
Receiver Email |
True |
|
|
RaisedDate |
string(date-time) (Date when invoice was raised) |
Date |
False |
|
|
File |
(File to upload) |
File to upload |
False |
Returns:
Type:integer(int64)
Summary: Create Invoice
Description: Creates a new invoice.
Syntax:
Zahara.CreateInvoice (InvoiceAddIntegrationModel model)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
model |
|
|
True |
Returns:
Type:integer(int64)
Summary: Create Purchase Order
Description: Creates a new purchase order.
Syntax:
Zahara.CreatePurchaseOrder (PurchaseOrderAddIntegrationModel model)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
model |
PurchaseOrderAddIntegrationModel
|
|
True |
Returns:
Type:integer(int64)
Summary: Create Supplier
Description: Creates a new supplier.
Syntax:
Zahara.CreateSupplier (SupplierAddIntegrationModel model)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
model |
|
|
True |
Returns:
Type:integer(int64)
Summary: Update Supplier
Description: Updates an existing supplier.
Syntax:
Zahara.UpdateSupplier (integer id, SupplierAmendIntegrationModel model)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer(int64) (Id of supplier to update) |
Id of supplier to update |
True |
|
|
model |
|
|
True |
Returns:
Summary: New Cost Code
Description: When a new cost code is created.
Syntax:
Zahara.NewCostCode ()
Returns:
Type:array of (CostCodeIntegrationModel)
Summary: New Approval Comment
Description: When a new approval comment is added at a step.
Syntax:
Zahara.NewApprovalComment ()
Returns:
Type:array of (ProcessLogIntegrationModel)
Summary: New Document Approved
Description: When a new document is approved.
Syntax:
Zahara.NewDocumentApproved (string documentType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
documentType |
string (Document type)Values: [PurchaseOrder, Invoice, PurchaseRequisition] |
Determines what kind of document it is |
True |
Returns:
Type:array of (ProcessLogIntegrationModel)
Summary: New Invoice
Description: When a new invoice is created.
Syntax:
Zahara.NewInvoice ()
Returns:
Type:array of (InvoiceIntegrationModel)
Summary: New Invoice Set as Exported
Description: When a new invoice is set as exported.
Syntax:
Zahara.NewInvoiceSetAsExported ()
Returns:
Type:array of (InvoiceIntegrationModel)
Summary: New Nominal Code
Description: When a new nominal code is created.
Syntax:
Zahara.NewNominalCode ()
Returns:
Type:array of (NominalCodeIntegrationModel)
Summary: New Project
Description: When a new project is created.
Syntax:
Zahara.NewProject ()
Returns:
Type:array of (ProjectIntegrationModel)
Summary: New Purchase Order
Description: When a new purchase order is created.
Syntax:
Zahara.NewPurchaseOrder ()
Returns:
Type:array of (PurchaseOrderIntegrationModel)
Summary: New Purchase Order Sent to Supplier
Description: When a new purchase order is sent to supplier.
Syntax:
Zahara.NewPurchaseOrderSentToSupplier ()
Returns:
Type:array of (PurchaseOrderIntegrationModel)
Summary: New Purchase Requsition
Description: When a new purchase requsition is created.
Syntax:
Zahara.NewPurchaseRequsition ()
Returns:
Type:array of (PurchaseRequsitionIntegrationModel)
Summary: New Supplier
Description: When a new supplier is created.
Syntax:
Zahara.NewSupplier ()
Returns:
Type:array of (SupplierIntegrationModel)
Summary: Supplier Amended
Description: When an existing supplier is updated.
Syntax:
Zahara.SupplierAmended ()
Returns:
Type:array of (SupplierUpdateIntegrationModel)
Summary: New Tax Code
Description: When a new tax code is created.
Syntax:
Zahara.NewTaxCode ()
Returns:
Type:array of (TaxCodeIntegrationModel)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
AddressLines |
string
|
|
|
Postcode |
string
|
|
|
CountryCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
Code |
string
|
|
|
Description |
string
|
|
|
DateCreated |
string(date-time)
|
|
|
IsActive |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DocumentNumber |
string
|
|
|
Type |
string
|
Values: [PurchaseOrder, Invoice, DeliveryNote, CreditNote, PurchaseRequisition] |
|
Status |
string
|
Values: [Created, Approved, Rejected, SentToSupplier, Completed, Closed, Draft, ExportOnHold, AdHocWorkflowNotFinished, SendToSupplierStepFailed] |
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
Summary: File to upload
Description: File to upload
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
InvoiceNumber |
string
|
|
|
PurchaseOrderNumber |
string
|
|
|
RaisedDate |
string(date-time)
|
|
|
DueDate |
string(date-time)
|
|
|
SupplierReferenceNumber |
string
|
|
|
Description |
string
|
|
|
Comments |
string
|
|
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
|
LineItems |
array of (LineItemAddIntegrationModel)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DocumentNumber |
string
|
|
|
PurchaseOrderNumber |
string
|
|
|
TotalNetValue |
number(double)
|
|
|
TotalGrossValue |
number(double)
|
|
|
TotalTaxValue |
number(double)
|
|
|
IsCreditNote |
boolean
|
|
|
RaisedDate |
string(date-time)
|
|
|
DueDate |
string(date-time)
|
|
|
IsBasedOnAnyOrder |
boolean
|
|
|
CurrentExportStatus |
string
|
Values: [None, ReadyForExport, Exporting, ExportComplete, ExportFailed] |
|
SyncDate |
string(date-time)
|
|
|
SyncType |
string
|
Values: [None, Csv, Sage50, Sage200, Xero, QuickBooks, MindYourOwnBusiness, SapBusinessByDesign, KashFlow, SmartInvoice, QuickBooksOnline] |
|
BillingAddress |
|
|
|
DocumentId |
integer(int64)
|
|
|
Description |
string
|
|
|
LastUpdated |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
DeliveryAddress |
|
|
|
Supplier |
SupplierSimpleIntegrationModel
|
|
|
LineItems |
array of (LineItemIntegrationModel)
|
|
|
Type |
string
|
Values: [PurchaseOrder, Invoice, DeliveryNote, CreditNote, PurchaseRequisition] |
|
Status |
string
|
Values: [Created, Approved, Rejected, SentToSupplier, Completed, Closed, Draft, ExportOnHold, AdHocWorkflowNotFinished, SendToSupplierStepFailed] |
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CostCode |
string
|
|
|
Quantity |
number(double)
|
|
|
Price |
number(double)
|
|
|
LineDescription |
string
|
|
|
NominalCode |
string
|
|
|
TaxCode |
string
|
|
|
TaxValue |
number(double)
|
|
|
DiscountPercentage |
number(double)
|
|
|
ProductCode |
string
|
|
|
ProjectCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Quantity |
number(double)
|
|
|
Description |
string
|
|
|
NominalCode |
string
|
|
|
TaxCode |
string
|
|
|
TaxPercentage |
number(double)
|
|
|
TaxValue |
number(double)
|
|
|
DiscountPercentage |
number(double)
|
|
|
NetValue |
number(double)
|
|
|
QuantityReceived |
number(double)
|
|
|
ProductCode |
string
|
|
|
GrossValue |
number(double)
|
|
|
IsEmpty |
boolean
|
|
|
CostCode |
string
|
|
|
Price |
number(double)
|
|
|
ProjectCode |
string
|
|
|
SupplierName |
string
|
|
|
ReferenceNumber |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
Code |
string
|
|
|
Description |
string
|
|
|
IsActive |
boolean
|
|
|
DateCreated |
string(date-time)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ProcessToken |
string(uuid)
|
|
|
StepResult |
string
|
Values: [None, Success, Failure, WaitForAction, ToReprocess, ProcessingWait, FailedToSendToSupplier] |
|
Message |
string
|
|
|
Approved |
boolean
|
|
|
ActionDate |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
Comment |
string
|
|
|
Document |
DocumentSimpleIntegrationModel
|
|
|
ApprovedBy |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
ProjectName |
string
|
|
|
ProjectCode |
string
|
|
|
Description |
string
|
|
|
Start |
string(date-time)
|
|
|
End |
string(date-time)
|
|
|
Status |
string
|
Values: [Active, Inactive, OnHold, Completed] |
|
DateCreated |
string(date-time)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
RequisitorName |
string
|
|
|
RequiredDate |
string(date-time)
|
|
|
SupplierReferenceNumber |
string
|
|
|
Description |
string
|
|
|
Comments |
string
|
|
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
|
LineItems |
array of (LineItemAddIntegrationModel)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DocumentNumber |
string
|
|
|
RequiredDate |
string(date-time)
|
|
|
TotalNetValue |
number(double)
|
|
|
TotalGrossValue |
number(double)
|
|
|
TotalTaxValue |
number(double)
|
|
|
SupplierComment |
string
|
|
|
SentToSupplier |
boolean
|
|
|
EverSentToSupplier |
boolean
|
|
|
AcceptedBySupplier |
boolean
|
|
|
ReportStatus |
string
|
|
|
IsFullyReceived |
boolean
|
|
|
IsReceivedInExcess |
boolean
|
|
|
IsNotReceivedAtAll |
boolean
|
|
|
Requisitor |
|
|
|
DocumentId |
integer(int64)
|
|
|
Description |
string
|
|
|
LastUpdated |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
DeliveryAddress |
|
|
|
Supplier |
SupplierSimpleIntegrationModel
|
|
|
LineItems |
array of (LineItemIntegrationModel)
|
|
|
Type |
string
|
Values: [PurchaseOrder, Invoice, DeliveryNote, CreditNote, PurchaseRequisition] |
|
Status |
string
|
Values: [Created, Approved, Rejected, SentToSupplier, Completed, Closed, Draft, ExportOnHold, AdHocWorkflowNotFinished, SendToSupplierStepFailed] |
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DocumentNumber |
string
|
|
|
RequiredDate |
string(date-time)
|
|
|
TotalNetValue |
number(double)
|
|
|
TotalGrossValue |
number(double)
|
|
|
UsersToNotify |
string
|
|
|
WasPoGenerated |
boolean
|
|
|
Requisitor |
|
|
|
DocumentId |
integer(int64)
|
|
|
Description |
string
|
|
|
LastUpdated |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
DeliveryAddress |
|
|
|
Supplier |
SupplierSimpleIntegrationModel
|
|
|
LineItems |
array of (LineItemIntegrationModel)
|
|
|
Type |
string
|
Values: [PurchaseOrder, Invoice, DeliveryNote, CreditNote, PurchaseRequisition] |
|
Status |
string
|
Values: [Created, Approved, Rejected, SentToSupplier, Completed, Closed, Draft, ExportOnHold, AdHocWorkflowNotFinished, SendToSupplierStepFailed] |
|
DivisionName |
string
|
|
|
CurrencyCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
AddressLines |
string
|
|
|
ContactName |
string
|
|
|
CountryCode |
string
|
|
|
|
string
|
|
|
PostCode |
string
|
|
|
ReferenceNumber |
string
|
|
|
SupplierName |
string
|
|
|
Telephone |
string
|
|
|
Type |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
AddressLines |
string
|
|
|
ContactName |
string
|
|
|
CountryCode |
string
|
|
|
|
string
|
|
|
PostCode |
string
|
|
|
ReferenceNumber |
string
|
|
|
SupplierName |
string
|
|
|
Telephone |
string
|
|
|
Type |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
ContactName |
string
|
|
|
|
string
|
|
|
LastUpdated |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
Telephone |
string
|
|
|
VatReg |
string
|
|
|
DefaultNominalCode |
string
|
|
|
DefaultTaxCode |
string
|
|
|
DefaultCostCode |
string
|
|
|
DefaultPaymentTerms |
integer(int32)
|
|
|
Notes |
string
|
|
|
Terms |
string
|
|
|
Type |
string
|
|
|
IsActive |
boolean
|
|
|
Address |
|
|
|
SupplierName |
string
|
|
|
ReferenceNumber |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SupplierName |
string
|
|
|
ReferenceNumber |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
OriginalId |
integer(int64)
|
|
|
Id |
integer(int64)
|
|
|
ContactName |
string
|
|
|
|
string
|
|
|
LastUpdated |
string(date-time)
|
|
|
DateCreated |
string(date-time)
|
|
|
Telephone |
string
|
|
|
VatReg |
string
|
|
|
DefaultNominalCode |
string
|
|
|
DefaultTaxCode |
string
|
|
|
DefaultCostCode |
string
|
|
|
DefaultPaymentTerms |
integer(int32)
|
|
|
Notes |
string
|
|
|
Terms |
string
|
|
|
Type |
string
|
|
|
IsActive |
boolean
|
|
|
Address |
|
|
|
SupplierName |
string
|
|
|
ReferenceNumber |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64)
|
|
|
Code |
string
|
|
|
CodeName |
string
|
|
|
TaxPercentage |
number(double)
|
|
|
Display |
boolean
|
|
|
DateCreated |
string(date-time)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
UserName |
string
|
|
|
|
string
|
|
|
JobTitle |
string
|
|
|
TelephoneNumber |
string
|
|