Update invoice profile

Updates an invoice profile

Prerequisites

  • Credentials as described in Authentication
  • An organization identifier
  • An invoice address identifier

C#

To update invoice profile, first instantiate InvoiceProfile and add the required properties with values to update.

Next, get the instance of CrayonApiClient and get the token using the instance.

Finally, call InvoiceProfiles.Update() method to update invoice profile by passing token and the instance of InvoiceProfile.

var invoiceProfile = new InvoiceProfile
{
        Id = <invoice profile id>,
        Organization = new ObjectReference
        {
                Id = <organization id>
        },
        Name = "<name change>",
        InvoiceReference = "<reference change>"
};

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

Request

Request Syntax:

Method Request URI
POST https://api.crayon.com/api/v1/invoiceprofile/

Request Body:

Name Type Description
invoice profile InvoiceProfile The invoice profile to update

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:

PUT $"https://api.crayon.com/api/v1/invoiceprofiles/{id}/"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
{
  "Organization": {
    "Id": 3869
  },
  "Name": "Default invoice profile",
  "InvoiceAddressId": 352345345,
  "DeliveryAddress": {
    "Name": "My company",
    "Street": "Street name 3",
    "ZipCode": "123456",
    "City": "City",
    "County": "",
    "State": "",
    "CountryCode": "SE"
  }
}

Response

If successful, this method returns the updated invoice profile as a 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.
400 Bad Request The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn’t be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.
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.