| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId |
Sedona internal autonumber for the Customer Invoice record |
integer |
None. |
| InvoiceNumber |
Invoice Number the customer sees |
integer |
None. |
| JobCode |
Job Code seen in SedonaOffice |
string |
None. |
| InvoiceType |
Valid options are "O" for Other and "S" for Service; defaults to "O"; if "S", must supply a Service Ticket Number |
string |
None. |
| CustomerId |
Foreign key from AR_Customer table |
integer |
Required |
| CustomerSiteId |
Foreign key from AR_Customer_Site table |
integer |
Required |
| CustomerSiteAddress |
Site address from the AR_Customer_Site table |
string |
None. |
| CustomerSiteName |
Site Name from the AR_Customer_Site table |
string |
None. |
| InvoiceDate |
Defaults to today's date, but can be overridden |
string |
None. |
| InvoiceDateFormatted | date |
None. |
|
| IssueDate |
read only; this is the date the invoie is created, and will not be stored explicitly on a POST or PUT |
string |
None. |
| CategoryCode |
Category from AR_Category table |
string |
Required |
| Amount |
Invoice Amount |
decimal number |
Required |
| Credit |
read only (calculated automatically); Amount of any credits applied to this invoice |
decimal number |
None. |
| Payment |
read only (calculated automatically); Amount of any payments applied to this invoice |
decimal number |
None. |
| NetDue |
read only (calculated automatically); Net due on this invoice |
decimal number |
None. |
| TaxAmount |
Any tax amount on this invoice |
decimal number |
None. |
| TermCode |
Payment terms, from AR_Term |
string |
Required |
| AdvanceDeposit |
read only (calculated automatically); Amount of any advance deposits applied to this invoice |
decimal number |
None. |
| PONumber |
Purchase Order number |
string |
String length: inclusive between 0 and 20 |
| SalespersonCode |
Salesperson (from SY_Employee table); defaults to N/A if not set explicitly |
string |
None. |
| InvoiceDescriptionCode |
the Invoice Description Code, from AR_Invoice_Description table |
string |
String length: inclusive between 0 and 25 |
| ServiceStartDate |
Populated automatically as the earliest ServiceStartDate from the Invoice Item |
string |
None. |
| ServiceEndDate |
Populated automatically as the latest ServiceStartDate from the Invoice Item |
string |
None. |
| PaymentDate |
read only; this will not be stored explicitly on a POST or PUT |
string |
None. |
| Memo |
Text for memo |
string |
String length: inclusive between 0 and 255 |
| IsFinanceCharge |
read only; this will not be stored explicitly on a POST or PUT |
boolean |
None. |
| IsTaxable |
Designates that the invoice should be taxable |
boolean |
None. |
| InPrintQueue |
set to true if this invoice should be printed and mailed to the customer |
boolean |
None. |
| InEmailQueue |
set to true if this invoice should be emailed to the customer |
boolean |
None. |
| WarehouseCode |
value from IN_Warehouse |
string |
None. |
| ServiceTicketId |
pass in a ServiceTicketID or set to 1 (blank) for InvoiceType = "S"; defaults to 1 if not supplied |
integer |
None. |
| AgingDate |
Defaults to invoice date if not supplied, but can be overridden |
string |
None. |
| GSTTaxAmount |
GST Tax Amount (Canada) |
decimal number |
None. |
| PrintedDate | string |
None. |
|
| Complete | boolean |
None. |
|
| UserCode |
the user making this change; defaults to UserCode value from config file if not set explicitly |
string |
String length: inclusive between 0 and 30 |
| CustomerBillId | integer |
Required |
|
| BranchCode |
Branch from AR_Branch table |
string |
Required |
| PostingDate |
read only; this will not be stored explicitly on a POST or PUT |
string |
None. |
| TaxExemptNumber | string |
String length: inclusive between 0 and 20 |
|
| GSTTaxExemptNumber | string |
String length: inclusive between 0 and 20 |
|
| LateFeeAmt |
read only; this is automatically set to $0.00 on new records |
decimal number |
None. |
| ShippingCarrierCode |
value from SH_Carrier table |
string |
String length: inclusive between 0 and 25 |
| ShippingCarrierMethodCode |
value from SH_Carrier_Method table |
string |
String length: inclusive between 0 and 25 |
| ShippingName1 |
Shipping fields used to create a record in the SH_Shipment table, only if BuildShippingRecord = 1 in config file. |
string |
String length: inclusive between 0 and 50 |
| ShippingName2 | string |
String length: inclusive between 0 and 50 |
|
| ShippingPhoneNumber | string |
String length: inclusive between 0 and 20 |
|
| ShippingAddress1 | string |
String length: inclusive between 0 and 50 |
|
| ShippingAddress2 | string |
String length: inclusive between 0 and 50 |
|
| ShippingAddress3 | string |
String length: inclusive between 0 and 50 |
|
| ShippingCity | string |
String length: inclusive between 0 and 50 |
|
| ShippingState | string |
String length: inclusive between 0 and 50 |
|
| ShippingZip | string |
String length: inclusive between 0 and 50 |
|
| ShippingCountry | string |
String length: inclusive between 0 and 2 |
|
| ShippingTrackingInfo | string |
String length: inclusive between 0 and 50 |
|
| ShippingDeliveryInstructions | string |
String length: inclusive between 0 and 100 |
|
| InvoiceItems |
list of Invoice Items |
Collection of CustomerInvoiceItem |
None. |