POST api/ActionService/FreshBookBilling

Documentation for 'FreshBookBilling'.

Request Information

Parameters

Name	Description	Additional information
fbRequest	Documentation for 'fbRequest'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "ConceptID": 2,
  "CurrencyCode": "sample string 3",
  "MoneyDeposited": 4.1,
  "Items": [
    {
      "Description": "sample string 1",
      "Name": "sample string 2",
      "Quantity": 3.1,
      "Tax1Name": "sample string 4",
      "Tax1Percent": 5,
      "Tax2Name": "sample string 6",
      "Tax2Percent": 7,
      "UnitCost": 8.1
    },
    {
      "Description": "sample string 1",
      "Name": "sample string 2",
      "Quantity": 3.1,
      "Tax1Name": "sample string 4",
      "Tax1Percent": 5,
      "Tax2Name": "sample string 6",
      "Tax2Percent": 7,
      "UnitCost": 8.1
    },
    {
      "Description": "sample string 1",
      "Name": "sample string 2",
      "Quantity": 3.1,
      "Tax1Name": "sample string 4",
      "Tax1Percent": 5,
      "Tax2Name": "sample string 6",
      "Tax2Percent": 7,
      "UnitCost": 8.1
    }
  ],
  "PaymentMode": 1
}

application/xml, text/xml

Sample:

<FreshBooksRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Payment">
  <ConceptID>2</ConceptID>
  <CurrencyCode>sample string 3</CurrencyCode>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.Billing.Freshbooks">
    <d2p1:InvoiceItem>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Quantity>3.1</d2p1:Quantity>
      <d2p1:Tax1Name>sample string 4</d2p1:Tax1Name>
      <d2p1:Tax1Percent>5</d2p1:Tax1Percent>
      <d2p1:Tax2Name>sample string 6</d2p1:Tax2Name>
      <d2p1:Tax2Percent>7</d2p1:Tax2Percent>
      <d2p1:UnitCost>8.1</d2p1:UnitCost>
    </d2p1:InvoiceItem>
    <d2p1:InvoiceItem>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Quantity>3.1</d2p1:Quantity>
      <d2p1:Tax1Name>sample string 4</d2p1:Tax1Name>
      <d2p1:Tax1Percent>5</d2p1:Tax1Percent>
      <d2p1:Tax2Name>sample string 6</d2p1:Tax2Name>
      <d2p1:Tax2Percent>7</d2p1:Tax2Percent>
      <d2p1:UnitCost>8.1</d2p1:UnitCost>
    </d2p1:InvoiceItem>
    <d2p1:InvoiceItem>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Quantity>3.1</d2p1:Quantity>
      <d2p1:Tax1Name>sample string 4</d2p1:Tax1Name>
      <d2p1:Tax1Percent>5</d2p1:Tax1Percent>
      <d2p1:Tax2Name>sample string 6</d2p1:Tax2Name>
      <d2p1:Tax2Percent>7</d2p1:Tax2Percent>
      <d2p1:UnitCost>8.1</d2p1:UnitCost>
    </d2p1:InvoiceItem>
  </Items>
  <MoneyDeposited>4.1</MoneyDeposited>
  <PaymentMode>PayPal</PaymentMode>
  <UserID>1</UserID>
</FreshBooksRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'FreshBooksRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "Message": {
    "value": true
  }
}

application/xml, text/xml

Sample:

<ResponseBaseOfGenericBooleanResponseVxd1ES9A xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Musician">
    <d2p1:value>true</d2p1:value>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfGenericBooleanResponseVxd1ES9A>