Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be returned as a result. The allowed bill identifier fields are the following:

Include Page
V4:bill_identifier
V4:bill_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

number

(mandatory)

 Number

The number of bills to be retrieved, starting from the latest one

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Include Page
V4:bill_identifier
V4:bill_identifier

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token": "D0B5DB906B4C1B56FFEFCE634435A4D5",
    "bill_identifier":{"number":"10"},
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount_to_be_paid": 160.97,
        "bill_status": "SETTLED",
        "to_date": null,
        "from_date": null,
        "life_cycle_state": "PRESENTED",
        "total_billed_amount": 160.97,
        "number": "10",
        "id": "A3887F949F688206F424A5E3001E9153"
    }
}
Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token": "{{token}}",
    "bill_identifier":{"number":"172"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "number": "172",
    "from_date": "2016-07-04T14:11:56",
    "to_date": null,
    "currency": {
      "suffix_symbol": null,
      "prefix_symbol": "€",
      "decimal_part_name": null,
      "code": "EUR",
      "integer_part_name": null,
      "id": "2"
    },
    "id": "F4A9F227C9B74E07B519AF0AE96C5466",
    "life_cycle_state": "PRESENTED",
    "total_billed_amount": 260,
    "total_amount_to_be_paid": 467.42,
    "bill_status": "UNSETTLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST bill/present_and_confirm

...

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Include Page
V4:bill_identifier
V4:bill_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Include Page
V4:bill_identifier
V4:bill_identifier

...