sanmar_sdk.standard.invoices

SanMar’s own invoicing service.

SanMar invoices once a day, after 9 PM Pacific, for everything shipped that day, and suggests waiting a further day before reading invoices. Every lookup comes in two forms: whole invoices, with their lines, and headers only.

Attributes

INVOICE_RANGE_LIMIT	SanMar returns whole invoices for up to three months of invoice dates at a time.
HEADER_RANGE_LIMIT	SanMar returns invoice headers for up to a year of invoice dates at a time.

Classes

Address	A postal address on an invoice.
Party	Who an invoice is sold to, shipped to, or paid to.
InvoiceHeader	The header of one SanMar invoice.
InvoiceLine	One line of a SanMar invoice.
Invoice	One SanMar invoice, with its lines.
InvoiceService	SanMar's own invoicing service.

Module Contents

sanmar_sdk.standard.invoices.INVOICE_RANGE_LIMIT

SanMar returns whole invoices for up to three months of invoice dates at a time.

sanmar_sdk.standard.invoices.HEADER_RANGE_LIMIT

SanMar returns invoice headers for up to a year of invoice dates at a time.

class sanmar_sdk.standard.invoices.Address(/, **data: Any)

Bases: sanmar_sdk.base.Record

A postal address on an invoice.

address1: str | None = None

address2: str | None = None

address3: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

country: str | None = None

class sanmar_sdk.standard.invoices.Party(/, **data: Any)

Bases: sanmar_sdk.base.Record

Who an invoice is sold to, shipped to, or paid to.

name: str | None = None

address: Address = None

class sanmar_sdk.standard.invoices.InvoiceHeader(/, **data: Any)

Bases: sanmar_sdk.base.Record

The header of one SanMar invoice.

invoice_number: int = None

invoice_date: sanmar_sdk.base.SanMarDate = None

sales_order_number: int | None = None

status: str | None = None

Paid or Unpaid.

is_credit_memo: bool = None

customer_number: int | None = None

po_number: str | None = None

order_date: sanmar_sdk.base.SanMarDate | None = None

due_date: sanmar_sdk.base.SanMarDate | None = None

sold_to: Party | None = None

ship_to: Party | None = None

remit_to: Party | None = None

ship_via: str | None = None

fob: str | None = None

The shipping point, such as SPARKS NV.

terms: str | None = None

department: str | None = None

total_cases: int | None = None

total_weight: int | None = None

subtotal: decimal.Decimal | None = None

sales_tax: decimal.Decimal | None = None

shipping_and_handling: decimal.Decimal | None = None

total: decimal.Decimal | None = None

freight_savings: decimal.Decimal | None = None

class sanmar_sdk.standard.invoices.InvoiceLine(/, **data: Any)

Bases: sanmar_sdk.base.Record

One line of a SanMar invoice.

style: str | None = None

catalog_color: str | None = None

The color as SanMar’s order system records it, which is the catalog (mainframe) color.

size: str | None = None

description: str | None = None

quantity: int = None

unit_price: decimal.Decimal | None = None

amount: decimal.Decimal | None = None

unique_key: str | None = None

class sanmar_sdk.standard.invoices.Invoice(/, **data: Any)

Bases: sanmar_sdk.base.Record

One SanMar invoice, with its lines.

header: InvoiceHeader = None

lines: sanmar_sdk.base.OneOrMany[InvoiceLine] = None

class sanmar_sdk.standard.invoices.InvoiceService(soap: SoapClient, credentials: Credentials)

Bases: sanmar_sdk._soap.Service

SanMar’s own invoicing service.

get(invoice_number: int) → Invoice

Fetch one invoice by its number.

Raises:

NotFoundError – If SanMar has no invoice with that number.

by_purchase_order(po_number: str) → list[Invoice]

Fetch the invoices for one purchase order.

SanMar matches at most the first 13 characters of a PO number here.

by_invoice_date(start: datetime.date, end: datetime.date) → list[Invoice]

Fetch the invoices dated between two days, inclusive, up to three months apart.

by_order_date(order_date: datetime.date) → list[Invoice]

Fetch the invoices for orders placed on one day.

unpaid() → list[Invoice]

Fetch every unpaid invoice.

since_last_call() → list[Invoice]

Fetch the invoices added since this was last called.

The first call returns the last three months. Each call moves SanMar’s marker, so the invoices it returns are not returned again.

headers_by_purchase_order(po_number: str) → list[InvoiceHeader]

Fetch the invoice headers for one purchase order.

headers_by_invoice_date(start: datetime.date, end: datetime.date) → list[InvoiceHeader]

Fetch the invoice headers dated between two days, inclusive, up to a year apart.

headers_by_order_date(order_date: datetime.date) → list[InvoiceHeader]

Fetch the invoice headers for orders placed on one day.

unpaid_headers() → list[InvoiceHeader]

Fetch the headers of every unpaid invoice.