GET api/creditor/creditorcode?code={code}

Request Information

URI Parameters

Name	Description	Type	Additional information
code		string	Required

Body Parameters

None.

Response Information

Resource Description

Creditor

Name	Type	Additional information
CreditorCode	string	Required
CreditorName	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
Address4	string	None.
Address5	string	None.
PostCode	string	None.
Email	string	None.
Phone	string	None.
Phone2	string	None.
GSTNumber	string	None.
Comment	string	None.
PaymentMethod	string	None.
PaymentUnit	string	None.
PaymentDayOfMonth	integer	None.
PaymentCount	integer	None.
Discount	decimal number	None.
DiscountUnit	string	None.
DiscountDayOfMonth	integer	None.
DiscountCount	integer	None.
Inactive	boolean	None.
PhysicalAddress1	string	None.
PhysicalAddress2	string	None.
PhysicalAddress3	string	None.
PhysicalAddress4	string	None.
PhysicalAddress5	string	None.
PhysicalPostCode	string	None.
BankName	string	None.
BankAccount	string	None.
PayeeName	string	None.
BankReference	string	None.
BankParticulars	string	None.
OrderEmail	string	None.
Category1	CreditorCategory1	None.
Category2	CreditorCategory2	None.
Group	CreditorGroup	None.
Expense	APExpense	None.
Contacts	Collection of CreditorContact	None.

Response Formats

application/json, text/json

Sample:

{
  "CreditorCode": "sample string 1",
  "CreditorName": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "Address4": "sample string 6",
  "Address5": "sample string 7",
  "PostCode": "sample string 8",
  "Email": "sample string 9",
  "Phone": "sample string 10",
  "Phone2": "sample string 11",
  "GSTNumber": "sample string 12",
  "Comment": "sample string 13",
  "PaymentMethod": "sample string 14",
  "PaymentUnit": "sample string 15",
  "PaymentDayOfMonth": 16,
  "PaymentCount": 17,
  "Discount": 18.0,
  "DiscountUnit": "sample string 19",
  "DiscountDayOfMonth": 20,
  "DiscountCount": 21,
  "Inactive": true,
  "PhysicalAddress1": "sample string 23",
  "PhysicalAddress2": "sample string 24",
  "PhysicalAddress3": "sample string 25",
  "PhysicalAddress4": "sample string 26",
  "PhysicalAddress5": "sample string 27",
  "PhysicalPostCode": "sample string 28",
  "BankName": "sample string 29",
  "BankAccount": "sample string 30",
  "PayeeName": "sample string 31",
  "BankReference": "sample string 32",
  "BankParticulars": "sample string 33",
  "OrderEmail": "sample string 34",
  "Category1": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Inactive": true
  },
  "Category2": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Inactive": true
  },
  "Group": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Inactive": true
  },
  "Expense": {
    "AnalysisCode": "sample string 1",
    "AnalysisName": "sample string 2",
    "AccountClass": "sample string 3",
    "AccountCode": {
      "AccountCode": "sample string 1",
      "AccountName": "sample string 2",
      "AccountClass": "sample string 3",
      "AccountType": "sample string 4",
      "Inactive": true
    },
    "FriendlyCode": "sample string 4",
    "Inactive": true
  },
  "Contacts": [
    {
      "ContactId": 1,
      "FullName": "sample string 2",
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "PhoneNo": "sample string 7",
      "MobileNo": "sample string 8",
      "FaxNo": "sample string 9",
      "Email": "sample string 10",
      "Comment": "sample string 11",
      "Role": "sample string 12",
      "Inactive": true
    },
    {
      "ContactId": 1,
      "FullName": "sample string 2",
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "PhoneNo": "sample string 7",
      "MobileNo": "sample string 8",
      "FaxNo": "sample string 9",
      "Email": "sample string 10",
      "Comment": "sample string 11",
      "Role": "sample string 12",
      "Inactive": true
    }
  ]
}

application/xml, text/xml

Sample:

