Invoice - Single

GET

/invoices/v2/{bucket}/{invoice_type}/{uid}

A single master invoice or statement record containing the details of the invoice, client config data and payment details

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

invoice_type

required

The type of invoice

string

Allowed values: order invoice membership

Example

order

uid

required

Usually the final element in the URI, an alphanumeric unique identifier

string

Example

6305f074683e800f3abe809e

Responses

200

Invoice record

object

billing_contact

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

buyer

object

buyer_address

A list of address lines

Array<string>

Example

[
  "1 High Street",
  "Oxford",
  "Oxfordshire",
  "OX1 1AA"
]

buyer_country

string

buyer_email

string

Example

bob@example.com

buyer_locality

A locality, usually a town or city

string

Example

Oxford

buyer_name

string

buyer_postal_code

A postal code or ZIP code

string

Example

SW1A 1AA

buyer_region

A region, usually a county or state

string

Example

Oxfordshire

buyer_telephone

A telephone number, country code prefix is optional

string

Example

01234 567890

buyer_vat_number

string

buyer_ref

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

config

object

address

A list of address lines

Array<string>

Example

[
  "1 High Street",
  "Oxford",
  "Oxfordshire",
  "OX1 1AA"
]

contact_details

string

contact_email

string

contact_phone

string

default_currency

A three letter currency code (lower case)

string

Allowed values: gbp usd eur aed aud bbd bgn bhd bsd bwp cad chf cny czk dkk fjd ghs hkd hrk huf idr ils inr jmd jod jpy kes kwd kyd lkr lsl mad mur mwk mxn myr nad ngn nok nzd omr php pkr pln qar ron rsd rub sek sgd thb tnd try ttd twd ugx zar

Example

gbp

flock_name

string

logo_url

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

payment_detail_notes

string

payment_details

string

postal_code

string

purchase_order_string

string

tax_name

string

template

string

vat_number

string

context

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

currency

string

date

A date in the format YYYY-MM-DD

string

Example

2020-01-01

due

number

for_the_attention_of

string

id

string

invoice_currency

A three letter currency code (lower case)

string

Allowed values: gbp usd eur aed aud bbd bgn bhd bsd bwp cad chf cny czk dkk fjd ghs hkd hrk huf idr ils inr jmd jod jpy kes kwd kyd lkr lsl mad mur mwk mxn myr nad ngn nok nzd omr php pkr pln qar ron rsd rub sek sgd thb tnd try ttd twd ugx zar

Example

gbp

invoice_uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

line_items

Array<object>

object

currency

A three letter currency code (lower case)

string

Allowed values: gbp usd eur aed aud bbd bgn bhd bsd bwp cad chf cny czk dkk fjd ghs hkd hrk huf idr ils inr jmd jod jpy kes kwd kyd lkr lsl mad mur mwk mxn myr nad ngn nok nzd omr php pkr pln qar ron rsd rub sek sgd thb tnd try ttd twd ugx zar

Example

gbp

name

The name of the item being purchased

string

price

The price of a single item in the currency specified

number

quantity

number

ref

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

tax

The tax category for the line item

string

Allowed values: standard reduced zero exempt off

Example

standard

tax_rate

The tax rate as a float (e.g. 0.2 for 20%)

number

tax_total

number

tax_total_float

number

total

number

total_before_tax

number

total_float

number

xero_account_code

string

links

Array<object>

object

filename

string

href

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

prompt

string

rel

string

number_of_payments

number

payment_reference_uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

purchase_order_no

string

signature

An alphanumeric string that is used to verify the request

string

Example

6305f

signed_invoice_uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

status

string

tax_total

number

total

number

total_before_tax

number

total_paid

number

total_scheduled

number

total_tax

number

xero_invoice_ref

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

xero_ready

boolean

400

Bad request, see the error field for details

401

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

403

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

404

Not found

500

An error occurred within sheepCRM, please report to support@sheepcrm.com