API

Finance APIs

GET finance/accounts-payable-transactions/{accountsPayableTransactionId}

Accounts payable transaction details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/accounts-payable-transactions/{accountsPayableTransactionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {accountsPayableTransactionId} Accounts payable transaction identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 535, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<AccountsPayableTransaction>
2
     <AccountsPayableTransactionId
AccountsPayableTransactionId

Accounts payable transaction identifier


>{Integer}</AccountsPayableTransactionId>
3
     <Status
Status

Status of accounts payable transaction

Possible domain values can be found here

>{String}</Status>
4
     <TranslatedDescription
TranslatedDescription

Description of the accounts payable transaction.

>{String}</TranslatedDescription>
5
     <Type
Type

Type of account payable transaction

Possible domain values can be found here

>{String}</Type>
6
     <PaymentDeviationDescription
PaymentDeviationDescription

Payment deviation description of the accounts payable transaction

>{String}</PaymentDeviationDescription>
7
     <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
8
     <Source>
9
          <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>{String}</VATRegistrationNumber>
10
          <SellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

>{String}</SellersPaymentReference>
11
          <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
12
          <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
13
          <SuppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

>{String}</SuppliersInvoiceNumber>
14
          <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

>{String}</BuyersReferenceNumber>
15
          <AccountingPeriod>
16
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
17
               <Period
Period

Accounting period

>{Integer}</Period>
18
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
19
          </AccountingPeriod>
20
          <ShippingAddress>
21
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
22
               <Country
Country

English name of country.

>{String}</Country>
23
          </ShippingAddress>
24
          <InvoiceAddress>
25
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
26
               <Country
Country

English name of country.

>{String}</Country>
27
          </InvoiceAddress>
28
          <Supplier>
29
               <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
30
               <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
31
               <FirstName
FirstName

Firstname/givenname if the supplier is a person

>{String}</FirstName>
32
               <Intercompany>
33
                    <Code
Code

Intercompany database the supplier belongs to.

>{String}</Code>
34
               </Intercompany>
35
               <LegalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
36
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>{String}</VATRegistrationNumber>
37
               <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
38
          </Supplier>
39
          <SupplierBankAccount>
40
               <SupplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

>{Integer}</SupplierBankAccountId>
41
               <Name
Name

Name of bank account

>{String}</Name>
42
               <AccountNumber
AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>
43
               <Bank>
44
                    <SWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>
45
                    <InternationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</InternationalBankAccountNumber>
46
                    <Address
Address

Address of the bank associated with the bank account

>
47
                         <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
48
                    </Address>
49
               </Bank>
50
               <SupplierBankAccountLink
SupplierBankAccountLink

Supplier bank account reference

>{String}</SupplierBankAccountLink>
51
          </SupplierBankAccount>
52
          <Reference>
53
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
54
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
55
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
56
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
57
               <ItemType
ItemType

Type of item

>{String}</ItemType>
58
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
59
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
60
          </Reference>
61
     </Source>
62
     <Totals>
63
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
64
          <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
65
          <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
66
     </Totals>
67
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
68
          <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
69
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
70
          <VATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
71
          <TotalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
72
     </TotalsConverted>
73
</AccountsPayableTransaction>
1
{
2
     "accountsPayableTransaction": {
3
          "accountsPayableTransactionId
AccountsPayableTransactionId

Accounts payable transaction identifier


": "{Integer}",
4
          "status
Status

Status of accounts payable transaction

Possible domain values can be found here

": "{String}",
5
          "translatedDescription
TranslatedDescription

Description of the accounts payable transaction.

": "{String}",
6
          "type
Type

Type of account payable transaction

Possible domain values can be found here

": "{String}",
7
          "paymentDeviationDescription
PaymentDeviationDescription

Payment deviation description of the accounts payable transaction

": "{String}",
8
          "dueDate
DueDate

Date the object is due to be paid

": "{Date}",
9
          "source": {
10
               "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

": "{String}",
11
               "sellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

": "{String}",
12
               "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
13
               "registrationDate
RegistrationDate

Date of registration

": "{Date}",
14
               "suppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

": "{String}",
15
               "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

": "{String}",
16
               "accountingPeriod": {
17
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
18
                    "period
Period

Accounting period

": "{Integer}",
19
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
20
               },
21
               "shippingAddress": {
22
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
23
                    "country
Country

English name of country.

": "{String}"
24
               },
25
               "invoiceAddress": {
26
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
27
                    "country
Country

English name of country.

": "{String}"
28
               },
29
               "supplier": {
30
                    "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
31
                    "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
32
                    "firstName
FirstName

Firstname/givenname if the supplier is a person

": "{String}",
33
                    "intercompany": {
34
                         "code
Code

Intercompany database the supplier belongs to.

": "{String}"
35
                    },
36
                    "legalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

": "{String}",
37
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

": "{String}",
38
                    "supplierLink
SupplierLink

Supplier reference

": "{String}"
39
               },
40
               "supplierBankAccount": {
41
                    "supplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

": "{Integer}",
42
                    "name
Name

Name of bank account

": "{String}",
43
                    "accountNumber
AccountNumber

Account number used to identify the bank account

": "{String}",
44
                    "bank": {
45
                         "sWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

": "{String}",
46
                         "internationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",
47
                         "address
Address

Address of the bank associated with the bank account

": {
48
                              "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
49
                         }
50
                    },
51
                    "supplierBankAccountLink
SupplierBankAccountLink

Supplier bank account reference

": "{String}"
52
               },
53
               "reference": {
54
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
55
                    "objectType
ObjectType

Type of object

": "{String}",
56
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
57
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
58
                    "itemType
ItemType

Type of item

": "{String}",
59
                    "itemLink
ItemLink

API reference to the item

": "{String}",
60
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
61
               }
62
          },
63
          "totals": {
64
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
65
               "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
66
               "totalAmount
TotalAmount

Total amount

": "{Decimal}"
67
          },
68
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
69
               "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
70
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
71
               "vATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
72
               "totalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
73
          }
74
     }
75
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100209 HTTP 400 Illegal document Id {0}
Error 101086 HTTP 400 Missing required argument {0} for description
Error 101087 HTTP 400 Description argument/result mismatch