GET finance/documents/payables/{year}/{organizationalunit}/{category}/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
year

integer

Required

organizationalunit

integer

Required

category

integer

Required

id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Document
NameDescriptionTypeAdditional information
Number

string

None.

PartnerID

integer

None.

Partner

Partner

None.

InvoiceType

string

None.

Due

date

None.

DueDays

integer

None.

Payed

date

None.

Taxed

date

None.

PaymentMethodID

integer

None.

PaymentMethodName

string

None.

PaymentDescription

string

None.

RRN

string

None.

Items

Collection of PostItem

None.

TotalExcludingVAT

decimal number

None.

TotalVAT

decimal number

None.

TotalAmount

decimal number

None.

SchemaID

integer

None.

SchemaName

string

None.

Audit

AuditOld

None.

Year

integer

None.

OrganizationalUnitID

integer

None.

CategoryID

integer

None.

ID

integer

None.

Description

string

None.

Date

date

None.

Delivered

date

None.

Approved

date

None.

Posted

date

None.

IsValid

boolean

None.

IsApproved

boolean

None.

IsPosted

boolean

None.

IsEditable

boolean

None.

IsProtected

boolean

None.

CurrencyID

integer

None.

Currency

Currency

None.

ForOrganizationID

integer

None.

ProjectID

integer

None.

Project

ProjectReference

None.

Response Formats

application/json, text/json

Sample:
{
  "Number": "sample string 1",
  "PartnerID": 2,
  "Partner": {
    "CompanyID": 1,
    "ID": 2,
    "Lookup": "2 - sample string 6",
    "InvoiceType": "sample string 4",
    "OrganizationTypeID": 1,
    "Status": 5,
    "ClosedDate": "2024-03-29T11:47:17.0274458+00:00",
    "Details": {
      "IBAN": "sample string 1",
      "EMail": "sample string 2",
      "Phone": "sample string 3",
      "DueDays": 1
    },
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-03-29T11:47:17.0274458+00:00",
      "EditUser": 1,
      "EditTime": "2024-03-29T11:47:17.0274458+00:00"
    },
    "Name": "sample string 6",
    "Address": {
      "Street": "sample string 1",
      "Postcode": "sample string 2",
      "City": "sample string 3",
      "CountryID": 4,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2024-03-29T11:47:17.0274458+00:00",
          "EditUser": 1,
          "EditTime": "2024-03-29T11:47:17.0274458+00:00"
        }
      }
    },
    "VAT": "sample string 7"
  },
  "InvoiceType": "sample string 3",
  "Due": "2024-03-29T11:47:17.0274458+00:00",
  "DueDays": 0,
  "Payed": "2024-03-29T11:47:17.0274458+00:00",
  "Taxed": "2024-03-29T11:47:17.0274458+00:00",
  "PaymentMethodID": 1,
  "PaymentMethodName": "sample string 6",
  "PaymentDescription": "sample string 7",
  "RRN": "sample string 8",
  "Items": [
    {
      "Document": {
        "Year": 1,
        "OrganizationalUnitID": 1,
        "CategoryID": 1,
        "ID": 1
      },
      "ItemID": 1,
      "Order": 2,
      "Description": "sample string 3",
      "InvoiceDescription": "sample string 4",
      "COA": "sample string 5",
      "PR": "sample string 6",
      "Positive": 7,
      "Amount": 8.0,
      "CurrencyID": 9,
      "CurrencyAmount": 10.0,
      "PartnerID": 11,
      "AnalyticsID": 12,
      "AnalyticsName": "sample string 13",
      "AccountSettings": {
        "ID": "sample string 1",
        "Name": "sample string 2",
        "AnalyticsType": "sample string 3",
        "PR": "sample string 4",
        "TrackOpen": true,
        "TrackCostCenter": true
      },
      "CostCenterID": 14,
      "TaxID": 15,
      "PostIndicator": "sample string 16",
      "IsTaxable": true
    },
    {
      "Document": {
        "Year": 1,
        "OrganizationalUnitID": 1,
        "CategoryID": 1,
        "ID": 1
      },
      "ItemID": 1,
      "Order": 2,
      "Description": "sample string 3",
      "InvoiceDescription": "sample string 4",
      "COA": "sample string 5",
      "PR": "sample string 6",
      "Positive": 7,
      "Amount": 8.0,
      "CurrencyID": 9,
      "CurrencyAmount": 10.0,
      "PartnerID": 11,
      "AnalyticsID": 12,
      "AnalyticsName": "sample string 13",
      "AccountSettings": {
        "ID": "sample string 1",
        "Name": "sample string 2",
        "AnalyticsType": "sample string 3",
        "PR": "sample string 4",
        "TrackOpen": true,
        "TrackCostCenter": true
      },
      "CostCenterID": 14,
      "TaxID": 15,
      "PostIndicator": "sample string 16",
      "IsTaxable": true
    }
  ],
  "TotalExcludingVAT": 1.0,
  "TotalVAT": 1.0,
  "TotalAmount": 1.0,
  "SchemaID": 1,
  "SchemaName": "sample string 9",
  "Audit": {
    "AddUser": "sample string 1",
    "AddTime": "2024-03-29T11:47:17.0274458+00:00",
    "EditUser": "sample string 2",
    "EditTime": "2024-03-29T11:47:17.0274458+00:00"
  },
  "Year": 10,
  "OrganizationalUnitID": 11,
  "CategoryID": 12,
  "ID": 13,
  "Description": "sample string 14",
  "Date": "2024-03-29T11:47:17.0274458+00:00",
  "Delivered": "2024-03-29T11:47:17.0274458+00:00",
  "Approved": "2024-03-29T11:47:17.0274458+00:00",
  "Posted": "2024-03-29T11:47:17.0274458+00:00",
  "IsValid": true,
  "IsApproved": true,
  "IsPosted": true,
  "IsEditable": true,
  "IsProtected": true,
  "CurrencyID": 1,
  "Currency": {
    "ID": 1,
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Sign": "sample string 4",
    "Lookup": "sample string 5"
  },
  "ForOrganizationID": 1,
  "ProjectID": 1,
  "Project": {
    "ID": 1,
    "Name": "sample string 2",
    "From": "2024-03-29T11:47:17.0274458+00:00",
    "To": "2024-03-29T11:47:17.0274458+00:00",
    "LinkedReceivables": "sample string 4",
    "LinkedPayables": "sample string 5",
    "ReceivablesAmount": 1.0,
    "PayablesAmount": 1.0,
    "Balance": 1.0,
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-03-29T11:47:17.0274458+00:00",
      "EditUser": 1,
      "EditTime": "2024-03-29T11:47:17.0274458+00:00"
    }
  }
}

