Get invoice profiles

Returns a list of invoice profiles for an organization.

Prerequisites

C#

To get invoice profiles, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call InvoiceProfiles.Get() method to get invoice profiles by passing token.

var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.InvoiceProfiles.Get(token);

Request

Request Syntax:

Method

Request URI

GET

https://api.crayon.com/api/v1/invoiceprofiles/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}

Request Parameters:

Name

Type

Required

Description

organizationId

int

Yes

Identifier for organization

search

string

No

Search for a specific string

page

int

No

Pagination, starts at page 1

pageSize

int

No

Pagination, number of objects to return

Request Headers:

The following HTTP request headers are supported

Header

Type

Description

Authorization

string

Required. The authorization token in the form Bearer <token>.

Accept

string

Specifies the request and response type, “application/json”.

Content-Type

string

Specifies the media type of the resource, “application/json”.

Request Example:

GET $"https://api.crayon.com/api/v1/invoiceprofiles/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response

If successful, this method returns a collection InvoiceProfile resource in the response body.

{
  "Id": 1,
  "Organization": {
    "Id": 3869,
    "Name": "My company AB"
  },
  "Name": "Default invoice profile",
  "InvoiceReference": "SPLA Dec 2015",
  "CustomerReference": "My customer",
  "RequisitionNumber": "34234332344",
  "InvoiceAddressId": 352345345,
  "DeliveryAddressId": 534535345,
  "DeliveryAddress": {
    "Name": "My company",
    "CompleteAddress": "My company, Street name 3 City 156489 Sweden",
    "Street": "Street name 3",
    "ZipCode": "123456",
    "City": "City",
    "County": "",
    "State": "",
    "CountryCode": "SE"
  },
  "InvoiceAddress": {
    "Name": "My company",
    "CompleteAddress": "My company, Street name 3 City 156489 Sweden",
    "Street": "Street name 3",
    "ZipCode": "123456",
    "City": "City",
    "County": "",
    "State": "",
    "CountryCode": "SE"
  }
}

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes

Description

200 Ok

The request has succeeded.

401 Unauthorized

The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.