<Creditor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.AP">
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <Address3>sample string 5</Address3>
  <Address4>sample string 6</Address4>
  <Address5>sample string 7</Address5>
  <BankAccount>sample string 30</BankAccount>
  <BankName>sample string 29</BankName>
  <BankParticulars>sample string 33</BankParticulars>
  <BankReference>sample string 32</BankReference>
  <Category1>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Inactive>true</Inactive>
  </Category1>
  <Category2>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Inactive>true</Inactive>
  </Category2>
  <Comment>sample string 13</Comment>
  <Contacts>
    <CreditorContact>
      <Comment>sample string 11</Comment>
      <ContactId>1</ContactId>
      <Email>sample string 10</Email>
      <FaxNo>sample string 9</FaxNo>
      <FirstName>sample string 4</FirstName>
      <FullName>sample string 2</FullName>
      <Inactive>true</Inactive>
      <LastName>sample string 6</LastName>
      <MiddleName>sample string 5</MiddleName>
      <MobileNo>sample string 8</MobileNo>
      <PhoneNo>sample string 7</PhoneNo>
      <Role>sample string 12</Role>
      <Title>sample string 3</Title>
    </CreditorContact>
    <CreditorContact>
      <Comment>sample string 11</Comment>
      <ContactId>1</ContactId>
      <Email>sample string 10</Email>
      <FaxNo>sample string 9</FaxNo>
      <FirstName>sample string 4</FirstName>
      <FullName>sample string 2</FullName>
      <Inactive>true</Inactive>
      <LastName>sample string 6</LastName>
      <MiddleName>sample string 5</MiddleName>
      <MobileNo>sample string 8</MobileNo>
      <PhoneNo>sample string 7</PhoneNo>
      <Role>sample string 12</Role>
      <Title>sample string 3</Title>
    </CreditorContact>
  </Contacts>
  <CreditorCode>sample string 1</CreditorCode>
  <CreditorName>sample string 2</CreditorName>
  <Discount>18</Discount>
  <DiscountCount>21</DiscountCount>
  <DiscountDayOfMonth>20</DiscountDayOfMonth>
  <DiscountUnit>sample string 19</DiscountUnit>
  <Email>sample string 9</Email>
  <Expense>
    <AccountClass>sample string 3</AccountClass>
    <AccountCode xmlns:d3p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.GL">
      <d3p1:AccountClass>sample string 3</d3p1:AccountClass>
      <d3p1:AccountCode>sample string 1</d3p1:AccountCode>
      <d3p1:AccountName>sample string 2</d3p1:AccountName>
      <d3p1:AccountType>sample string 4</d3p1:AccountType>
      <d3p1:Inactive>true</d3p1:Inactive>
    </AccountCode>
    <AnalysisCode>sample string 1</AnalysisCode>
    <AnalysisName>sample string 2</AnalysisName>
    <FriendlyCode>sample string 4</FriendlyCode>
    <Inactive>true</Inactive>
  </Expense>
  <GSTNumber>sample string 12</GSTNumber>
  <Group>
    <Code>sample string 1</Code>
    <Inactive>true</Inactive>
    <Name>sample string 2</Name>
  </Group>
  <Inactive>true</Inactive>
  <OrderEmail>sample string 34</OrderEmail>
  <PayeeName>sample string 31</PayeeName>
  <PaymentCount>17</PaymentCount>
  <PaymentDayOfMonth>16</PaymentDayOfMonth>
  <PaymentMethod>sample string 14</PaymentMethod>
  <PaymentUnit>sample string 15</PaymentUnit>
  <Phone>sample string 10</Phone>
  <Phone2>sample string 11</Phone2>
  <PhysicalAddress1>sample string 23</PhysicalAddress1>
  <PhysicalAddress2>sample string 24</PhysicalAddress2>
  <PhysicalAddress3>sample string 25</PhysicalAddress3>
  <PhysicalAddress4>sample string 26</PhysicalAddress4>
  <PhysicalAddress5>sample string 27</PhysicalAddress5>
  <PhysicalPostCode>sample string 28</PhysicalPostCode>
  <PostCode>sample string 8</PostCode>
</Creditor>