text/xml

Sample:
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common.Documents">
  <Approved>2024-03-29T11:47:17.0274458+00:00</Approved>
  <CategoryID>12</CategoryID>
  <Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Lookup>sample string 5</d2p1:Lookup>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Sign>sample string 4</d2p1:Sign>
  </Currency>
  <CurrencyID>1</CurrencyID>
  <Date>2024-03-29T11:47:17.0274458+00:00</Date>
  <Delivered>2024-03-29T11:47:17.0274458+00:00</Delivered>
  <Description>sample string 14</Description>
  <ForOrganizationID>1</ForOrganizationID>
  <ID>13</ID>
  <IsApproved>true</IsApproved>
  <IsEditable>true</IsEditable>
  <IsPosted>true</IsPosted>
  <IsProtected>true</IsProtected>
  <IsValid>true</IsValid>
  <OrganizationalUnitID>11</OrganizationalUnitID>
  <Posted>2024-03-29T11:47:17.0274458+00:00</Posted>
  <Project xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Finance.Projects">
    <d2p1:Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-03-29T11:47:17.0274458+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-03-29T11:47:17.0274458+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </d2p1:Audit>
    <d2p1:Balance>1</d2p1:Balance>
    <d2p1:From>2024-03-29T11:47:17.0274458+00:00</d2p1:From>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:LinkedPayables>sample string 5</d2p1:LinkedPayables>
    <d2p1:LinkedReceivables>sample string 4</d2p1:LinkedReceivables>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:PayablesAmount>1</d2p1:PayablesAmount>
    <d2p1:ReceivablesAmount>1</d2p1:ReceivablesAmount>
    <d2p1:To>2024-03-29T11:47:17.0274458+00:00</d2p1:To>
  </Project>
  <ProjectID>1</ProjectID>
  <Year>10</Year>
  <Audit xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
    <d2p1:AddTime>2024-03-29T11:47:17.0274458+00:00</d2p1:AddTime>
    <d2p1:AddUser>sample string 1</d2p1:AddUser>
    <d2p1:EditTime>2024-03-29T11:47:17.0274458+00:00</d2p1:EditTime>
    <d2p1:EditUser>sample string 2</d2p1:EditUser>
  </Audit>
  <Due>2024-03-29T11:47:17.0274458+00:00</Due>
  <DueDays>0</DueDays>
  <InvoiceType>sample string 3</InvoiceType>
  <Items>
    <PostItem>
      <AccountSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:AnalyticsType>sample string 3</d4p1:AnalyticsType>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:PR>sample string 4</d4p1:PR>
        <d4p1:TrackCostCenter>true</d4p1:TrackCostCenter>
        <d4p1:TrackOpen>true</d4p1:TrackOpen>
      </AccountSettings>
      <Amount>8</Amount>
      <AnalyticsID>12</AnalyticsID>
      <AnalyticsName>sample string 13</AnalyticsName>
      <COA>sample string 5</COA>
      <CostCenterID>14</CostCenterID>
      <CurrencyAmount>10</CurrencyAmount>
      <CurrencyID>9</CurrencyID>
      <Description>sample string 3</Description>
      <Document xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:CategoryID>1</d4p1:CategoryID>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:OrganizationalUnitID>1</d4p1:OrganizationalUnitID>
        <d4p1:Year>1</d4p1:Year>
      </Document>
      <InvoiceDescription>sample string 4</InvoiceDescription>
      <IsTaxable>true</IsTaxable>
      <ItemID>1</ItemID>
      <Order>2</Order>
      <PR>sample string 6</PR>
      <PartnerID>11</PartnerID>
      <Positive>7</Positive>
      <PostIndicator>sample string 16</PostIndicator>
      <TaxID>15</TaxID>
    </PostItem>
    <PostItem>
      <AccountSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:AnalyticsType>sample string 3</d4p1:AnalyticsType>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:PR>sample string 4</d4p1:PR>
        <d4p1:TrackCostCenter>true</d4p1:TrackCostCenter>
        <d4p1:TrackOpen>true</d4p1:TrackOpen>
      </AccountSettings>
      <Amount>8</Amount>
      <AnalyticsID>12</AnalyticsID>
      <AnalyticsName>sample string 13</AnalyticsName>
      <COA>sample string 5</COA>
      <CostCenterID>14</CostCenterID>
      <CurrencyAmount>10</CurrencyAmount>
      <CurrencyID>9</CurrencyID>
      <Description>sample string 3</Description>
      <Document xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:CategoryID>1</d4p1:CategoryID>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:OrganizationalUnitID>1</d4p1:OrganizationalUnitID>
        <d4p1:Year>1</d4p1:Year>
      </Document>
      <InvoiceDescription>sample string 4</InvoiceDescription>
      <IsTaxable>true</IsTaxable>
      <ItemID>1</ItemID>
      <Order>2</Order>
      <PR>sample string 6</PR>
      <PartnerID>11</PartnerID>
      <Positive>7</Positive>
      <PostIndicator>sample string 16</PostIndicator>
      <TaxID>15</TaxID>
    </PostItem>
  </Items>
  <Number>sample string 1</Number>
  <Partner xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
    <Address xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d2p1:City>sample string 3</d2p1:City>
      <d2p1:Country>
        <d2p1:Alpha2>sample string 3</d2p1:Alpha2>
        <d2p1:Alpha3>sample string 4</d2p1:Alpha3>
        <d2p1:Audit>
          <AddTime>2024-03-29T11:47:17.0274458+00:00</AddTime>
          <AddUser>1</AddUser>
          <EditTime>2024-03-29T11:47:17.0274458+00:00</EditTime>
          <EditUser>1</EditUser>
        </d2p1:Audit>
        <d2p1:Currency>
          <d2p1:Code>sample string 2</d2p1:Code>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Lookup>sample string 5</d2p1:Lookup>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:Sign>sample string 4</d2p1:Sign>
        </d2p1:Currency>
        <d2p1:CurrencyID>1</d2p1:CurrencyID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:ISO31661>1</d2p1:ISO31661>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Country>
      <d2p1:CountryID>4</d2p1:CountryID>
      <d2p1:Postcode>sample string 2</d2p1:Postcode>
      <d2p1:Street>sample string 1</d2p1:Street>
    </Address>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 6</Name>
    <VAT xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 7</VAT>
    <d2p1:Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-03-29T11:47:17.0274458+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-03-29T11:47:17.0274458+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </d2p1:Audit>
    <d2p1:ClosedDate>2024-03-29T11:47:17.0274458+00:00</d2p1:ClosedDate>
    <d2p1:CompanyID>1</d2p1:CompanyID>
    <d2p1:Details>
      <d2p1:DueDays>1</d2p1:DueDays>
      <d2p1:EMail>sample string 2</d2p1:EMail>
      <d2p1:IBAN>sample string 1</d2p1:IBAN>
      <d2p1:Phone>sample string 3</d2p1:Phone>
    </d2p1:Details>
    <d2p1:ID>2</d2p1:ID>
    <d2p1:InvoiceType>sample string 4</d2p1:InvoiceType>
    <d2p1:Lookup>2 - sample string 6</d2p1:Lookup>
    <d2p1:OrganizationTypeID>1</d2p1:OrganizationTypeID>
    <d2p1:Status>5</d2p1:Status>
  </Partner>
  <PartnerID>2</PartnerID>
  <Payed>2024-03-29T11:47:17.0274458+00:00</Payed>
  <PaymentDescription>sample string 7</PaymentDescription>
  <PaymentMethodID>1</PaymentMethodID>
  <PaymentMethodName>sample string 6</PaymentMethodName>
  <RRN>sample string 8</RRN>
  <SchemaID>1</SchemaID>
  <SchemaName>sample string 9</SchemaName>
  <Taxed>2024-03-29T11:47:17.0274458+00:00</Taxed>
  <TotalAmount>1</TotalAmount>
  <TotalExcludingVAT>1</TotalExcludingVAT>
  <TotalVAT>1</TotalVAT>
</Document>