sanmar_sdk.promostandards.invoices

SanMar’s PromoStandards Invoice service, version 1.0.0.

Finds invoices by purchase order, by invoice number, by invoice date, or everything invoiced since a point in time. SanMar invoices once a day, after 9 p.m. Pacific, for what shipped that day, and asks that this service be called after 3 p.m. Pacific the next day. SanMar does not implement getVoidedInvoices.

Classes

AccountInfo	The account and address an invoice is billed or sold to.
InvoiceLine	One line of an invoice.
Tax	A tax charged on an invoice.
Invoice	An invoice or credit memo.
InvoiceService	SanMar's PromoStandards Invoice service.

Module Contents

class sanmar_sdk.promostandards.invoices.AccountInfo(/, **data: Any)

Bases: sanmar_sdk.base.Record

The account and address an invoice is billed or sold to.

account_name: str | None = None

account_number: str | None = None

attention_to: str | None = None

address1: str | None = None

address2: str | None = None

address3: str | None = None

city: str | None = None

region: str | None = None

The state.

postal_code: str | None = None

country: str | None = None

email: str | None = None

phone: str | None = None

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

Bases: sanmar_sdk.base.Record

One line of an invoice.

invoice_quantity: decimal.Decimal = None

uom: str = None

description: str = None

unit_price: decimal.Decimal = None

extended_price: decimal.Decimal = None

line_number: decimal.Decimal | None = None

product_id: str | None = None

The style.

part_id: str | None = None

SanMar’s unique key for the style, color and size.

charge_id: str | None = None

po_line_number: decimal.Decimal | None = None

ordered_quantity: decimal.Decimal | None = None

back_ordered_quantity: decimal.Decimal | None = None

discount_amount: decimal.Decimal | None = None

distributor_product_id: str | None = None

distributor_part_id: str | None = None

class sanmar_sdk.promostandards.invoices.Tax(/, **data: Any)

Bases: sanmar_sdk.base.Record

A tax charged on an invoice.

tax_type: str = None

jurisdiction: str = None

amount: decimal.Decimal = None

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

Bases: sanmar_sdk.base.Record

An invoice or credit memo.

invoice_number: str = None

invoice_type: str = None

Whether this is an invoice or a credit memo, as SanMar spells it.

invoice_date: datetime.date = None

payment_due_date: datetime.date = None

currency: str

sales_amount: decimal.Decimal = None

shipping_amount: decimal.Decimal = None

handling_amount: decimal.Decimal = None

tax_amount: decimal.Decimal = None

invoice_amount: decimal.Decimal = None

advance_payment_amount: decimal.Decimal = None

amount_due: decimal.Decimal = None

po_number: str | None = None

po_version: str | None = None

bill_to: AccountInfo | None = None

sold_to: AccountInfo | None = None

comments: str | None = None

payment_terms: str | None = None

fob: str | None = None

document_url: str | None = None

payment_url: str | None = None

lines: list[InvoiceLine] = None

sales_order_numbers: list[str] = None

taxes: list[Tax] = None

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

Bases: sanmar_sdk.promostandards._common.PromoStandardsService

SanMar’s PromoStandards Invoice service.

endpoint

version = '1.0.0'

The PromoStandards version SanMar implements, sent as wsVersion.

by_purchase_order(po_number: str) → list[Invoice]

Find the invoices for a purchase order.

get(invoice_number: str) → Invoice

Find one invoice by its number.

Raises:

NotFoundError – If SanMar has no such invoice.

by_date(invoice_date: datetime.date) → list[Invoice]

Find every invoice dated a given day.

available_since(since: datetime.datetime) → list[Invoice]

Find every invoice issued after a point in time.