Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URLGETPOSTPUTPATCHDELETE
/Customers

(tick) retrieve all customers

Filter parameters:

  • email
  • firstName
  • lastName
  • companyName

Filter example:

/Customers?email=info@customer.com

(tick) create a new customer(minus)(minus)(minus)
/Customers/:CustomerNumber(tick) retrieve one customer(minus)(warning) update existing customer
(warning)
/Customers/:CustomerNumber/Contracts(tick) retrieve all contracts for a customer(minus)(minus)(minus)(minus)
/Contracts(tick) retrieve all contracts(tick) create a new contract


/Contracts/:ContractNumber(tick) retrieve one contract(minus)(warning) update existing contract

/Contracts/:ContractNumber/Activities(tick) retrieve all activities for a given contract(tick) create a new activity record for a contract


/Contracts/:ContractNumber/Subscription(tick) retrieve the subscription for a contract(tick) create a new subscription for a contract


/Invoices(tick) retrieve all invoices(minus)(minus)(minus)(minus)
/Invoices/:InvoiceNumber(tick) retrieve a single invoice(minus)(minus)(minus)(minus)
/Invoices/:InvoiceNumber/Document(tick) retrieve the invoice PDF document (Base64 encoded binary)(minus)(minus)(minus)(minus)
/InvoiceCorrections(tick) retrieve all invoice corrections(minus)(minus)(minus)(minus)
/InvoiceCorrections/:InvoiceCorrectionNumber(tick) retrieve a single invoice correction(minus)(minus)(minus)(minus)
/InvoiceCorrections/:InvoiceCorrectionNumber/Document(tick) retrieve the invoice correction PDF document (Base64 encoded)(minus)(minus)(minus)(minus)
/Projects(tick) retrieve all projects



(tick) available
(warning) in development / planned
(minus) not available

Errors

The API returns standard HTTP status codes to indicate that something went wrong.

...